iOS-云直播邀请卡功能接入文档.md

+## 云直播邀请卡功能接入文档
+
+[TOC]
+
+
+
+### 结构图
+
+![iOS-结构图](image/iOS-结构图.png)
+
+### 时序图
+
+![邀请卡功能时序图](image/邀请卡功能时序图.png)
+
+### 接入方式
+
+#### 本地集成
+
+| 新增依赖库（动态库）           | 接入方式                                              | 签名选择     |
+| ------------------------------ | ----------------------------------------------------- | ------------ |
+| HDSInvitationCardModule.framework        | 下载zip包中 HDSInvitationCardModule 文件夹下，拖入项目中        | Embed & Sign |
+| HDSInteractionEngine.framework | 下载zip包中 HDSInteractionEngine 文件夹下，拖入项目中 | Embed & Sign |
+
+
+
+#### cocoapods 集成
+
+| 新增依赖库（动态库）           | 接入方式                                         | 是否必须 |
+| ------------------------------ | ------------------------------------------------ | -------- |
+| HDSInvitationCardModule.framework        | 在Podfile文件中添加:  Pod 'HDSInvitationCardModule'        | 是       |
+| HDSInteractionEngine.framework | 在Podfile文件中添加:  Pod 'HDSInteractionEngine' | 是       |
+
+
+
+### 新增 API 
+
+
+
+### ----------------   前置条件   ----------------
+
+
+
+#### 房间互动功能配置信息（代理方法）
+
+| 方法                               | 注释         | 所在类文件          |
+| ---------------------------------- | ------------ | ------------------- |
+| (void)onInteractionFunctionConfig: | 互动功能配置 | CCSDK/RequestData.h |
+
+示例代码
+
+```objc
+/// 互动功能配置
+/// @param configModel 配置信息
+- (void)onInteractionFunctionConfig:(HDSInteractionFunctionModel *)configModel;
+```
+
+##### HDSInteractionFunctionModel
+
+| 参数      | 类型                    | 注释     | 所在类文件            |
+| --------- | ----------------------- | -------- | --------------------- |
+| cardModel | HDSInteractionCardModel | 邀请卡配置 | CCSDK/PlayParameter.h |
+
+###### HDSInteractionCardModel
+
+| 参数               | 注释                                        | 所在类文件            |
+| ------------------ | ------------------------------------------- | --------------------- |
+| cardFunctionConfig | 邀请卡功能配置  0:关闭 1:直播间配置 2:全局配置 | CCSDK/PlayParameter.h |
+
+
+
+#### 获取互动组件Token（主动方法）
+
+| 方法                                                | 注释               | 所在类文件          |
+| --------------------------------------------------- | ------------------ | ------------------- |
+| (void)getInteractionTokenWithClosure: tokenClosure: | 获取互动组件 token | CCSDK/RequestData.h |
+
+示例代码
+
+```objc
+/// 获取互动组件 token
+/// @param closure 操作回调 (result 操作状态， message 信息)
+/// @param tokenClosure token回调  " result == YES 时返回token, result == NO 时返回 @""(空字符串) "
+- (void)getInteractionTokenWithClosure:(completeHandler)closure 
+  												tokenClosure:(interactionTokenClosure)tokenClosure;
+```
+
+
+
+
+
+### ----------------  初始化邀请卡组件   ----------------
+
+
+
+#### 初始化邀请卡组件SDK（主动方法）
+
+| 方法                                  | 注释           | 所在类文件                  |
+| ------------------------------------- | -------------- | --------------------------- |
+| (instancetype)initCardFuncWithConfig: closure: | 初始化邀请卡功能 | HDSInvitationCardModule/HDSInvitationCardFunc.h |
+
+示例代码
+
+```objc
+/// 初始化邀请卡功能
+/// @param config 配置项
+/// @param closure 操作回调
+- (instancetype)initCardFuncWithConfig:(HDSInvitationCardConfig *)config closure:(completeHandler)closure NS_DESIGNATED_INITIALIZER;
+```
+
+##### HDSInvitationCardConfig
+
+| 参数     | 类型   | 注释   | 所在类文件                        |
+| -------- | ------ | ------ | --------------------------------- |
+| userId   | String | 用户ID | HDSInvitationCardModule/HDSInvitationCardFunc.h |
+| userName | String | 用户名 | HDSInvitationCardModule/HDSInvitationCardFunc.h |
+| roomId   | String | 房间ID | HDSInvitationCardModule/HDSInvitationCardFunc.h |
+| token    | String | token  | HDSInvitationCardModule/HDSInvitationCardFunc.h |
+
+
+
+#### 获取邀请卡配置开关（主动方法）
+
+| 方法                                          | 注释         | 所在类文件                  |
+| --------------------------------------------- | ------------ | --------------------------- |
+| (void)getInvitationConfig: dataCallBack: | 获取邀请卡配置开关 | HDSInvitationCardModule/HDSInvitationCardFunc.h |
+
+示例代码
+
+```objc
+/// 获取邀请卡配置开关
+/// @param closure 操作回调
+/// @param dataCallBack 数据回调
+- (void)getInvitationConfig:(completeHandler)closure dataCallBack:(HDSCardConfigCompleteHandler)dataCallBack;
+```
+
+### ----------------   获取分享短连接   ----------------
+
+
+
+#### 获取分享短连接（主动方法）
+
+| 方法                                    | 注释         | 所在类文件                  |
+| --------------------------------------- | ------------ | --------------------------- |
+| (void)getShortUrl: closure: | 获取分享短连接 | HDSInvitationCardModule/HDSInvitationCardFunc.h |
+
+示例代码
+
+```objc
+/// 获取分享短连接
+/// @param originUrl 原始链接
+/// @param closure 回调函数
+- (void)getShortUrl:(NSString *)originUrl closure:(completeHandler)closure;
+```
+
+### ----------------   重载邀请卡事件   ----------------
+#### 重载邀请卡事件（主动方法）
+| 方法                          | 注释         | 所在类文件                  |
+| ----------------------------- | ------------ | --------------------------- |
+| (void)reloadCardFuncWithClosure: | 重载邀请卡事件 | HDSInvitationCardModule/HDSInvitationCardFunc.h |
+
+示例代码
+
+```objc
+/// 重载邀请卡功能
+/// @param closure 操作回调
+- (void)reloadCardFuncWithClosure:(completeHandler)closure;
+```
+
+
+### ----------------   获取邀请卡列表   ----------------
+
+
+
+#### 获取邀请卡列表（主动方法）
+
+| 方法                          | 注释         | 所在类文件                  |
+| ----------------------------- | ------------ | --------------------------- |
+| (void) getInvitaionCardList: dataCallBack: | 获取邀请卡列表 | HDSInvitationCardModule/HDSInvitationCardFunc.h |
+
+示例代码
+
+```objc
+/// 获取邀请卡列表
+/// @param closure 回调函数
+/// @param dataCallBack 回调函数
+- (void)getInvitaionCardList:(completeHandler)closure dataCallBack:(HDSCardCompleteHandler)dataCallBack;
+```
+
+
+### ----------------  销毁邀请卡组件   ----------------
+
+
+
+#### 销毁邀请卡组件（主动方法）
+
+| 方法          | 注释         | 所在类文件                  |
+| ------------- | ------------ | --------------------------- |
+| (void)killAll | 销毁邀请卡组件 | HDSInvitationCardModule/HDSInvitationCardFunc.h |
+
+示例代码
+
+```objc
+/// 销毁
+- (void)killAll;
+```
+