RCExtensionModule Protocol Reference
Conforms to | NSObject |
---|---|
Declared in | RCExtensionModule.h |
+ loadRongExtensionModule
required method
生成一个扩展模块。
+ (instancetype)loadRongExtensionModule
Discussion
生成一个扩展模块。
Declared In
RCExtensionModule.h
– initWithAppKey:
初始化融云SDK
- (void)initWithAppKey:(NSString *)appkey
Parameters
appkey |
应用的融云Appkey |
---|
Discussion
初始化融云SDK
Declared In
RCExtensionModule.h
– didConnect:
连接融云IM服务
- (void)didConnect:(NSString *)userId
Parameters
userId |
用户ID |
---|
Discussion
连接融云IM服务
Declared In
RCExtensionModule.h
– didCurrentUserInfoUpdated:
当前登陆的用户信息变化的回调
- (void)didCurrentUserInfoUpdated:(RCUserInfo *)userInfo
Parameters
userInfo |
当前登陆的用户信息 |
---|
Discussion
当前登陆的用户信息变化的回调
Declared In
RCExtensionModule.h
– onMessageReceived:
处理收到的消息
- (void)onMessageReceived:(RCMessage *)message
Parameters
message |
收到的消息 |
---|
Discussion
处理收到的消息
Declared In
RCExtensionModule.h
– handleAlertForMessageReceived:
处理收到消息响铃事件
- (BOOL)handleAlertForMessageReceived:(RCMessage *)message
Parameters
message |
收到的消息 |
---|
Return Value
扩展模块处理的结果,YES为模块处理,SDK不会响铃。NO为模块未处理,SDK会默认处理。 @discussion 当应用处在前台时,如果在新来消息的会话内,没有铃声和通知;如果不在该会话内会铃声提示。当应用处在后台时,新来消息会弹出本地通知
Discussion
处理收到消息响铃事件
Declared In
RCExtensionModule.h
– handleNotificationForMessageReceived:from:userInfo:
处理收到消息通知事件
- (BOOL)handleNotificationForMessageReceived:(RCMessage *)message from:(NSString *)fromName userInfo:(NSDictionary *)userInfo
Parameters
message |
收到的消息 @param fromName 来源名字,如果message是单聊消息就是发送者的名字,如果是群组消息就是群组名,如果是讨论组消息就是讨论组名。 |
---|---|
userInfo |
LocalNotification userInfo。如果扩展模块要弹本地通知,请一定带上userInfo。 |
Return Value
扩展模块处理的结果,YES为模块处理,SDK不会弹出通知。NO为模块未处理,SDK会默认处理。 @discussion 当应用处在前台时,如果在新来消息的会话内,没有铃声和通知;如果不在该会话内会铃声提示。当应用处在后台时,新来消息会弹出本地通知
Discussion
处理收到消息通知事件
Declared In
RCExtensionModule.h
– setScheme:
设置扩展模块URL scheme。
- (void)setScheme:(NSString *)scheme
Parameters
scheme |
URL scheme |
---|
Discussion
设置扩展模块URL scheme。
Declared In
RCExtensionModule.h
– onOpenUrl:
处理openUrl请求
- (BOOL)onOpenUrl:(NSURL *)url
Discussion
处理openUrl请求
return 是否处理
Declared In
RCExtensionModule.h
– getPluginBoardItemInfoList:targetId:
获取会话页面的plugin board item信息。
- (NSArray<RCExtensionPluginItemInfo*> *)getPluginBoardItemInfoList:(RCConversationType)conversationType targetId:(NSString *)targetId
Parameters
conversationType |
会话类型 |
---|---|
targetId |
targetId |
Return Value
plugin board item信息列表。
Discussion
获取会话页面的plugin board item信息。
当进入到会话页面时,SDK需要注册扩展面部区域的item。
Declared In
RCExtensionModule.h
– getEmoticonTabList:targetId:
获取会话输入区的表情tab页
- (NSArray<id<RCEmoticonTabSource> > *)getEmoticonTabList:(RCConversationType)conversationType targetId:(NSString *)targetId
Parameters
conversationType |
会话类型 |
---|---|
targetId |
targetId |
Return Value
需要加载的表情tab页列表
Discussion
获取会话输入区的表情tab页
Declared In
RCExtensionModule.h
– emoticonTab:didTouchAddButton:inInputBar:
点击表情面板中的加号按钮的回调
- (void)emoticonTab:(RCEmojiBoardView *)emojiView didTouchAddButton:(UIButton *)addButton inInputBar:(RCChatSessionInputBarControl *)inputBarControl
Parameters
emojiView |
表情面板 |
---|---|
addButton |
加号按钮 |
inputBarControl |
表情面板所在的输入工具栏 |
Discussion
点击表情面板中的加号按钮的回调
Declared In
RCExtensionModule.h
– emoticonTab:didTouchEmotionIconIndex:inInputBar:isBlockDefaultEvent:
点击表情面板中的表情包 Icon 按钮的回调
- (void)emoticonTab:(RCEmojiBoardView *)emojiView didTouchEmotionIconIndex:(int)index inInputBar:(RCChatSessionInputBarControl *)inputBarControl isBlockDefaultEvent:(void ( ^ ) ( BOOL isBlockDefaultEvent ))block
Parameters
emojiView |
表情面板 |
---|---|
index |
表情包 Icon 的索引 |
inputBarControl |
表情面板所在的输入工具栏 |
block |
是否阻止 SDK 默认的点击处理逻辑 |
Discussion
点击表情面板中的表情包 Icon 按钮的回调
Declared In
RCExtensionModule.h
– emoticonTab:didTouchSettingButton:inInputBar:
点击表情面板中的设置按钮的回调
- (void)emoticonTab:(RCEmojiBoardView *)emojiView didTouchSettingButton:(UIButton *)settingButton inInputBar:(RCChatSessionInputBarControl *)inputBarControl
Parameters
emojiView |
表情面板 |
---|---|
settingButton |
设置Button |
inputBarControl |
表情面板所在的输入工具栏 |
Discussion
点击表情面板中的设置按钮的回调
Declared In
RCExtensionModule.h
– inputTextViewDidChange:inInputBar:
输入框内容发生变化的回调
- (void)inputTextViewDidChange:(UITextView *)inputTextView inInputBar:(RCChatSessionInputBarControl *)inputBarControl
Parameters
inputTextView |
文本输入框 |
---|---|
inputBarControl |
文本输入框所在的输入工具栏 |
Discussion
输入框内容发生变化的回调
Declared In
RCExtensionModule.h
– inputBarStatusDidChange:inInputBar:
输入工具栏状态发生变化的回调
- (void)inputBarStatusDidChange:(KBottomBarStatus)status inInputBar:(RCChatSessionInputBarControl *)inputBarControl
Parameters
status |
输入工具栏当前状态 |
---|---|
inputBarControl |
输入工具栏 |
Discussion
输入工具栏状态发生变化的回调
Declared In
RCExtensionModule.h
– isEmoticonAddButtonEnabled:
是否需要显示表情加号按钮
- (BOOL)isEmoticonAddButtonEnabled:(RCChatSessionInputBarControl *)inputBarControl
Parameters
inputBarControl |
输入工具栏 |
---|
Discussion
是否需要显示表情加号按钮
Declared In
RCExtensionModule.h
– isEmoticonSettingButtonEnabled:
是否需要显示表情设置按钮
- (BOOL)isEmoticonSettingButtonEnabled:(RCChatSessionInputBarControl *)inputBarControl
Parameters
inputBarControl |
输入工具栏 |
---|
Discussion
是否需要显示表情设置按钮
Declared In
RCExtensionModule.h
– isAudioHolding
是否正在使用声音通道
- (BOOL)isAudioHolding
Discussion
是否正在使用声音通道
Declared In
RCExtensionModule.h
– isCameraHolding
是否正在使用摄像头
- (BOOL)isCameraHolding
Discussion
是否正在使用摄像头
Declared In
RCExtensionModule.h