iOS SDK 开发指南

本文介绍如何在游戏中接入 TapTap 内嵌动态功能，使用内嵌动态功能需依赖 TapTap 登录。

集成前准备

1. 参考 开发者中心配置 创建应用、配置包名与签名证书
2. 参考 iOS 集成指南 完成基础接入
3. 内嵌动态依赖于 TapTap 登录模块，开发者接入前应先完成 TapTap 登录的接入

权限说明

该模块需要如下权限：

权限	使用目的	权限申请时机
相册权限	获取相册中图片或保存网络图片到相册中	用户首次使用该功能时会申请权限
相机权限	用于拍照或录视频	用户首次使用该功能时会申请权限
麦克风权限	用于录视频时获取声音	用户首次使用该功能时会申请权限

开发者需在工程的 Info.plist 中添加如下权限说明，并替换授权文案：

<!--使用内嵌动态服务，需要相册、相机、麦克风权限-->
<key>NSPhotoLibraryUsageDescription</key>
<string>说明为何应用需要此项权限</string>
<key>NSCameraUsageDescription</key>
<string>说明为何应用需要此项权限</string>
<key>NSMicrophoneUsageDescription</key>
<string>说明为何应用需要此项权限</string>

SDK 获取

远程依赖

1. 在工程 Podfile 文件中对应模块下添加依赖：

 pod 'TapTapSDK/Moment', '~> 4.11.1'

2. 执行 Pod install 下载对应依赖文件

本地文件依赖

内嵌动态依赖于初始化和 TapTap 登录模块，使用本地文件方式添加依赖时，需先参考集成指南 和 TapTap 登录添加对应本地文件依赖项。

1. 在下载页下载如下文件：

• TapTapMomentSDK.xcframework 动态依赖库
• TapTapMomentResource.bundle 动态资源文件

2. 在工程中添加 framework 静态库，注意添加时选择 Embed 方式为 Do Not Embed，导入 bundle 资源文件

设置回调

设置回调以获取动态的状态变化。

Swift

import TapTapMomentSDK

// 实现 TapTapMomentDelegate 协议
extension GameMainScene:TapTapMomentDelegate{
    func onMomentCallback(withCode code: Int, msg: String) {
    	// 根据 code  处理动态事件
    }
}

// 注册回调
TapTapMoment.setDelegate(self)

Objective-C

#import "TapTapMomentSDK/TapTapMoment.h"

@interface GameMainController () <TapTapMomentDelegate>

@end
@implementation GameMainController

- (void)onMomentCallbackWithCode:(NSInteger)code msg:(nonnull NSString *)msg { 
    // 根据 code  处理动态事件
}

// 注册回调
- (void)registerMomentCallback {
    [TapTapMoment setDelegate:self];
}

回调方法中 code 表示事件类型，现支持的回调类型如下：

回调	回调值	说明
CALLBACK_CODE_PUBLISH_SUCCESS	10000	动态发布成功
CALLBACK_CODE_PUBLISH_FAIL	10100	动态发布失败
CALLBACK_CODE_PUBLISH_CANCEL	10200	关闭动态发布页面
CALLBACK_CODE_GET_NOTICE_SUCCESS	20000	获取新消息成功
CALLBACK_CODE_GET_NOTICE_FAIL	20100	获取新消息失败
CALLBACK_CODE_MOMENT_APPEAR	30000	动态页面打开
CALLBACK_CODE_MOMENT_DISAPPEAR	30100	动态页面关闭
CALLBACK_CODE_CLOSE_CANCEL	50000	取消关闭所有动态界面（弹框点击取消按钮）
CALLBACK_CODE_CLOSE_CONFIRM	50100	确认关闭所有动态界面（弹框点击确认按钮）
CALLBACK_CODE_LOGIN_SUCCESS	60000	动态页面内登录成功
CALLBACK_CODE_SCENE_EVENT	70000	场景化入口回调

获取新消息

定时调用获取消息通知的接口，有新信息时可以在 TapTap 动态入口显示小红点，提醒玩家查看新动态。

Swift

import TapTapMomentSDK

TapTapMoment.fetchNotification()

Objective-C

#import "TapTapMomentSDK/TapTapMoment.h"

[TapTapMoment fetchNotification];

获取消息通知的结果会在本文刚开始设置的回调中返回，code 为 CALLBACK_CODE_GET_NOTICE_SUCCESS（20000）表示获取成功，CALLBACK_CODE_GET_NOTICE_FAIL（20100）表示获取失败。 获取成功时，msg 为新消息数量，0 表示没有新消息。

tip

为了方便玩家查看好友动态、游戏公告等，我们建议将 TapTap 动态入口放在显眼的位置，每分钟调用 1 次获取消息通知的接口。

获取消息通知时，如果没有新消息（msg 为 0），那么游戏需要清除界面上的小红点。 同样，打开 TapTap 动态页面后，游戏也需要清除界面上的小红点。

显示动态页面

在游戏中显示 TapTap 动态页面，玩家可以查看及发布动态。

Swift

import TapTapMomentSDK

TapTapMoment.open()

Objective-C

#import "TapTapMomentSDK/TapTapMoment.h"

[TapTapMoment open];

note

打开动态页面时，请先屏蔽游戏自身的声音，以免干扰动态内的视频声音。

如需要动态能支持横竖屏随设备自动旋转，需要游戏自身能支持横竖屏。

如前所述，打开动态页面后别忘了清除动态页面入口处的小红点。

按以下步骤配置动态页面的背景图：

1. 在开发者中心进入 游戏服务 > 内嵌动态 > 主题配置。
2. 选择深色或浅色导航主题、设置顶栏色值，并上传背景图片。图片需为 JPG 或 PNG 格式；横版尺寸为 2436 × 1125 px，竖版尺寸为 1125 × 2436 px。
3. 点击 申请修改，提交审核。

背景图需要人工审核后才能生效，请预留充足的时间。

场景化入口

开发者可以结合游戏场景绘制入口，玩家打开入口跳转到指定的页面。使用前需要在开发者中心后台完成场景化入口配置。

Swift

import TapTapMomentSDK

// sceneId 为在开发者中心后台创建场景化入口后生成的「入口 ID」
TapTapMoment.openScene(sceneId)

Objective-C

#import "TapTapMomentSDK/TapTapMoment.h"

[TapTapMoment openScene:@"sceneId"];

场景化入口回调格式说明

SDK 回调结构

字段名	值类型	required	说明
sceneId	字符串	是	场景化入口 ID
eventType	字符串	是	枚举的事件类型，如 VIEW，FORWARD，VOTE 等
eventPayload	字符串	是	根据类型自定义的 JSON 字符串
timestamp	整数	是	unix 时间戳，ms

事件类型

eventType	eventPayload (未序列化)	说明
READY	{}	场景化页面已打开
REPOST	{}	转发，仅帖子本身
VOTE	{ isCancel: boolean }	点赞（含是否取消），仅帖子本身
FOLLOW	{ isCancel: boolean }	关注（含是否取消），仅帖子本身
COMMENT	{}	评论，仅帖子本身

关闭动态页面

玩家可以在动态页面主动退出，但在特定场景下，游戏可能需要主动关闭动态页面。

比如，玩家排位等待结束，准备进入对局时提示玩家关闭动态页面，玩家确认后关闭，此时调用如下接口：

Swift

import TapTapMomentSDK

TapTapMoment.close(withTitle: "标题", content: "匹配成功，是否离开动态？", showConfirm: true)

Objective-C

#import "TapTapMomentSDK/TapTapMoment.h"

[TapTapMoment closeWithTitle:@"标题" content:@"匹配成功，是否离开动态？" showConfirm:YES];

接口中第一个参数为确认弹窗中的标题，第二个参数为确认弹窗中的内容。

用户的选择会通过回调返回：

• CALLBACK_CODE_CLOSE_CANCEL（50000），表示玩家点了「取消」，选择不关闭动态页面。
• CALLBACK_CODE_CLOSE_CONFIRM（50100），表示玩家点了「确认」，选择关闭动态页面。

如果需要直接关闭动态窗口，不弹出二次确认框，调用如下接口：

Swift

import TapTapMomentSDK

TapTapMoment.close()

Objective-C

#import "TapTapMomentSDK/TapTapMoment.h"

[TapTapMoment close];

一键发布

info

这是可选功能，请根据项目需求决定是否在游戏中加入这一功能。

我们推荐游戏让玩家直接在动态页面发布新动态。 不过，SDK 也提供了发布图文动态的 API，以支持「一键发动态」等需求。 图文动态包括单张或多张图片及相应的文字内容。

Swift

import TapTapMomentSDK

// 初始化要发布的图文数据
let postData = TapTapMomentImageData()
// 设置发布的文字内容
postData.content = "动态文字内容"
// 设置发布的图片地址
let imagePath = "/var/mobile/**.png"
postData.images = [imagePath]
// 发布图文动态
TapTapMoment.publish(postData)

Objective-C

#import "TapTapMomentSDK/TapTapMoment.h"

// 初始化要发布的图文数据
TapTapMomentImageData *postData = [[TapTapMomentImageData alloc] init];
// 设置发布的文字内容
postData.content = @"动态文字内容";
// 设置发布的图片地址
NSString *imagePath = @"/var/mobile/**.png";
postData.images = @[imagePath];
// 发布图文动态
[TapTapMoment publish:postData];

info

玩家在动态页面可以发布图文动态和视频动态。 「一键发布」只支持发布图文动态。

国际化

内嵌动态支持设置语言：

Swift

TapTapSDK.update(TapLanguageType.auto)

Objective-C

[TapTapSDK updateLanguage: TapLanguageType_Auto];

支持如下语言：

typedef NS_ENUM (NSInteger, TapLanguageType) {
    TapLanguageType_Auto = 0,// 自动
    TapLanguageType_zh_Hans,// 简体中文
    TapLanguageType_en,// 英文
    TapLanguageType_zh_Hant,// 繁体中文
    TapLanguageType_ja,// 日文
    TapLanguageType_ko,// 韩文
    TapLanguageType_th,// 泰文
    TapLanguageType_id,// 印度尼西亚语
    TapLanguageType_de,// 德语
    TapLanguageType_es,// 西班牙语
    TapLanguageType_fr,// 法语
    TapLanguageType_pt,// 葡萄牙语
    TapLanguageType_ru,// 俄罗斯语
    TapLanguageType_tr,// 土耳其语
    TapLanguageType_vi,// 越南语
};

「自动」会尝试根据系统语言设置语言，如果系统语言不在上述支持的语言之中，那么会根据 SDK 初始化时配置的区域设置语言。 区域为中国大陆时会设置为简体中文，否则会设置为英文。