灵动岛管理接口_移动研发平台(EMAS)-阿里云帮助中心

本文档介绍灵动岛管理相关接口。包含启动令牌上报、推送令牌上报和活动状态同步。

启动令牌上报

为了使用阿里云推送远程启动一个实时活动，您需要在设备端先完成活动的启动令牌上报。您需要先从APNs获取您的启动令牌。

说明

上报到阿里云推送服务器的启动令牌最长可有效保存90天。

接口定义

+ (void)registerLiveActivityStartToken:(NSData *)startToken
                 forActivityAttributes:(NSString *)activityAttributes
                          withCallback:(CallbackHandler)callback;

参数说明

参数	类型	是否必选	说明
startToken	NSData	是	苹果APNs服务器返回的startToken。
activityAttributes	NSString	是	活动模板名称。
callback	Block	否	注册结果的回调函数。

推送令牌上报

当活动启动之后，每个活动都会分配一个后续用于推送更新状态的pushToken，你需要把该活动的ID和pushToken一起上报给阿里云推送服务器。

说明

上报到阿里云推送服务器的推送令牌最长可有效保存3天。由于活动最长时效为8个小时，所以令牌的实际有效期只有8小时。

接口定义

+ (void)registerLiveActivityPushToken:(NSData *)pushToken
                        forActivityId:(NSString *)activityId
                         withCallback:(CallbackHandler)callback;

参数说明

参数	类型	是否必选	说明
pushToken	NSData	是	苹果APNs服务器返回的pushToken。
activityId	NSString	是	活动ID。
callback	Block	否	注册结果的回调函数。

活动状态上报

当活动启动之后，每个活动都会有一个状态，将该状态上报给阿里云推送服务器，以获取更好的灵动岛推送体验。

接口定义

+ (void)syncLiveActivityState:(NSString *)state
                forActivityId:(NSString *)activityId
                 withCallback:(CallbackHandler)callback;

参数说明

参数	类型	是否必选	说明
state	NSString	是	活动状态：active \| ended \| dismissed \| stale
activityId	NSString	是	活动ID。
callback	Block	否	上报结果的回调函数。