JCSDK Objective-C API Reference for iOS/macOS
2.5.1
|
类方法 | |
(JCMessageChannel *__nullable) | + create:callback: |
(void) | + destroy |
属性 | |
NSString *__nonnull | thumbDir |
消息通道类,包括一对一消息和群组消息
+ (JCMessageChannel* __nullable) create: | (JCClient *__nonnull) | client | |
callback: | (id< JCMessageChannelCallback > __nonnull) | callback | |
创建 JCMessageChannel 对象
JCMessageChannel 的所有接口函数,如无特殊说明,都建议在主线程调用
client | JCClient 对象 |
callback | JCMessageChannelCallback 回调接口,用于回调相关通知 |
JCClient、JCMessageChannelCallback 任意一个参数传空就会出现调用异常 |
+ (void) destroy |
销毁 JCMessageChannel 对象
该方法为同步调用,需要等待 JCMessageChannel 实例资源释放后才能执行其他操作,调用此方法后,你将无法再使用 JCMessageChannel 的其它方法和回调。
我们 不建议 在 JCSDK 的回调中调用此方法销毁 JCMessageChannel 对象,否则会出现崩溃。
如需在销毁后再次创建 JCMessageChannel 实例,需要等待 destroy 方法执行结束后再创建实例。
- (int) fetchMessages: | (nonnull NSString *) | serverUid | |
startMessageId: | (long) | startMessageId | |
count: | (int) | count | |
pack: | (bool) | pack | |
获取历史消息
serverUid | 用户 serverUid 或者群组的 serverUid |
startMessageId | 起始消息ID,如果-1从最新开始拉取 |
count | 拉取历史消息条数 |
pack | 消息列表是否一次性返回 |
- (int) markReadMessage: | (nonnull NSString *) | serverUid | |
messageId: | (long) | messageId | |
isGroup: | (bool) | isGroup | |
标志消息为已读
serverUid | 用户 serverUid 或者群组的 serverUid |
messageId | 消息ID,如果-1表示最后一条消息 |
- (int) markRecvMessage: | (nonnull NSString *) | serverUid | |
messageId: | (long) | messageId | |
标志消息为已收
serverUid | 用户 serverUid 或者群组的 serverUid |
messageId | 消息ID,如果-1表示最后一条消息 |
- (int) refreshConversation: | (NSString *__nullable) | serverUid | |
lastQueryTime: | (long) | lastQueryTime | |
获取消息会话
serverUid | 用户 serverUid 或者群组的 groupId,传 null返回全部 |
lastQueryTime | 上次查询返回的时间,单位毫秒 |
- (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列表 针对群消息 |
- (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 | |
发送文本消息
type | 类型:
|
keyId | 对方唯一标识:
|
messageType | 文本消息类型,用户可以自定义,例如text,xml等 |
text | 文本内容 |
extraParams | 自定义参数集 |
cookie | 标志数据 |
atAll | 是否@群体成员,针对群消息 |
atServerUidList | "@"成员的serverUid列表 针对群消息 |
- (int) withdrawalMessage: | (nonnull NSString *) | serverUid | |
messageId: | (long) | messageId | |
content: | (NSString *__nonnull) | content | |
撤回消息
serverUid | 用户 serverUid 或者群组的 serverUid |
messageId | 消息ID |
content | 文本内容 |
|
readwritenonatomiccopy |
缩率图保存路径
初始化会默认设置,同时用户可以自己设置