... | ... | @@ -57,13 +57,13 @@ |
|
|
##### HDSInteractionFunctionModel
|
|
|
|
|
|
| 参数 | 类型 | 注释 | 所在类文件 |
|
|
|
| --------- | ----------------------- | -------- | --------------------- |
|
|
|
| -------- | ---------------------- | ---------- | --------------------- |
|
|
|
| redModel | HDSInteractionRedModel | 红包雨配置 | CCSDK/PlayParameter.h |
|
|
|
|
|
|
###### HDSInteractionVoteModel
|
|
|
|
|
|
| 参数 | 注释 | 所在类文件 |
|
|
|
| ------------------ | ------------------------------------------- | --------------------- |
|
|
|
| ----------------- | --------------------------------------------- | --------------------- |
|
|
|
| redFunctionConfig | 红包雨功能配置 0:关闭 1:直播间配置 2:全局配置 | CCSDK/PlayParameter.h |
|
|
|
|
|
|
|
... | ... | @@ -95,7 +95,7 @@ |
|
|
#### 初始化红包雨组件SDK(主动方法)
|
|
|
|
|
|
| 方法 | 注释 | 所在类文件 |
|
|
|
| ------------------------------------- | -------------- | --------------------------- |
|
|
|
| ----------------------------------------------------- | ---------------- | ----------------------------------------- |
|
|
|
| (instancetype)initRedEnvelopeFuncWithConfig: closure: | 初始化红包雨功能 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
|
|
|
|
|
|
示例代码
|
... | ... | @@ -110,7 +110,7 @@ |
|
|
##### HDSRedEnvelopeFuncConfig
|
|
|
|
|
|
| 参数 | 类型 | 注释 | 所在类文件 |
|
|
|
| -------- | ------ | ------ | --------------------------------- |
|
|
|
| -------- | ------ | ------ | ------------------------------------------- |
|
|
|
| userId | String | 用户ID | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h |
|
|
|
| userName | String | 用户名 | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h |
|
|
|
| roomId | String | 房间ID | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h |
|
... | ... | @@ -118,10 +118,39 @@ |
|
|
|
|
|
|
|
|
|
|
|
#### 红包雨自定义样式 (4.7.0 新增)
|
|
|
|
|
|
| 方法 | 说明 |
|
|
|
| ------------------------------------------------------------ | -------------------------- |
|
|
|
| (void)onRedEnvelopeCustomStyle:(HDSRedEnvelopeStyleModel *)model | 接收到红包雨自定义样式消息 |
|
|
|
|
|
|
示例代码
|
|
|
|
|
|
```objc
|
|
|
/// 接收到红包雨自定义样式消息
|
|
|
/// @param model 红包雨自定义样式
|
|
|
- (void)onRedEnvelopeCustomStyle:(HDSRedEnvelopeStyleModel *)model;
|
|
|
```
|
|
|
|
|
|
##### HDSRedEnvelopeStyleModel
|
|
|
|
|
|
| 参数 | 类型 | 注释 | 所在类文件 |
|
|
|
| ----------------- | ------ | ---------- | ------------------------------------------- |
|
|
|
| succed | Bool | 是否成功 | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h |
|
|
|
| message | String | 请求信息 | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h |
|
|
|
| rankBackgroundUrl | String | 背景图URL | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h |
|
|
|
| driftDownUrls | Array | 红包封面图 | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### 抢红包(主动方法)
|
|
|
|
|
|
| 方法 | 注释 | 所在类文件 |
|
|
|
| --------------------------------------------- | ------------ | --------------------------- |
|
|
|
| ---------------------- | ------ | ----------------------------------------- |
|
|
|
| (void)robRed: closure: | 抢红包 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
|
|
|
|
|
|
示例代码
|
... | ... | @@ -140,7 +169,7 @@ |
|
|
#### 获取中奖排行榜(主动方法)
|
|
|
|
|
|
| 方法 | 注释 | 所在类文件 |
|
|
|
| --------------------------------------- | ------------ | --------------------------- |
|
|
|
| ----------------------------------------- | -------------- | ----------------------------------------- |
|
|
|
| (void)getRankList: closure: infoCallBack: | 获取中奖排行榜 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
|
|
|
|
|
|
示例代码
|
... | ... | @@ -154,9 +183,11 @@ |
|
|
```
|
|
|
|
|
|
### ---------------- 获取红包详情 ----------------
|
|
|
|
|
|
#### 获取红包详情(主动方法)
|
|
|
|
|
|
| 方法 | 注释 | 所在类文件 |
|
|
|
| ----------------------------- | ------------ | --------------------------- |
|
|
|
| ------------------------------------------- | ------------ | ----------------------------------------- |
|
|
|
| (void) getRedDetail: closure: infoCallBack: | 获取红包详情 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
|
|
|
|
|
|
示例代码
|
... | ... | @@ -177,7 +208,7 @@ |
|
|
#### 获取用户中奖列表(主动方法)
|
|
|
|
|
|
| 方法 | 注释 | 所在类文件 |
|
|
|
| ----------------------------- | ------------ | --------------------------- |
|
|
|
| ----------------------------------- | ---------------- | ----------------------------------------- |
|
|
|
| (void) getUserRecord: infoCallBack: | 获取用户中奖列表 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
|
|
|
|
|
|
示例代码
|
... | ... | @@ -190,9 +221,11 @@ |
|
|
```
|
|
|
|
|
|
### ---------------- 重载红包雨功能 ----------------
|
|
|
|
|
|
#### 重载红包雨功能(被动方法)
|
|
|
|
|
|
| 方法 | 注释 | 所在类文件 |
|
|
|
| ----------------------------- | ------------ | --------------------------- |
|
|
|
| ---------------------------------------- | -------------- | ----------------------------------------- |
|
|
|
| (void) reloadRedEnvelopeFuncWithClosure: | 重载红包雨功能 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
|
|
|
|
|
|
示例代码
|
... | ... | @@ -204,10 +237,11 @@ |
|
|
```
|
|
|
|
|
|
### ---------------- 接收红包雨事件 ----------------
|
|
|
|
|
|
#### 接收红包雨事件(被动方法)
|
|
|
|
|
|
| 方法 | 注释 | 所在类文件 |
|
|
|
| ----------------------------- | ------------ | --------------------------- |
|
|
|
| ------------------------------------ | -------------- | ----------------------------------------- |
|
|
|
| (void)onRedEnvelopeEventWithMessage: | 发送红包雨事件 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
|
|
|
|
|
|
示例代码
|
... | ... | @@ -226,7 +260,7 @@ |
|
|
#### 销毁红包雨组件(主动方法)
|
|
|
|
|
|
| 方法 | 注释 | 所在类文件 |
|
|
|
| ------------- | ------------ | --------------------------- |
|
|
|
| ------------- | -------------- | ----------------------------------------- |
|
|
|
| (void)killAll | 销毁红包雨组件 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
|
|
|
|
|
|
示例代码
|
... | ... | |