内嵌动态开发指南

本文介绍如何在游戏中加入 TapTap 内嵌动态。使用内嵌动态功能需依赖 TapTap 登录，需要导入TapMoment 模块。

SDK 获取

信息

• 如果使用 单纯的 TapTap 登录 并接入内嵌动态，初始化和 SDK 获取请参考：单纯的内嵌动态初始化。

假设你已经在 快速开始 部分完成了 SDK 初始化，可以通过 下载 获得 TapSDK，添加 TapMoment 模块：

Unity

"dependencies":{
  ...
  // 内嵌动态
  "com.taptap.tds.moment":"https://github.com/TapTap/TapMoment-Unity.git#3.18.2",
}

Android

repositories{  
    flatDir {  
        dirs 'libs'  
    }  
}  
dependencies {  
    ... 
    implementation (name:'TapMoment_3.18.2', ext:'aar') // TapTap 内嵌动态
}

iOS

// 内嵌动态
TapMomentResource.bundle
TapMomentSDK.framework

设置回调

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

Unity

TapMoment.SetCallback((code, msg) => {
  Debug.Log(code + "---" + msg);
});

Android

TapMoment.setCallback(new TapMoment.TapMomentCallback() {
    @Override
    public void onCallback(int code, String msg) {

    }
});

iOS

@interface ViewController ()<TapMomentDelegate>
@end

[TapMoment setDelegate:self];
- (void)onMomentCallbackWithCode:(NSInteger)code msg:(NSString *)msg
{
  NSLog (@"msg:%@, code:%i", msg, code);
}

回调方法中 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 动态入口显示小红点，提醒玩家查看新动态。

Unity

TapMoment.FetchNotification();

Android

TapMoment.fetchNotification();

iOS

[TapMoment fetchNotification];

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

提示

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

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

显示动态页面

在游戏中显示 TapTap 动态页面，在这个页面，玩家不仅可以查看动态，还能发布新动态。

Unity

TapMoment.Open(Orientation.ORIENTATION_LANDSCAPE);

Android

TapMoment.open(TapMoment.ORIENTATION_PORTRAIT);

iOS

TapMomentConfig *mConfig = TapMomentConfig.new;
mConfig.orientation = TapMomentOrientationDefault;
[TapMoment open:mConfig];

备注

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

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

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

动态页面的背景图可以配置，步骤如下图所示。 背景图需要人工审核后才能生效，请预留充足的时间。

场景化入口

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

Unity

var sceneDic = new Dictionary<string, object>() { { TapMomentConstants.TapMomentPageShortCutKey, sceneId } };
// sceneId 为开发者中心后台创建场景化入口后生成的「入口 ID」
TapMoment.DirectlyOpen(Orientation.ORIENTATION_DEFAULT, TapMomentConstants.TapMomentPageShortCut, sceneDic);

参数说明

参数	说明
orientation	打开方向
page	固定为 TapMomentConstants.TapMomentPageShortCut
Dictionary	其中 TapMomentConstants.TapMomentPageShortCutKey 固定，第三个参数为需要跳转的页面 id

Android

Map<String, String> extras = new HashMap<>();
// 注意：这里的 key 是固定的，"scene_id"；第二个参数是开发者中心后台创建场景化入口后生成的「入口 ID」
extras.put("scene_id", "xxxx");
// 注意：第二个参数固定为 "tap://moment/scene/"
TapMoment.directlyOpen(TapMoment.ORIENTATION_DEFAULT,"tap://moment/scene/", extras);

参数说明

参数	说明
orientation	打开方向
page	固定为 tap://moment/scene/
HashMap	集合中的 Key 固定为 scene_id 表示需要跳转的页面 id

iOS

TapMomentConfig *mConfig = TapMomentConfig.new;
mConfig.orientation = TapMomentOrientationDefault;
[TapMoment directlyOpen:mConfig page:TapMomentPageShortcut extras:@{ TapMomentPageShortcutKey: @"sceneid" }];

参数说明

参数	说明
orientation	打开方向
page	固定为 TapMomentPageShortcut
Dictionary	TapMomentPageShortcutKey 为固定写法，表示需要跳转的页面 id

场景化入口回调格式说明

SDK 回调结构

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

事件类型

eventType	eventPayload (未序列化)	说明
READY	{}	已成功落地，将在 dom 挂载时触发（获取数据之前）
REPOST	{}	转发
VOTE	{ isCancel: boolean }	点赞（含是否取消），仅帖子本身
FOLLOW	{ isCancel: boolean }	关注（含是否取消），仅帖子本身
COMMENT	{}	评论，仅帖子本身

关闭动态页面

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

比如，玩家排位等待结束，准备进入对局时提示玩家关闭动态页面，玩家确认后关闭。

Unity

TapMoment.Close("提示", "匹配成功，进入游戏");

Android

TapMoment.closeWithConfirmWindow("提示", "匹配成功，进入游戏");

iOS

[TapMoment closeWithTitle:@"提示" content:@"匹配成功，进入游戏" showConfirm:YES];

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

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

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

Unity

TapMoment.Close();

Android

TapMoment.close();

iOS

[TapMoment close];

一键发布

信息

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

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

Unity

string content = "我是描述";
string[] images = {"imgpath01","imgpath02","imgpath03"};
TapMoment.Publish(Orientation.ORIENTATION_LANDSCAPE, images, content);

Android

int orientation = TapMoment.ORIENTATION_PORTRAIT;
String content = "描述";
String[] imagePaths = new String[]{"content://hello.jpg", "/sdcard/world.jpg"};
TapMoment.publish(orientation, imagePaths, content);

iOS

TapMomentConfig * tconfig = TapMomentConfig.new;
tconfig.orientation = TapMomentOrientationDefault;

TapMomentImageData *postData = TapMomentImageData.new;
postData.images = @[@"file://..."];
postData.content = @"我是图片描述";
[TapMoment publish:tconfig content:(postData)];

信息

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

国际化

内嵌动态支持设置语言：

Unity

TapCommon.SetLanguage(TapLanguage.AUTO);

支持如下语言：

namespace TapTap.Common
{
    public enum TapLanguage
    {
        AUTO = 0, // 自动
        ZH_HANS = 1, // 简体中文
        EN = 2, // 英文
        ZH_HANT = 3, // 繁体中文
        JA = 4, // 日文
        KO = 5, // 韩文
        TH = 6, // 泰文
        ID = 7, // 印尼语
    }
}

Android

int auto = 0;
TapBootstrap.setPreferredLanguage(auto);

支持如下语言：

0 Auto
1 简体中文
2 英文
3 繁体中文
4 日文
5 韩文
6 泰文
7 印尼语

iOS

[TapBootstrap setPreferredLanguage: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, // 印度尼西亚语
};

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

单纯的内嵌动态初始化

这里 SDK 获取及初始化，仅供使用 单纯的 TapTap 登录 的开发者参考。

1. 请先 下载 TapSDK，并添加相关依赖。内嵌动态功能依赖 TapLogin、TapCommon 和 TapMoment 模块。

TapSDK Unity v3.7.1 及更高版本还需要添加 com.leancloud.storage 模块。Android SDK 及 iOS SDK 不需要额外增加依赖。

Unity

"dependencies":{
  "com.taptap.tds.login":"https://github.com/TapTap/TapLogin-Unity.git#3.18.2",
  "com.taptap.tds.common":"https://github.com/TapTap/TapCommon-Unity.git#3.18.2",
  "com.taptap.tds.moment":"https://github.com/TapTap/TapMoment-Unity.git#3.18.2",
  "com.leancloud.storage": "https://github.com/leancloud/csharp-sdk-upm.git#storage-1.0.2",
}

Android

repositories{  
    flatDir {  
        dirs 'libs'  
    }  
}  
dependencies {  
    ...
    implementation (name:'TapCommon_3.18.2', ext:'aar') // 必选：TapSDK 基础库 
    implementation (name:'TapLogin_3.18.2', ext:'aar') // 必选：TapTap 登录  
    implementation (name:'TapMoment_3.18.2', ext:'aar') // TapTap 内嵌动态
}

iOS

// 基础库
TapCommonSDK.framework
TapLoginSDK.framework
// 内嵌动态
TapMomentResource.bundle
TapMomentSDK.framework

2. 请确认完成了 单纯 TapTap 登录的初始化。

3. 完成内嵌动态功能的初始化，示例如下：

Unity

// 适用于中国大陆
TapMoment.Init(string clientID);

// 适用于其他国家或地区  isCN 为 true 表示中国大陆，false 表示其他国家或地区
TapMoment.Init(string clientID, boolean isCN);

参数说明

参数	描述
clientID	TapTap 开发者中心对应游戏的 Client ID。

Android

// 适用于中国大陆
TapMoment.init(Context context, String clientID);

// 适用于其他国家或地区  isCN 为 true 表示中国大陆，false 表示其他国家或地区
TapMoment.init(Context context, String clientID, boolean isCN);

参数说明

参数	描述
context	上下文，一般是当前 Application。
clientID	TapTap 开发者中心对应游戏的 Client ID。

iOS

// 适用于中国大陆
[TapMoment initWithClientID:@"your clientId"];

// 适用于其他国家或地区  isCN 为 true 表示中国大陆，false 表示其他国家或地区
[TapMoment initWithClientID:@"your clientId" isCN:isCN];

参数说明

参数	描述
clientId	TapTap 开发者中心对应应用的 Client ID

4. 使用本篇文档中提到的其他接口。