JCSDK Objective-C API Reference for iOS/macOS  2.5.1
构造函数 | 类方法 | 属性 | 所有成员列表
JCMessageChannel类 参考

构造函数

(JCMessageChannelItem *__nullable) - sendMessage:keyId:messageType:text:extraParams:cookie:atAll:atServerUidList:
 
(JCMessageChannelItem *__nullable) - sendFile:keyId:messageType:fileUri:thumbUri:size:duration:extraParams:cookie:atAll:atServerUidList:
 
(int) - refreshConversation:lastQueryTime:
 
(int) - fetchMessages:startMessageId:count:pack:
 
(int) - markReadMessage:messageId:isGroup:
 
(int) - markRecvMessage:messageId:
 
(int) - withdrawalMessage:messageId:content:
 

类方法

(JCMessageChannel *__nullable) + create:callback:
 
(void) + destroy
 

属性

NSString *__nonnull thumbDir
 

详细描述

消息通道类,包括一对一消息和群组消息

函数文档

◆ create:callback:

+ (JCMessageChannel* __nullable) create: (JCClient *__nonnull)  client
callback: (id< JCMessageChannelCallback > __nonnull)  callback 

创建 JCMessageChannel 对象

JCMessageChannel 的所有接口函数,如无特殊说明,都建议在主线程调用

注解
参数
clientJCClient 对象
callbackJCMessageChannelCallback 回调接口,用于回调相关通知
返回
返回 JCMessageChannel 对象
异常
JCClient、JCMessageChannelCallback 任意一个参数传空就会出现调用异常

◆ destroy

+ (void) destroy

销毁 JCMessageChannel 对象

该方法为同步调用,需要等待 JCMessageChannel 实例资源释放后才能执行其他操作,调用此方法后,你将无法再使用 JCMessageChannel 的其它方法和回调。
我们 不建议 在 JCSDK 的回调中调用此方法销毁 JCMessageChannel 对象,否则会出现崩溃。
如需在销毁后再次创建 JCMessageChannel 实例,需要等待 destroy 方法执行结束后再创建实例。

◆ fetchMessages:startMessageId:count:pack:

- (int) fetchMessages: (nonnull NSString *)  serverUid
startMessageId: (long)  startMessageId
count: (int)  count
pack: (bool)  pack 

获取历史消息

参数
serverUid用户 serverUid 或者群组的 serverUid
startMessageId起始消息ID,如果-1从最新开始拉取
count拉取历史消息条数
pack消息列表是否一次性返回
返回

◆ markReadMessage:messageId:isGroup:

- (int) markReadMessage: (nonnull NSString *)  serverUid
messageId: (long)  messageId
isGroup: (bool)  isGroup 

标志消息为已读

参数
serverUid用户 serverUid 或者群组的 serverUid
messageId消息ID,如果-1表示最后一条消息
返回
  • >0:操作id,结果通过 onMarkReadResult 通知
  • -1:调用失败,不会收到回调

◆ markRecvMessage:messageId:

- (int) markRecvMessage: (nonnull NSString *)  serverUid
messageId: (long)  messageId 

标志消息为已收

参数
serverUid用户 serverUid 或者群组的 serverUid
messageId消息ID,如果-1表示最后一条消息
返回
  • >0:操作id,结果通过 onMarkRecvResult 通知
  • -1:调用失败,不会收到回调

◆ refreshConversation:lastQueryTime:

- (int) refreshConversation: (NSString *__nullable)  serverUid
lastQueryTime: (long)  lastQueryTime 

获取消息会话

参数
serverUid用户 serverUid 或者群组的 groupId,传 null返回全部
lastQueryTime上次查询返回的时间,单位毫秒
返回

◆ sendFile:keyId:messageType:fileUri:thumbUri:size:duration:extraParams:cookie:atAll:atServerUidList:

- (JCMessageChannelItem* __nullable) sendFile: (JCMessageChannelType type
keyId: (NSString *__nonnull)  keyId
messageType: (NSString *__nonnull)  messageType
fileUri: (NSString *__nonnull)  fileUri
thumbUri: (NSString *__nullable)  thumbUri
size: (int)  size
duration: (int)  duration
extraParams: (NSDictionary *__nullable)  extraParams
cookie: (id __nullable)  cookie
atAll: (bool)  atAll
atServerUidList: (NSArray< NSString * > *__nullable)  atServerUidList 

发送文件消息

参数
type类型:
keyId对方唯一标识
messageType文件消息类型,用户可以自定义,例如image,video等
fileUri文件链接地址
thumbUri缩略图文件链接地址
size文件大小(字节)
duration文件时长,针对语音,视频等消息
extraParams自定义参数集
cookie标志数据
atAll是否@群体成员,针对群消息
atUidList"@"成员的serverUid列表 针对群消息
返回

◆ sendMessage:keyId:messageType:text:extraParams:cookie:atAll:atServerUidList:

- (JCMessageChannelItem* __nullable) sendMessage: (JCMessageChannelType type
keyId: (NSString *__nonnull)  keyId
messageType: (NSString *__nonnull)  messageType
text: (NSString *__nonnull)  text
extraParams: (NSDictionary *__nullable)  extraParams
cookie: (id __nullable)  cookie
atAll: (bool)  atAll
atServerUidList: (NSArray< NSString * > *__nullable)  atServerUidList 

发送文本消息

注解
文本内容不要超过10KB
参数
type类型:
keyId对方唯一标识:
messageType文本消息类型,用户可以自定义,例如text,xml等
text文本内容
extraParams自定义参数集
cookie标志数据
atAll是否@群体成员,针对群消息
atServerUidList"@"成员的serverUid列表 针对群消息
返回

◆ withdrawalMessage:messageId:content:

- (int) withdrawalMessage: (nonnull NSString *)  serverUid
messageId: (long)  messageId
content: (NSString *__nonnull)  content 

撤回消息

参数
serverUid用户 serverUid 或者群组的 serverUid
messageId消息ID
content文本内容
返回

属性说明

◆ thumbDir

- (NSString* __nonnull) thumbDir
readwritenonatomiccopy

缩率图保存路径

初始化会默认设置,同时用户可以自己设置


该类的文档由以下文件生成: