构造函数 | |
(void) | - addConversationListener: |
(void) | - removeConversationListener: |
(void) | - getConversationList:count:succ:fail: |
(void) | - getConversation:succ:fail: |
(void) | - getConversationList:succ:fail: |
(void) | - getConversationListByFilter:succ:fail: |
(void) | - deleteConversation:succ:fail: |
(void) | - setConversationDraft:draftText:succ:fail: |
(void) | - setConversationCustomData:customData:succ:fail: |
(void) | - pinConversation:isPinned:succ:fail: |
(void) | - markConversation:markType:enableMark:succ:fail: |
(void) | - getTotalUnreadMessageCount:fail: |
(void) | - setConversationListener: |
(void) | - createConversationGroup:conversationIDList:succ:fail: |
(void) | - getConversationGroupList:fail: |
(void) | - deleteConversationGroup:succ:fail: |
(void) | - renameConversationGroup:newName:succ:fail: |
(void) | - addConversationsToGroup:conversationIDList:succ:fail: |
(void) | - deleteConversationsFromGroup:conversationIDList:succ:fail: |
|
protected |
获取会话列表成功的回调,nextSeq:下一次分页拉取的游标 isFinished:会话列表是否已经拉取完毕
|
protected |
获取单个会话成功回调
|
protected |
搜索会话列表成功回调
|
protected |
获取会话总未读数回调
|
protected |
获取会话分组列表成功回调
|
protected |
会话操作成功回调
|
protected |
|
protected |
|
protected |
- (void) addConversationListener: | (addConversationListener(listener:)) | NS_SWIFT_NAME |
1.1 添加会话监听器
- (void) removeConversationListener: | (removeConversationListener(listener:)) | NS_SWIFT_NAME |
1.2 移除会话监听器
- (void) getConversationList: | (uint64_t) | nextSeq | |
count: | (int) | count | |
succ: | (V2TIMConversationResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
1.3 获取会话列表
nextSeq | 分页拉取的游标,第一次默认取传 0,后续分页拉传上一次分页拉取成功回调里的 nextSeq |
count | 分页拉取的个数,一次分页拉取不宜太多,会影响拉取的速度,建议每次拉取 100 个会话 |
- (void) getConversation: | (NSString *) | conversationID | |
succ: | (V2TIMConversationSucc) | succ | |
fail: | (V2TIMFail) | fail | |
1.4 获取单个会话
conversationID | 会话唯一 ID, C2C 单聊组成方式:[NSString stringWithFormat:"c2c_%",userID];群聊组成方式为 [NSString stringWithFormat:"group_%",groupID] |
- (void) getConversationList: | (NSArray< NSString * > *) | conversationIDList | |
succ: | (V2TIMConversationListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
1.5 获取指定会话列表
conversationIDList | 会话唯一 ID 列表,C2C 单聊组成方式:[NSString stringWithFormat:"c2c_%",userID];群聊组成方式为 [NSString stringWithFormat:"group_%",groupID] |
- (void) getConversationListByFilter: | (V2TIMConversationListFilter *) | filter | |
succ: | (V2TIMConversationResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
1.6 获取会话列表高级接口(从 6.5 版本开始支持)
- (void) deleteConversation: | (NSString *) | conversationID | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
1.7 删除会话以及该会话中的历史消息
conversationID | 会话唯一 ID,C2C 单聊组成方式:[NSString stringWithFormat:"c2c_%",userID];群聊组成方式为 [NSString stringWithFormat:"group_%",groupID] |
- (void) setConversationDraft: | (NSString *) | conversationID | |
draftText: | (NSString *) | draftText | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
1.8 设置会话草稿
conversationID | 会话唯一 ID,C2C 单聊组成方式:[NSString stringWithFormat:"c2c_%",userID];群聊组成方式为 [NSString stringWithFormat:"group_%",groupID] |
只在本地保存,不会存储 Server,不能多端同步,程序卸载重装会失效。
- (void) setConversationCustomData: | (NSArray< NSString * > *) | conversationIDList | |
customData: | (NSData *) | customData | |
succ: | (V2TIMConversationOperationResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
1.9 设置会话自定义数据(从 6.5 版本开始支持)
customData | 自定义数据,最大支持 256 bytes |
- (void) pinConversation: | (NSString *) | conversationID | |
isPinned: | (BOOL) | isPinned | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
1.10 设置会话置顶(5.3.425 及以上版本支持)
conversationID | 会话唯一 ID,C2C 单聊组成方式:[NSString stringWithFormat:"c2c_%",userID];群聊组成方式为 [NSString stringWithFormat:"group_%",groupID] |
isPinned | 是否置顶 |
- (void) markConversation: | (NSArray< NSString * > *) | conversationIDList | |
markType: | (NSNumber *) | markType | |
enableMark: | (BOOL) | enableMark | |
succ: | (V2TIMConversationOperationResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
1.11 标记会话(从 6.5 版本开始支持,需要您购买旗舰版套餐)
conversationIDList | 会话列表 |
markType | 会话标记类型,取值详见 @V2TIMConversationMarkType。 |
enableMark | YES:设置标记 NO:取消标记 |
如果已有标记不能满足您的需求,您可以自定义扩展标记,扩展标记需要满足以下两个条件: 1、扩展标记值不能和 V2TIMConversationMarkType 已有的标记值冲突 2、扩展标记值必须是 0x1LL << n 的位移值(32 <= n < 64,即 n 必须大于等于 32 并且小于 64),比如扩展标记值 0x1LL << 32 表示 "iPhone 在线"
- (void) getTotalUnreadMessageCount: | (V2TIMTotalUnreadMessageCountSucc) | succ | |
fail: | (V2TIMFail) | fail | |
1.12 获取所有会话的未读消息总数(5.3.425 及以上版本支持)
- (void) setConversationListener: | (id< V2TIMConversationListener >) | listener |
设置会话监听器(待废弃接口,请使用 addConversationListener 和 removeConversationListener 接口)
- (void) createConversationGroup: | (NSString *) | groupName | |
conversationIDList: | (NSArray< NSString * > *) | conversationIDList | |
succ: | (V2TIMConversationOperationResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.1 创建会话分组
groupName | 分组名(必填参数,长度要 > 0,最大支持 32 bytes) |
conversationIDList | 会话 ID 列表(必填参数,不能为空) |
- (void) getConversationGroupList: | (V2TIMConversationGroupListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.2 获取会话分组列表
- (void) deleteConversationGroup: | (NSString *) | groupName | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.3 删除会话分组
- (void) renameConversationGroup: | (NSString *) | oldName | |
newName: | (NSString *) | newName | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.4 重命名会话分组
- (void) addConversationsToGroup: | (NSString *) | groupName | |
conversationIDList: | (NSArray< NSString * > *) | conversationIDList | |
succ: | (V2TIMConversationOperationResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.5 添加会话到一个会话分组
- (void) deleteConversationsFromGroup: | (NSString *) | groupName | |
conversationIDList: | (NSArray< NSString * > *) | conversationIDList | |
succ: | (V2TIMConversationOperationResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.6 从一个会话分组中删除会话