IMSDK
即时通信 IM 提供全球接入、单聊、群聊、消息推送、资料关系链托管、账号鉴权等全方位解决方案,并提供完备的 App 接入、后台管理接口。
V2TIMManager(Community)

构造函数

(void) - addCommunityListener:
 
(void) - removeCommunityListener:
 
(void) - createCommunity:memberList:succ:fail:
 
(void) - getJoinedCommunityList:fail:
 
(void) - createTopicInCommunity:topicInfo:succ:fail:
 
(void) - deleteTopicFromCommunity:topicIDList:succ:fail:
 
(void) - setTopicInfo:succ:fail:
 
(void) - getTopicInfoList:topicIDList:succ:fail:
 
(void) - createPermissionGroupInCommunity:succ:fail:
 
(void) - deletePermissionGroupFromCommunity:permissionGroupIDList:succ:fail:
 
(void) - modifyPermissionGroupInfoInCommunity:succ:fail:
 
(void) - getJoinedPermissionGroupListInCommunity:succ:fail:
 
(void) - getPermissionGroupListInCommunity:permissionGroupIDList:succ:fail:
 
(void) - addCommunityMembersToPermissionGroup:permissionGroupID:memberList:succ:fail:
 
(void) - removeCommunityMembersFromPermissionGroup:permissionGroupID:memberList:succ:fail:
 
(void) - getCommunityMemberListInPermissionGroup:permissionGroupID:nextCursor:succ:fail:
 
(void) - addTopicPermissionToPermissionGroup:permissionGroupID:topicPermissionMap:succ:fail:
 
(void) - deleteTopicPermissionFromPermissionGroup:permissionGroupID:topicIDList:succ:fail:
 
(void) - modifyTopicPermissionInPermissionGroup:permissionGroupID:topicPermissionMap:succ:fail:
 
(void) - getTopicPermissionInPermissionGroup:permissionGroupID:topicIDList:succ:fail:
 

Protected 类型

enum  V2TIMCommunityPermissionValue : NSInteger
 
enum  V2TIMTopicPermissionValue : NSInteger
 
typedef void(^ V2TIMTopicOperationResultSucc) (NSMutableArray< V2TIMTopicOperationResult * > *resultList)
 
typedef void(^ V2TIMTopicInfoResultListSucc) (NSMutableArray< V2TIMTopicInfoResult * > *resultList)
 
typedef void(^ V2TIMCreateTopicSucc) (NSString *topicID)
 
typedef void(^ V2TIMCreatePermissionGroupSucc) (NSString *permissionGroupID)
 
typedef void(^ V2TIMPermissionGroupOperationResultSucc) (NSMutableArray< V2TIMPermissionGroupOperationResult * > *resultList)
 
typedef void(^ V2TIMPermissionGroupInfoResultListSucc) (NSMutableArray< V2TIMPermissionGroupInfoResult * > *resultList)
 
typedef void(^ V2TIMPermissionGroupMemberOperationResultListSucc) (NSMutableArray< V2TIMPermissionGroupMemberOperationResult * > *resultList)
 
typedef void(^ V2TIMPermissionGroupMemberInfoResultListSucc) (NSString *nextCursor, NSMutableArray< V2TIMGroupMemberFullInfo * > *resultList)
 
typedef void(^ V2TIMTopicPermissionResultSucc) (NSMutableArray< V2TIMTopicPermissionResult * > *resultList)
 

成员类型定义说明

◆ V2TIMTopicOperationResultSucc

- (typedef void(^ V2TIMTopicOperationResultSucc) (NSMutableArray< V2TIMTopicOperationResult * > *resultList))
protected

操作话题列表结果

◆ V2TIMTopicInfoResultListSucc

- (typedef void(^ V2TIMTopicInfoResultListSucc) (NSMutableArray< V2TIMTopicInfoResult * > *resultList))
protected

获取话题列表结果

◆ V2TIMCreateTopicSucc

- (typedef void(^ V2TIMCreateTopicSucc) (NSString *topicID))
protected

创建话题成功回调

◆ V2TIMCreatePermissionGroupSucc

- (typedef void(^ V2TIMCreatePermissionGroupSucc) (NSString *permissionGroupID))
protected

创建权限组成功回调

◆ V2TIMPermissionGroupOperationResultSucc

- (typedef void(^ V2TIMPermissionGroupOperationResultSucc) (NSMutableArray< V2TIMPermissionGroupOperationResult * > *resultList))
protected

操作权限组结果

◆ V2TIMPermissionGroupInfoResultListSucc

- (typedef void(^ V2TIMPermissionGroupInfoResultListSucc) (NSMutableArray< V2TIMPermissionGroupInfoResult * > *resultList))
protected

获取权限组列表结果

◆ V2TIMPermissionGroupMemberOperationResultListSucc

- (typedef void(^ V2TIMPermissionGroupMemberOperationResultListSucc) (NSMutableArray< V2TIMPermissionGroupMemberOperationResult * > *resultList))
protected

操作权限组成员结果

◆ V2TIMPermissionGroupMemberInfoResultListSucc

- (typedef void(^ V2TIMPermissionGroupMemberInfoResultListSucc) (NSString *nextCursor, NSMutableArray< V2TIMGroupMemberFullInfo * > *resultList))
protected

获取权限组成员结果

◆ V2TIMTopicPermissionResultSucc

- (typedef void(^ V2TIMTopicPermissionResultSucc) (NSMutableArray< V2TIMTopicPermissionResult * > *resultList))
protected

获取话题权限结果

成员枚举类型说明

◆ V2TIMCommunityPermissionValue

- (enum V2TIMCommunityPermissionValue) :
protected

社群权限值

枚举值
V2TIM_COMMUNITY_PERMISSION_MANAGE_GROUP_INFO 

修改群资料权限。该位设置为0,表示没有该权限;设置为1,表示有该权限。

V2TIM_COMMUNITY_PERMISSION_MANAGE_GROUP_MEMBER 

群成员管理权限,包含踢人,进群审核、修改成员资料等。该位设置为0,表示没有该权限;设置为1,表示有该权限。

V2TIM_COMMUNITY_PERMISSION_MANAGE_PERMISSION_GROUP_INFO 

管理权限组资料权限。该位设置为0,表示没有该权限;设置为1,表示有该权限。权限包含创建、修改、删除权限组;在权限组中添加、修改、删除话题权限。

V2TIM_COMMUNITY_PERMISSION_MANAGE_PERMISSION_GROUP_MEMBER 

权限组成员管理权限,包含邀请成员进权限组和把成员从权限组踢出等。该位设置为0,表示没有该权限;设置为1,表示有该权限。

V2TIM_COMMUNITY_PERMISSION_MANAGE_TOPIC_IN_COMMUNITY 

话题管理权限,包含创建、修改、删除话题等。该位设置为0,表示没有该权限;设置为1,表示有该权限。

V2TIM_COMMUNITY_PERMISSION_MUTE_MEMBER 

对某群成员在社群下所有话题的禁言权限。该位设置为0,表示没有该权限;设置为1,表示有该权限。

V2TIM_COMMUNITY_PERMISSION_SEND_MESSAGE 

群成员在社群下所有话题的发消息权限。该位设置为0,表示没有该权限;设置为1,表示有该权限。

V2TIM_COMMUNITY_PERMISSION_AT_ALL 

在社群下所有话题发 at all 消息权限。该位设置为0,表示没有该权限;设置为1,表示有该权限。

V2TIM_COMMUNITY_PERMISSION_GET_HISTORY_MESSAGE 

在社群下所有话题拉取入群前的历史消息权限。该位设置为0,表示没有该权限;设置为1,表示有该权限。

V2TIM_COMMUNITY_PERMISSION_REVOKE_OTHER_MEMBER_MESSAGE 

在社群下所有话题撤回他人消息权限。该位设置为0,表示没有该权限;设置为1,表示有该权限。

V2TIM_COMMUNITY_PERMISSION_BAN_MEMBER 

封禁社群成员权限。该位设置为0,表示没有该权限;设置为1,表示有该权限。

◆ V2TIMTopicPermissionValue

- (enum V2TIMTopicPermissionValue) :
protected

话题权限值

枚举值
V2TIM_TOPIC_PERMISSION_MANAGE_TOPIC 

管理当前话题的权限,包括修改当前话题的资料、删除当前话题。该位设置为0,表示没有该权限;设置为1,表示有该权限

V2TIM_TOPIC_PERMISSION_MANAGE_TOPIC_PERMISSION 

在当前话题中管理话题权限,包括添加、修改、移除话题权限。该位设置为0,表示没有该权限;设置为1,表示有该权限

V2TIM_TOPIC_PERMISSION_MUTE_MEMBER 

在当前话题中禁言成员权限。该位设置为0,表示没有该权限;设置为1,表示有该权限

V2TIM_TOPIC_PERMISSION_SEND_MESSAGE 

在当前话题中发消息权限。该位设置为0,表示没有该权限;设置为1,表示有该权限

V2TIM_TOPIC_PERMISSION_GET_HISTORY_MESSAGE 

在当前话题中拉取入群前的历史消息权限。该位设置为0,表示没有该权限;设置为1,表示有该权限

V2TIM_TOPIC_PERMISSION_REVOKE_OTHER_MEMBER_MESSAGE 

在当前话题中撤回他人消息权限。该位设置为0,表示没有该权限;设置为1,表示有该权限

V2TIM_TOPIC_PERMISSION_AT_ALL 

在当前话题中发消息时有 at all 权限。该位设置为0,表示没有该权限;设置为1,表示有该权限

函数文档

◆ addCommunityListener:()

- (void) addCommunityListener: (addCommunityListener(listener:))  NS_SWIFT_NAME

1.1 添加社群监听器

◆ removeCommunityListener:()

- (void) removeCommunityListener: (removeCommunityListener(listener:))  NS_SWIFT_NAME

1.2 移除社群监听器

◆ createCommunity:memberList:succ:fail:()

- (void) createCommunity: (V2TIMGroupInfo *)  info
memberList: (NSArray< V2TIMCreateGroupMemberInfo * > *)  memberList
succ: (V2TIMCreateGroupSucc)  succ
fail: (V2TIMFail)  fail 

2.1 创建支持话题的社群

◆ getJoinedCommunityList:fail:()

- (void) getJoinedCommunityList: (V2TIMGroupInfoListSucc)  succ
fail: (V2TIMFail)  fail 

2.1 获取当前用户已经加入的支持话题的社群列表

◆ createTopicInCommunity:topicInfo:succ:fail:()

- (void) createTopicInCommunity: (NSString *)  groupID
topicInfo: (V2TIMTopicInfo *)  topicInfo
succ: (V2TIMCreateTopicSucc succ
fail: (V2TIMFail)  fail 

2.2 创建话题

参数
groupID社群 ID,必须以 @TGS_ 开头。

◆ deleteTopicFromCommunity:topicIDList:succ:fail:()

- (void) deleteTopicFromCommunity: (NSString *)  groupID
topicIDList: (NSArray< NSString * > *)  topicIDList
succ: (V2TIMTopicOperationResultSucc succ
fail: (V2TIMFail)  fail 

2.3 删除话题

◆ setTopicInfo:succ:fail:()

- (void) setTopicInfo: (V2TIMTopicInfo *)  topicInfo
succ: (V2TIMSucc)  succ
fail: (V2TIMFail)  fail 

2.4 修改话题信息

◆ getTopicInfoList:topicIDList:succ:fail:()

- (void) getTopicInfoList: (NSString *)  groupID
topicIDList: (NSArray< NSString * > *)  topicIDList
succ: (V2TIMTopicInfoResultListSucc succ
fail: (V2TIMFail)  fail 

2.5 获取话题列表。

注意
: topicIDList 传空时,获取此社群下的所有话题列表

◆ createPermissionGroupInCommunity:succ:fail:()

- (void) createPermissionGroupInCommunity: (V2TIMPermissionGroupInfo *)  permissionGroupInfo
succ: (V2TIMCreatePermissionGroupSucc succ
fail: (V2TIMFail)  fail 

3.1 创建社群权限组(7.8 及其以上版本支持)

注意
  • 该功能为旗舰版功能,需要您购买旗舰版套餐。

◆ deletePermissionGroupFromCommunity:permissionGroupIDList:succ:fail:()

- (void) deletePermissionGroupFromCommunity: (NSString *)  groupID
permissionGroupIDList: (NSArray< NSString * > *)  permissionGroupIDList
succ: (V2TIMPermissionGroupOperationResultSucc succ
fail: (V2TIMFail)  fail 

3.2 删除社群权限组(7.8 及其以上版本支持)

注意
  • 该功能为旗舰版功能,需要您购买旗舰版套餐。

◆ modifyPermissionGroupInfoInCommunity:succ:fail:()

- (void) modifyPermissionGroupInfoInCommunity: (V2TIMPermissionGroupInfo *)  permissionGroupInfo
succ: (V2TIMSucc)  succ
fail: (V2TIMFail)  fail 

3.3 修改社群权限组(7.8 及其以上版本支持)

注意
  • 该功能为旗舰版功能,需要您购买旗舰版套餐。

◆ getJoinedPermissionGroupListInCommunity:succ:fail:()

- (void) getJoinedPermissionGroupListInCommunity: (NSString *)  groupID
succ: (V2TIMPermissionGroupInfoResultListSucc succ
fail: (V2TIMFail)  fail 

3.4 获取已加入的社群权限组列表(7.8 及其以上版本支持)

注意
  • 该功能为旗舰版功能,需要您购买旗舰版套餐。

◆ getPermissionGroupListInCommunity:permissionGroupIDList:succ:fail:()

- (void) getPermissionGroupListInCommunity: (NSString *)  groupID
permissionGroupIDList: (NSArray< NSString * > *)  permissionGroupIDList
succ: (V2TIMPermissionGroupInfoResultListSucc succ
fail: (V2TIMFail)  fail 

3.5 获取社群权限组列表(7.8 及其以上版本支持)

注意
  • 该功能为旗舰版功能,需要您购买旗舰版套餐。
  • permissionGroupIDList 为空时,获取所有的权限组列表;不为空时,获取指定的权限组列表

◆ addCommunityMembersToPermissionGroup:permissionGroupID:memberList:succ:fail:()

- (void) addCommunityMembersToPermissionGroup: (NSString *)  groupID
permissionGroupID: (NSString *)  permissionGroupID
memberList: (NSArray< NSString * > *)  memberList
succ: (V2TIMPermissionGroupMemberOperationResultListSucc succ
fail: (V2TIMFail)  fail 

3.6 向社群权限组添加成员(7.7 及其以上版本支持)

注意
  • 该功能为旗舰版功能,需要您购买旗舰版套餐。

◆ removeCommunityMembersFromPermissionGroup:permissionGroupID:memberList:succ:fail:()

- (void) removeCommunityMembersFromPermissionGroup: (NSString *)  groupID
permissionGroupID: (NSString *)  permissionGroupID
memberList: (NSArray< NSString * > *)  memberList
succ: (V2TIMPermissionGroupMemberOperationResultListSucc succ
fail: (V2TIMFail)  fail 

3.7 从社群权限组删除成员(7.8 及其以上版本支持)

◆ getCommunityMemberListInPermissionGroup:permissionGroupID:nextCursor:succ:fail:()

- (void) getCommunityMemberListInPermissionGroup: (NSString *)  groupID
permissionGroupID: (NSString *)  permissionGroupID
nextCursor: (NSString *)  nextCursor
succ: (V2TIMPermissionGroupMemberInfoResultListSucc succ
fail: (V2TIMFail)  fail 

3.8 获取社群权限组成员列表(7.8 及其以上版本支持)

注意
  • 该功能为旗舰版功能,需要您购买旗舰版套餐。

◆ addTopicPermissionToPermissionGroup:permissionGroupID:topicPermissionMap:succ:fail:()

- (void) addTopicPermissionToPermissionGroup: (NSString *)  groupID
permissionGroupID: (NSString *)  permissionGroupID
topicPermissionMap: (NSDictionary< NSString *, NSNumber * > *)  topicPermissionMap
succ: (V2TIMTopicOperationResultSucc succ
fail: (V2TIMFail)  fail 

3.9 向权限组添加话题权限(7.8 及其以上版本支持)

注意
  • 该功能为旗舰版功能,需要您购买旗舰版套餐。

◆ deleteTopicPermissionFromPermissionGroup:permissionGroupID:topicIDList:succ:fail:()

- (void) deleteTopicPermissionFromPermissionGroup: (NSString *)  groupID
permissionGroupID: (NSString *)  permissionGroupID
topicIDList: (NSArray< NSString * > *)  topicIDList
succ: (V2TIMTopicOperationResultSucc succ
fail: (V2TIMFail)  fail 

3.10 从权限组中删除话题权限(7.8 及其以上版本支持)

注意
  • 该功能为旗舰版功能,需要您购买旗舰版套餐。

◆ modifyTopicPermissionInPermissionGroup:permissionGroupID:topicPermissionMap:succ:fail:()

- (void) modifyTopicPermissionInPermissionGroup: (NSString *)  groupID
permissionGroupID: (NSString *)  permissionGroupID
topicPermissionMap: (NSDictionary< NSString *, NSNumber * > *)  topicPermissionMap
succ: (V2TIMTopicOperationResultSucc succ
fail: (V2TIMFail)  fail 

3.11 修改权限组中的话题权限(7.8 及其以上版本支持)

注意
  • 该功能为旗舰版功能,需要您购买旗舰版套餐。

◆ getTopicPermissionInPermissionGroup:permissionGroupID:topicIDList:succ:fail:()

- (void) getTopicPermissionInPermissionGroup: (NSString *)  groupID
permissionGroupID: (NSString *)  permissionGroupID
topicIDList: (NSArray< NSString * > *)  topicIDList
succ: (V2TIMTopicPermissionResultSucc succ
fail: (V2TIMFail)  fail 

3.12 获取权限组中的话题权限(7.8 及其以上版本支持)

注意
  • 该功能为旗舰版功能,需要您购买旗舰版套餐。