IMP(低代码音视频工厂)SDK v1.5.0
IMP SDK API Reference Manual for iOS Platforms
<AIRBChatProtocol> Protocol Reference
Inheritance diagram for <AIRBChatProtocol>:

Instance Methods

(void) - getCurrentChatInfoOnSuccess:onFailure:
 
(void) - sendComment:onSuccess:onFailure:
 
(void) - sendComment:extension:onSuccess:onFailure:
 
(void) - sendLike
 
(void) - queryCommentsWithSortedType:pageNum:pageSize:onSuccess:onFailure:
 
(void) - banCommentWithUserID:banTimeInSeconds:onSuccess:onFailure:
 
(void) - cancelBanCommentWithUserID:onSuccess:onFailure:
 
(void) - banAllComment:onSuccess:onFailure:
 
(void) - sendCustomMessage:toUsers:onSuccess:onFailure:
 
(void) - sendCustomMessageToALL:onSuccess:onFailure:
 

Method Documentation

◆ banAllComment:onSuccess:onFailure:

- (void) banAllComment: (BOOL)  ban
onSuccess: (void(^)(void))  onSuccess
onFailure: (void(^)(NSString *errorMessage))  onFailure 

对房间内所有人禁止发送评论(不包括自己)或者取消,只有房间创建者才能调用生效

Parameters
ban禁止或取消禁止
onSuccess成功的回调
onFailure失败的回调

◆ banCommentWithUserID:banTimeInSeconds:onSuccess:onFailure:

- (void) banCommentWithUserID: (nonnull NSString *)  userID
banTimeInSeconds: (int32_t)  seconds
onSuccess: (void(^)(void))  onSuccess
onFailure: (void(^)(NSString *errorMessage))  onFailure 

禁止房间内某人发送互动评论

Parameters
userID被禁用户的id
seconds禁言的时间, 单位为s, 默认为0, 表示永久禁言(除非取消禁言)
onSuccess成功的回调
onFailure失败的回调

◆ cancelBanCommentWithUserID:onSuccess:onFailure:

- (void) cancelBanCommentWithUserID: (nonnull NSString *)  userID
onSuccess: (void(^)(void))  onSuccess
onFailure: (void(^)(NSString *errorMessage))  onFailure 

取消对房间内某人的禁止发送评论

Parameters
userID要取消禁言的用户id
onSuccess成功的回调
onFailure失败的回调

◆ getCurrentChatInfoOnSuccess:onFailure:

- (void) getCurrentChatInfoOnSuccess: (void(^)(NSDictionary *info))  onSuccess
onFailure: (void(^)(NSString *errMessage))  onFailure 

获取房间内当前的互动信息,包括点赞总数和评论的总数

Parameters
onSuccess成功的回调
onFailure失败的回调

◆ queryCommentsWithSortedType:pageNum:pageSize:onSuccess:onFailure:

- (void) queryCommentsWithSortedType: (AIRBRoomChatCommentsSortedType)  sortedType
pageNum: (int)  pageNum
pageSize: (int)  pageSize
onSuccess: (void(^)(AIRBRoomChannelCommentsResponse *response))  onSuccess
onFailure: (void(^)(NSString *errorMsg))  onFailure 

分页查询房间内互动评论

Parameters
sortedType查询评论按照时间的排序方式
pageNum查询的页码,从1开始
pageSize每页的大小
onSuccess成功的回调
onFailure失败的回调

◆ sendComment:extension:onSuccess:onFailure:

- (void) sendComment: (NSString *)  comment
extension: (NSDictionary< NSString *, NSString * > *)  extension
onSuccess: (void(^)(void))  onSuccess
onFailure: (void(^)(AIRBErrorCode code, NSString *message))  onFailure 

在房间内发送互动评论

Parameters
comment要发送的评论内容
extension扩展字段
onSuccess成功的回调
onFailure失败的回调

◆ sendComment:onSuccess:onFailure:

- (void) sendComment: (NSString *)  comment
onSuccess: (void(^)(void))  onSuccess
onFailure: (void(^)(AIRBErrorCode code, NSString *message))  onFailure 

在房间内发送互动评论

Parameters
comment要发送的评论内容
onSuccess成功的回调
onFailure失败的回调

◆ sendCustomMessage:toUsers:onSuccess:onFailure:

- (void) sendCustomMessage: (NSString *)  message
toUsers: (NSArray *)  userList
onSuccess: (void(^)(void))  onSuccess
onFailure: (void(^)(NSString *errorMessage))  onFailure 

在房间内给特定用户发送自定义消息

Parameters
message要发送的自定义消息内容
userList消息接收对象,为空时不发送
onSuccess成功的回调
onFailure失败的回调

◆ sendCustomMessageToALL:onSuccess:onFailure:

- (void) sendCustomMessageToALL: (NSString *)  message
onSuccess: (void(^)(void))  onSuccess
onFailure: (void(^)(NSString *errorMessage))  onFailure 

在房间内给所有用户发送自定义消息

Parameters
message要发送的自定义消息内容
onSuccess成功的回调
onFailure失败的回调

◆ sendLike

- (void) sendLike

发送点赞


The documentation for this protocol was generated from the following file: