Protected 类型 | |
| enum | V2TIMGroupAddOpt : NSInteger |
| enum | V2TIMGroupMemberResult : NSInteger |
| enum | V2TIMGroupMemberFilter : NSInteger |
| enum | V2TIMGroupApplicationType : NSInteger |
| enum | V2TIMGroupApplicationHandleStatus : NSInteger |
| enum | V2TIMGroupApplicationHandleResult : NSInteger |
| typedef void(^ | V2TIMGroupInfoListSucc) (NSArray< V2TIMGroupInfo * > *groupList) |
| typedef void(^ | V2TIMGroupInfoResultListSucc) (NSArray< V2TIMGroupInfoResult * > *groupResultList) |
| typedef void(^ | V2TIMGroupSearchResultSucc) (V2TIMGroupSearchResult *searchResult) |
| typedef void(^ | V2TIMGroupAttributeListSucc) (NSMutableDictionary< NSString *, NSString * > *groupAttributeList) |
| typedef void(^ | V2TIMGroupMemberInfoListSucc) (NSArray< V2TIMGroupMemberFullInfo * > *memberList) |
| typedef void(^ | V2TIMGroupMemberInfoResultSucc) (uint64_t nextSeq, NSArray< V2TIMGroupMemberFullInfo * > *memberList) |
| typedef void(^ | V2TIMGroupMemberInfoListSearchSucc) (NSDictionary< NSString *, NSArray< V2TIMGroupMemberFullInfo * > * > *memberList) |
| typedef void(^ | V2TIMGroupMemberSearchResultSucc) (V2TIMGroupMemberSearchResult *searchResult) |
| typedef void(^ | V2TIMGroupMemberOperationResultListSucc) (NSArray< V2TIMGroupMemberOperationResult * > *resultList) |
| typedef void(^ | V2TIMGroupApplicationResultSucc) (V2TIMGroupApplicationResult *result) |
| typedef void(^ | V2TIMGroupOnlineMemberCountSucc) (NSInteger count) |
| typedef void(^ | V2TIMGroupCounterResultSucc) (NSDictionary< NSString *, NSNumber * > *groupCounters) |
|
protected |
获取已加入群列表成功回调
|
protected |
获取指定群列表成功回调
|
protected |
云端搜索群组的结果回调
|
protected |
获取群属性列表成功回调
|
protected |
获取群成员列表成功回调
|
protected |
获取指定群成员列表成功回调
|
protected |
搜索本地群成员列表成功回调
|
protected |
搜索云端群成员列表成功回调
|
protected |
群成员操作成功回调
|
protected |
获取好友申请列表成功回调
|
protected |
获取群在线人数成功回调
|
protected |
群计数器操作成功的回调
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
| - (void) createGroup: | (V2TIMGroupInfo *) | info | |
| memberList: | (NSArray< V2TIMCreateGroupMemberInfo * > *_Nullable) | memberList | |
| succ: | (V2TIMCreateGroupSucc) | succ | |
| fail: | (createGroup(info:memberList:succ:fail:)) | NS_SWIFT_NAME | |
1.1 创建自定义群组(高级版本:可以指定初始的群成员)
| info | 自定义群组信息,可以设置 groupID | groupType | groupName | notification | introduction | faceURL 字段 |
| memberList | 指定初始的群成员(直播群 AVChatRoom 不支持指定初始群成员,memberList 请传 nil) |
| - (void) getJoinedGroupList: | (V2TIMGroupInfoListSucc) | succ | |
| fail: | (getJoinedGroupList(succ:fail:)) | NS_SWIFT_NAME | |
1.2 获取当前用户已经加入的群列表
| - (void) getGroupsInfo: | (NSArray< NSString * > *) | groupIDList | |
| succ: | (V2TIMGroupInfoResultListSucc) | succ | |
| fail: | (V2TIMFail) | fail | |
2.1 拉取群资料
| groupIDList | 群组 ID 列表 |
| - (void) searchGroups: | (V2TIMGroupSearchParam *) | searchParam | |
| succ: | (V2TIMGroupInfoListSucc) | succ | |
| fail: | (searchGroups(searchParam:succ:fail:)) | NS_SWIFT_NAME | |
| - (void) searchCloudGroups: | (V2TIMGroupSearchParam *) | searchParam | |
| succ: | (V2TIMGroupSearchResultSucc) | succ | |
| fail: | (searchCloudGroups(searchParam:succ:fail:)) | NS_SWIFT_NAME | |
2.3 搜索云端群资料(8.4 及以上版本支持)
| - (void) setGroupInfo: | (V2TIMGroupInfo *) | info | |
| succ: | (_Nullable V2TIMSucc) | succ | |
| fail: | (setGroupInfo(info:succ:fail:)) | NS_SWIFT_NAME | |
2.4 修改群资料
| - (void) initGroupAttributes: | (NSString *) | groupID | |
| attributes: | (NSDictionary< NSString *, NSString * > *) | attributes | |
| succ: | (_Nullable V2TIMSucc) | succ | |
| fail: | (initGroupAttributes(groupID:attributes:succ:fail:)) | NS_SWIFT_NAME | |
2.5 初始化群属性,会清空原有的群属性列表
| - (void) setGroupAttributes: | (NSString *) | groupID | |
| attributes: | (NSDictionary< NSString *, NSString * > *) | attributes | |
| succ: | (_Nullable V2TIMSucc) | succ | |
| fail: | (setGroupAttributes(groupID:attributes:succ:fail:)) | NS_SWIFT_NAME | |
2.6 设置群属性,已有该群属性则更新其 value 值,没有该群属性则添加该群属性。
| - (void) deleteGroupAttributes: | (NSString *) | groupID | |
| keys: | (NSArray< NSString * > *_Nullable) | keys | |
| succ: | (_Nullable V2TIMSucc) | succ | |
| fail: | (deleteGroupAttributes(groupID:keys:succ:fail:)) | NS_SWIFT_NAME | |
2.7 删除群指定属性,keys 传 nil 则清空所有群属性。
| - (void) getGroupAttributes: | (NSString *) | groupID | |
| keys: | (NSArray< NSString * > *_Nullable) | keys | |
| succ: | (V2TIMGroupAttributeListSucc) | succ | |
| fail: | (V2TIMFail) | fail | |
2.8 获取群指定属性,keys 传 nil 则获取所有群属性。
| - (void) getGroupOnlineMemberCount: | (NSString *) | groupID | |
| succ: | (V2TIMGroupOnlineMemberCountSucc) | succ | |
| fail: | (getGroupOnlineMemberCount(groupID:succ:fail:)) | NS_SWIFT_NAME | |
2.9 获取指定群在线人数
| groupID | 群id |
| succ | 成功回调 |
| fail | 失败回调 |
| - (void) setGroupCounters: | (NSString *) | groupID | |
| counters: | (NSDictionary< NSString *, NSNumber * > *) | counters | |
| succ: | (V2TIMGroupCounterResultSucc) | succ | |
| fail: | (setGroupCounters(groupID:counters:succ:fail:)) | NS_SWIFT_NAME | |
2.10 设置群计数器(7.0 及其以上版本支持)
| - (void) getGroupCounters: | (NSString *) | groupID | |
| keys: | (NSArray< NSString * > *_Nullable) | keys | |
| succ: | (V2TIMGroupCounterResultSucc) | succ | |
| fail: | (getGroupCounters(groupID:keys:succ:fail:)) | NS_SWIFT_NAME | |
2.11 获取群计数器(7.0 及其以上版本支持)
| - (void) increaseGroupCounter: | (NSString *) | groupID | |
| key: | (NSString *) | key | |
| value: | (NSInteger) | value | |
| succ: | (V2TIMGroupCounterResultSucc) | succ | |
| fail: | (increaseGroupCounter(groupID:key:value:succ:fail:)) | NS_SWIFT_NAME | |
2.12 递增群计数器(7.0 及其以上版本支持)
| groupID | 群 ID |
| key | 群计数器的 key |
| value | 群计数器的递增的变化量,计数器 key 对应的 value 变更方式为: new_value = old_value + value |
| succ | 成功后的回调,会返回当前计数器做完递增操作后的 value |
| fail | 失败的回调 |
| - (void) decreaseGroupCounter: | (NSString *) | groupID | |
| key: | (NSString *) | key | |
| value: | (NSInteger) | value | |
| succ: | (V2TIMGroupCounterResultSucc) | succ | |
| fail: | (decreaseGroupCounter(groupID:key:value:succ:fail:)) | NS_SWIFT_NAME | |
2.13 递减群计数器(7.0 及其以上版本支持)
| groupID | 群 ID |
| key | 群计数器的 key |
| value | 群计数器的递减的变化量,计数器 key 对应的 value 变更方式为: new_value = old_value - value |
| succ | 成功后的回调,会返回当前计数器做完递减操作后的 value |
| fail | 失败的回调 |
| - (void) getGroupMemberList: | (NSString *) | groupID | |
| filter: | (uint32_t) | filter | |
| nextSeq: | (uint64_t) | nextSeq | |
| succ: | (V2TIMGroupMemberInfoResultSucc) | succ | |
| fail: | (V2TIMFail) | fail | |
3.1 获取群成员列表
| filter | 指定群成员类型。 |
| nextSeq | 分页拉取标志,第一次拉取填 0,回调成功如果 nextSeq 不为零,需要分页,传入再次拉取,直至为 0。 |
| - (void) getGroupMembersInfo: | (NSString *) | groupID | |
| memberList: | (NSArray< NSString * > *) | memberList | |
| succ: | (V2TIMGroupMemberInfoListSucc) | succ | |
| fail: | (getGroupMembersInfo(groupID:memberList:succ:fail:)) | NS_SWIFT_NAME | |
3.2 指定的群成员资料
| - (void) searchGroupMembers: | (V2TIMGroupMemberSearchParam *) | searchParam | |
| succ: | (V2TIMGroupMemberInfoListSearchSucc) | succ | |
| fail: | (searchGroupMembers(searchParam:succ:fail:)) | NS_SWIFT_NAME | |
| - (void) searchCloudGroupMembers: | (V2TIMGroupMemberSearchParam *) | searchParam | |
| succ: | (V2TIMGroupMemberSearchResultSucc) | succ | |
| fail: | (searchCloudGroupMembers(searchParam:succ:fail:)) | NS_SWIFT_NAME | |
| - (void) setGroupMemberInfo: | (NSString *) | groupID | |
| info: | (V2TIMGroupMemberFullInfo *) | info | |
| succ: | (_Nullable V2TIMSucc) | succ | |
| fail: | (setGroupMemberInfo(groupID:info:succ:fail:)) | NS_SWIFT_NAME | |
3.5 修改指定的群成员资料
| - (void) muteGroupMember: | (NSString *) | groupID | |
| member: | (NSString *) | userID | |
| muteTime: | (uint32_t) | seconds | |
| succ: | (_Nullable V2TIMSucc) | succ | |
| fail: | (muteGroupMember(groupID:memberUserID:muteTimeSeconds:succ:fail:)) | NS_SWIFT_NAME | |
3.6 禁言群成员(只有管理员或群主能够调用)
| seconds | 禁言时间长度,单位秒,表示调用该接口成功后多少秒内不允许被禁言用户再发言。 |
| - (void) muteAllGroupMembers: | (NSString *) | groupID | |
| isMute: | (BOOL) | isMute | |
| succ: | (_Nullable V2TIMSucc) | succ | |
| fail: | (muteAllGroupMembers(groupID:isMute:succ:fail:)) | NS_SWIFT_NAME | |
3.7 禁言全体群成员,只有管理员或群主能够调用(7.5 及以上版本支持)
| groupID | 群组 ID |
| isMute | YES 表示禁言,NO 表示解除禁言 |
| - (void) inviteUserToGroup: | (NSString *) | groupID | |
| userList: | (NSArray< NSString * > *) | userList | |
| succ: | (V2TIMGroupMemberOperationResultListSucc) | succ | |
| fail: | (inviteUserToGroup(groupID:userList:succ:fail:)) | NS_SWIFT_NAME | |
3.8 邀请他人入群
| - (void) kickGroupMember: | (NSString *) | groupID | |
| memberList: | (NSArray< NSString * > *) | memberList | |
| reason: | (NSString *_Nullable) | reason | |
| duration: | (uint32_t) | duration | |
| succ: | (V2TIMGroupMemberOperationResultListSucc) | succ | |
| fail: | (kickGroupMember(groupID:memberList:reason:duration:succ:fail:)) | NS_SWIFT_NAME | |
3.9 踢人
| groupID | 群 id |
| memberList | 被踢用户的 userID 列表 |
| reason | 被踢的原因 |
| duration | 指定自被踢出群组开始算起,禁止被踢用户重新申请加群的时长,单位:秒 |
| succ | 成功后的回调 |
| fail | 失败后的回调 |
| - (void) setGroupMemberRole: | (NSString *) | groupID | |
| member: | (NSString *) | userID | |
| newRole: | (uint32_t) | role | |
| succ: | (_Nullable V2TIMSucc) | succ | |
| fail: | (setGroupMemberRole(groupID:memberUserID:newRole:succ:fail:)) | NS_SWIFT_NAME | |
3.10 切换群成员的角色
| - (void) markGroupMemberList: | (NSString *) | groupID | |
| memberList: | (NSArray< NSString * > *) | memberList | |
| markType: | (uint32_t) | markType | |
| enableMark: | (BOOL) | enableMark | |
| succ: | (_Nullable V2TIMSucc) | succ | |
| fail: | (markGroupMemberList(groupID:memberList:markType:enableMark:succ:fail:)) | NS_SWIFT_NAME | |
3.11 标记群成员(需要您购买旗舰版套餐)
| groupID | 群 ID。 |
| memberList | 群成员 ID 列表。 |
| markType | 标记类型。数字类型,大于等于 1000,您可以自定义,一个群组里最多允许定义 10 个标记。 |
| enableMark | YES 表示添加标记,NO 表示移除标记。 |
| - (void) transferGroupOwner: | (NSString *) | groupID | |
| member: | (NSString *) | userID | |
| succ: | (_Nullable V2TIMSucc) | succ | |
| fail: | (transferGroupOwner(groupID:memberUserID:succ:fail:)) | NS_SWIFT_NAME | |
3.12 转让群主
| - (void) kickGroupMember: | (NSString *) | groupID | |
| memberList: | (NSArray< NSString * > *) | memberList | |
| reason: | (NSString *_Nullable) | reason | |
| succ: | (V2TIMGroupMemberOperationResultListSucc) | succ | |
| fail: | (V2TIMFail) | fail | |
3.13 踢人(直播群踢人从 6.6 版本开始支持,需要您购买旗舰版套餐)
| - (void) getGroupApplicationList: | (V2TIMGroupApplicationResultSucc) | succ | |
| fail: | (getGroupApplicationList(succ:fail:)) | NS_SWIFT_NAME | |
4.1 获取加群申请列表
| - (void) acceptGroupApplication: | (V2TIMGroupApplication *) | application | |
| reason: | (NSString *_Nullable) | reason | |
| succ: | (_Nullable V2TIMSucc) | succ | |
| fail: | (acceptGroupApplication(application:reason:succ:fail:)) | NS_SWIFT_NAME | |
4.2 同意某一条加群申请
| - (void) refuseGroupApplication: | (V2TIMGroupApplication *) | application | |
| reason: | (NSString *_Nullable) | reason | |
| succ: | (_Nullable V2TIMSucc) | succ | |
| fail: | (refuseGroupApplication(application:reason:succ:fail:)) | NS_SWIFT_NAME | |
4.3 拒绝某一条加群申请
| - (void) setGroupApplicationRead: | (_Nullable V2TIMSucc) | succ | |
| fail: | (setGroupApplicationRead(succ:fail:)) | NS_SWIFT_NAME | |
4.4 标记申请列表为已读