iOS

BRTMDelegate代理回调

---

didJoinRoomSuccess
加入房间成功

• 成功时所有初始化工作已经结束，vm 的状态、数据已经和服务端同步，并可调用 vm 方法

- (void)didJoinRoomSuccess:(BRTMRoom *)room;

参数

返回

---

didJoinRoomSuccess
加入房间失败

- (void)didJoinRoomFailure:(BRTMRoom *)room error:(BRTMError *)error;

参数

Name	Type	Description
error	BRTMError *	错误信息, 主退出为空, 否则为异常退出

返回

---

willLeaveRoom
即将离开房间的通知

• @param error 错误信息, 主退出为空, 否则为异常退出

- (void)willLeaveRoom:(BRTMRoom *)room error:(nullable BRTMError *)error;

参数

Name	Type	Description
error	BRTMError *	错误信息, 主退出为空, 否则为异常退出

返回

---

didLeaveRoom
离开房间的通知

- (void)didLeaveRoom:(BRTMRoom *)room error:(nullable BRTMError *)error;

参数

Name	Type	Description
error	BRTMError *	错误信息, 主退出为空, 否则为异常退出

返回

---

documentServiceIsEnable
房间内的 document 服务是否可用

- (void)room:(BRTMRoom *)room documentServiceIsEnable:(BOOL)enable senderByUserID:(nullable NSString *)userID;

参数

Name	Type	Description
enable	BOOL	是否可用, 当 enable 为 NO 时, 内部会调用 destoryDocumentManager 销毁documentManger
userID	NSString *	触发此广播的userID, 初次进房间的时候, userID 为空

返回

---

BRTMRoom类

函数列表	描述
setAppID	设置appID
createRoom	创建一个room, 不是单例
joinRoomWithConfig	进入房间听
setReloadingBlock	网络连接断开时回调
leaveRoom	退出房间
sendBroadcastMessageWithKey	发送自定义广播信令
requestBroadcastMessageCacheWithKey	请求自定义广播的缓存
sendMessageWithKey	发送自定义广播给指定用户
enabelDocumentService	启用文档服务
disabelDocumentService	停止文档服务
createDocumentManager	实例化 BRTMDocumentManager
destoryDocumentManager	销毁 BRTMDocumentManager

---

BRTMRoom类成员变量

---

delegate
进入房间相关的代理

@property (nonatomic, weak) id <BRTMDelegate> delegate;

---

messageDelegate
消息相关的代理. note: 区别于 chat

@property (nonatomic, weak) id <BRTMMessageDelegate> messageDelegate;

---

userManager
用户相关, 详细参阅 BRTMUserManager.h

@property (nonatomic, readonly, nullable) BRTMUserManager *userManager;

---

chatManager
聊天相关, 详细参阅 BRTMChatManager.h

@property (nonatomic, readonly, nullable) BRTMChatManager *chatManager;

---

documentManager
聊天相关, 详细参阅 BRTMChatManager.h

@property (nonatomic, readonly, nullable) BRTMDocumentManager *documentManager;

---

BRTMRoom类函数定义

---

setAppID
设置appID

+ (void)setAppID:(NSString *)appID;

参数

Name	Type	Description
appID	NSString *	需要先设置appID, 否则调用 createRoom 实例化会失败

返回

---

createRoom
创建一个room

+ (nullable instancetype)createRoom;

参数

返回

• instancetype: 返回实例对象,如果没有设置appID, 返回nil

---

joinRoomWithConfig
进入房间

- (nullable BRTMError *)joinRoomWithConfig:(BRTMConfig *)config;

参数

Name	Type	Description
config	BRTMConfig *	进入房间配置

返回

• BRTMError:
• BRTMErrorCode_invalidArguments 参数出错

---

setReloadingBlock
网络连接断开时回调

- (void)setReloadingBlock:(void (^ _Nullable)(BRTMLoadingVM *reloadingVM,
                                              void (^callback)(BOOL reload)))reloadingBlock;

参数

Name	Type	Description
reloadingBlock	void (^ _Nullable)(BRTMLoadingVM *reloadingVM,void (^callback)(BOOL reload))	重连回调。reloadingVM：重连 vm；callback(reload)：调用 callback 时 reload 参数传 YES 重连，NO 将导致 异常退出 ; 网络连接断开时回调，回调 callback 确认是否重连，YES 重连、NO 退出教室，也可延时或者手动调用 callback ; 可通过 reloadingVM 监听重连的进度和结果; 默认（不设置此回调）在断开时自动重连、重连过程中遇到错误将 异常退出; !!!: 断开重连过程中 vm 的状态、数据没有与服务端同步，调用其它 vm 方法时发起的网络请求会被丢弃、甚至产生不可预期的错误

返回

---

sendBroadcastMessageWithKey
发送自定义广播信令,通过'messageDelegate' 的 'room:didReceiveBoardcastMessageWithKey:value:' 监听

- (nullable BRTMError *)sendBroadcastMessageWithKey:(NSString *)key value:(id)value cache:(BOOL)cache;

参数

Name	Type	Description
key	NSString *	自定义的key
value	id	自定义的发送内容
cache	BOOL	是否需要缓存

返回

• BRTMError:
• BRTMErrorCode_invalidArguments 参数不对
• BRTMErrorCode_areYouRobot 发送频率过快，要求每秒不超过 5 条、并且每分钟不超过 60 条

---

requestBroadcastMessageCacheWithKey
请求自定义广播的缓存,通过'messageDelegate' 的 'room:didReceiveBoardcastMessageWithKey:value:' 监听

- (nullable BRTMError *)requestBroadcastMessageCacheWithKey:(NSString *)key;

参数

Name	Type	Description
key	NSString *	自定义的key

返回

• BRTMUserModel

---

sendMessageWithKey
请求自定义广播的缓存, 通过'messageDelegate' 的 'room:didReceiveMessageWithKey:value:fromUserID:' 监听

- (nullable BRTMError *)sendMessageWithKey:(NSString *)key value:(id _Nullable)value toUserWithUserID:(NSString *)userID;

参数

Name	Type	Description
key	NSString *	自定义的key
value	id	自定义的发送内容
userID	NSString *	指定用户的userID

返回

• BRTMError:
• BRTMErrorCode_invalidArguments 参数不对
• BRTMErrorCode_areYouRobot 发送频率过快，要求每秒不超过 5 条、并且每分钟不超过 60 条

---

enabelDocumentService
启用文档服务

void enabelDocumentService()

参数

返回

---

disableDocumentService
禁用文档服务

void disableDocumentService()

参数

返回

---

createDocumentManager
实例化 BRTMDocumentManager, 调用此方法后 documentAdatper 才有值

void createDocumentManager()

参数

返回

---

destoryDocumentManager
销毁 BRTMDocumentManager 实例

void destoryDocumentManager()

参数

返回