GitLab

云直播点赞功能接入文档

[TOC]

结构图

时序图

接入方式

本地集成

新增依赖库（动态库）	接入方式	签名选择
HDSLikeModule.framework	下载zip包中 HDSLikeModule 文件夹下，拖入项目中	Embed & Sign
HDSInteractionEngine.framework	下载zip包中 HDSInteractionEngine 文件夹下，拖入项目中	Embed & Sign

cocoapods 集成

新增依赖库（动态库）	接入方式	是否必须
HDSLikeModule.framework	在Podfile文件中添加: Pod 'HDSLikeModule'	是
HDSInteractionEngine.framework	在Podfile文件中添加: Pod 'HDSInteractionEngine'	是

新增 API

---------------- 前置条件 ----------------

房间互动功能配置信息（代理方法）

方法	注释	所在类文件
(void)onInteractionFunctionConfig:	互动功能配置	CCSDK/RequestData.h

示例代码

/// 互动功能配置
/// @param configModel 配置信息
- (void)onInteractionFunctionConfig:(HDSInteractionFunctionModel *)configModel;

HDSInteractionFunctionModel

参数	类型	注释	所在类文件
likeModel	HDSInteractionLikeModel	点赞配置	CCSDK/PlayParameter.h

HDSInteractionLikeModel

参数	注释	所在类文件
likeFunctionConfig	点赞功能配置 0:关闭 1:直播间配置 2:全局配置	CCSDK/PlayParameter.h

获取互动组件Token（主动方法）

方法	注释	所在类文件
(void)getInteractionTokenWithClosure: tokenClosure:	获取互动组件 token	CCSDK/RequestData.h

示例代码

/// 获取互动组件 token
/// @param closure 操作回调 (result 操作状态， message 信息)
/// @param tokenClosure token回调  " result == YES 时返回token, result == NO 时返回 @""(空字符串) "
- (void)getInteractionTokenWithClosure:(completeHandler)closure 
  												tokenClosure:(interactionTokenClosure)tokenClosure;

---------------- 初始化点赞组件 ----------------

初始化点赞组件SDK（主动方法）

方法	注释	所在类文件
(instancetype)initLikeFuncWithConfig:	初始化点赞功能	HDSLikeModule/HDSLikeFunc.h

示例代码

/// 初始化点赞功能
/// @param config 配置项
/// @param closure 操作回调
- (instancetype)initLikeFuncWithConfig:(HDSLikeFuncConfig *)config
   													   closure:(completeHandler)closure;

HDSLikeFuncConfig

参数	类型	注释	所在类文件
userId	String	用户ID	HDSLikeModule/HDSLikeFuncConfig.h
userName	String	用户名	HDSLikeModule/HDSLikeFuncConfig.h
roomId	String	房间ID	HDSLikeModule/HDSLikeFuncConfig.h
token	String	token	HDSLikeModule/HDSLikeFuncConfig.h

获取点赞信息（主动方法）

方法	注释	所在类文件
(void)getLikeInformationClosure: information:	获取点赞信息	HDSLikeModule/HDSLikeFunc.h

示例代码

/// 获取点赞信息 （最小时间间隔大于 2000 ms）
/// @param closure 操作回调
/// @param infoCallBack 点赞信息回调
- (void)getLikeInformationClosure:(completeHandler)closure 
  									  information:(likeInfoClosure)infoCallBack;

HDSLikeFuncInformationModel

参数	类型	注释	所在类文件
basicTimes	integer	基础倍数	HDSLikeModule/HDSLikeFuncConfig.h
userName	integer	当前点赞总数	HDSLikeModule/HDSLikeFuncConfig.h

---------------- 发送点赞 ----------------

发送点赞（主动方法）

方法	注释	所在类文件
(void)sendLikeActionWithCount: closure:	发送点赞事件	HDSLikeModule/HDSLikeFunc.h

示例代码

/// 发送点赞事件 （最小时间间隔大于 2000 ms）
/// @param count 点赞次数
/// @param closure 操作回调
- (void)sendLikeActionWithCount:(NSInteger)count closure:(completeHandler)closure;

---------------- 收到点赞 ----------------

收到点赞（代理方法）

方法	注释	所在类文件
(void)onLikeEventWithMessage:	接收点赞消息	HDSLikeModule/HDSLikeFunc.h

示例代码

/// 接收点赞消息
/// @param message 消息
- (void)onLikeEventWithMessage:(HDSReceiveLikeInformationModel *)message;

HDSReceiveLikeInformationModel

参数	类型	注释	所在类文件
currentNumbers	integer	当前点赞总数	HDSLikeModule/HDSLikeFuncConfig.h

---------------- 销毁点赞组件 ----------------

销毁点赞组件（主动方法）

方法	注释	所在类文件
(void)killAll	销毁点赞组件	HDSLikeModule/HDSLikeFunc.h

示例代码

/// 销毁
- (void)killAll;