动态社区

caution

unity版本xdsdk 3.x才开始包含动态功能, 此动态SDK已经包含在 TAPSDK_UPM.git 里面，需要删除以前单独引入的Moment SDK

1. 介绍

内嵌动态基于TapTap 内容社区的功能和游戏本身的账号系统的更多融合，成功接入内嵌动态SDK后玩家即可通过游戏直接访问TapTap内容和自带功能。同时内嵌动态SDK也为游戏打造个性化内容或服务提供了开放功能。

2. 设置回调

调用 enableMoment 后，需要设置动态回调，用于获取动态的状态变化

API

Android

TapTapMomentSdk.setCallback(TapTapMomentSdk.TapMomentCallback var0);

iOS

- (void)onMomentCallbackWithCode:(NSInteger)code msg:(NSString *)msg;

unity

public static void SetCallback(Action<int, string> callback);

示例代码

Android

TapTapMomentSdk.setCallback(new TapTapMomentSdk.TapMomentCallback() {

@Override

public void onCallback(int code, String msg) {

}

});

iOS

@interface ViewController () <TDSMomentDelegate>

@end

- (void)onMomentCallbackWithCode:(NSInteger)code msg:(NSString *)msg {

NSLog (@"msg:%@, code:%i" ,msg, code);

}

[TDSMomentSdk setDelegate:self];

unity

TapSDK.TDSMoment.SetCallback((code,msg)=>{

Debug.Log(code+"---"+msg);

});

回调方法中 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_INIT_SUCCESS	40000	动态初始化成功
CALLBACK_CODE_INIT_FAIL	40100	动态初始化失败
CALLBACK_CODE_ClOSE_CANCEL	50000	弹出关闭动态弹窗时，用户取消
CALLBACK_CODE_ClOSE_CONFIRM	50100	弹出关闭动态弹窗时，用户确认

3. 打开动态页面

在游戏中，显示游戏动态页面。

打开动态页面时，请先屏蔽游戏自身的声音，避免与动态内视频声音产生重合

如需要动态能支持横竖屏随设备自动旋转，需要游戏app自身能支持横竖屏(Xcode配置Device Orientation)

caution

截止到此步骤，2、3步为必要步骤

API

Android

TapTapMomentSdk.openTapMoment(TapTapMomentSdk.Config);

iOS

+ (void)openTapMomentWithConfig:(TDSMomentConfig *) config;

unity

public static void OpenMoment(Orientation config);

示例代码

Android

TapTapMomentSdk.Config config = new TapTapMomentSdk.Config();

// config用来设置页面显示配置，包括显示方向等

//config.orientation = TapTapMomentSdk.ORIENTATION_LANDSCAPE;

TapTapMomentSdk.openTapMoment(config);

iOS

TDSMomentConfig *mconfig = [[TDSMomentConfig alloc]init];

mconfig.orientation = TDSMomentOrientationDefault;

[TDSMomentSdk openTapMomentWithConfig:mconfig];

unity

TapSDK.TDSMoment.OpenMoment(TapSDK.Orientation.ORIENTATION_LANDSCAPE);

4. 发布动态

普通动态包括图片和对应的内容描述

API

Android

TapTapMomentSdk.publishMoment(TapTapMomentSdk.Config config, String imgPaths, String content);

iOS

+ (void)openPostMomentPageWithContent:(TDSPostMomentData * _Nonnull)content

config:(TDSMomentConfig * _Nonnull)config;

unity

public static void PublishMoment(Orientation config, string[] imagePaths, string content);

示例代码

Android

TapTapMomentSdk.Config config = new TapTapMomentSdk.Config();

config.orientation = TapTapMomentSdk.ORIENTATION_DEFAULT;

String content = "普通动态描述";

String[] images = new String[] { "content://***.jpg","/sdcard/**.jpg" };

TapTapMomentSdk.publishMoment(config, imagePaths, content);

iOS

TDSImageMomentData *imageMoment = [[TDSImageMomentData alloc] init];

imageMoment.images = @[@"file://..."];

imageMoment.content = @"我是发图片动态的内容";

TDSMomentConfig *config = [[TDSMomentConfig alloc] init];

config.orientation = TDSMomentOrientationDefault;

[TDSMomentSdk openPostMomentPageWithContent:imageMoment config:config];

unity

string content = "我是描述";

string[] images = {"imgpath01","imgpath02","imgpath03"};

TapSDK.TDSMoment.PublishMoment(TapSDK.Orientation.ORIENTATION_LANDSCAPE, images, content);

5. 获取用户新通知数量

当游戏需要获取当前用户的新的通知信息数量时，调用该接口

API

Android

TapTapMomentSdk.getNoticeData();

返回结果会通过动态回调通知游戏。
code == CALLBACK_CODE_GET_NOTICE_SUCCESS(20000)表示获取成功，msg 为0表示无新消息，为1表示有新消息。
CALLBACK_CODE_GET_NOTICE_FAIL(20100)表示获取失败

iOS

+ (void)fetchNewMessage;

结果在 Delegate 下的 onMomentCallbackWithCode:msg:中返回。
code == CALLBACK_CODE_GET_NOTICE_SUCCESS(20000)表示获取成功，msg 为0表示无新消息，为1表示有新消息。
CALLBACK_CODE_GET_NOTICE_FAIL(20100)表示获取失败

unity

public static void GetNoticeData();

结果在TapSDK.TDSMoment.SetCallback进行回调

6. 关闭动态页面

当游戏在特定场景下需要主动关闭动态窗口时调用

直接关闭

该接口会直接关闭动态窗口，不会弹出二次确认弹窗，接口示例：

Android

TapTapMomentSdk.closeMoment();

iOS

[TDSMomentSdk closeMoment];

unity

TapSDK.TDSMoment.CloseMoment();

弹出二次确认

该接口会弹出二次确认弹窗，由用户确定是否关闭，示例如下：

Android

TapTapMomentSdk.closeMoment(title, content)

参数说明

字段	可为空	说明
title	否	动态标题
content	否	动态描述

参数为二次弹窗的标题和内容，默认为"提示"和"匹配成功，进入游戏",用户选择接口会通过回调 CALLBACK_CODE_ClOSE_CANCEL(50000) 和CALLBACK_CODE_ClOSE_CONFIRM(50100)通知游戏

iOS

[TDSMomentSdk closeMomentWithTitle:@"title" content:@"content" showConfirm:true];

参数说明

字段	可为空	说明
title	否	动态标题
content	否	动态描述
showConfirm	否	是否显示确认弹窗

unity

TapSDK.TDSMoment.CloseMoment(title, desc);

参数说明

字段	可为空	说明
title	否	动态标题
desc	否	动态描述

7. 注意事项

• 打开动态页面时，请先屏蔽游戏自身的声音，避免与动态内视频声音产生重合
• 如需要动态能支持横竖屏随设备自动旋转，需要游戏app自身能支持横竖屏(Xcode配置Device Orientation)
• 小红点建议请求频率1次/1分钟
• 动态内的背景图是可配置的，具体配置位置点击查看，且需要等待审核，请提前配置