|
protected |
Callback definition on get the list of groups that the current user has joined.
|
protected |
Callback definition on get specified group profiles.
|
protected |
Callback definition on get specified group attributes.
|
protected |
Callback definition on get the group member list.
|
protected |
Callback definition on get the profiles of specified group members.
|
protected |
Callback definition on search group members.
|
protected |
Callback definition for operations related to group members.
|
protected |
Callback definition on get group joining request list.
|
protected |
Callback definition on get the number of online members of a group.
|
protected |
Callback definition on operation topic.
|
protected |
Callback definition on get topic info list.
|
protected |
Callback definition on create topic.
|
protected |
Callback definition on operate group counters.
|
protected |
|
protected |
Enumeration definition of operation result related to group members.
|
protected |
|
protected |
Enumeration definition of group request type.
|
protected |
|
protected |
- (void) createGroup: | (V2TIMGroupInfo *) | info | |
memberList: | (NSArray< V2TIMCreateGroupMemberInfo * > *) | memberList | |
succ: | (V2TIMCreateGroupSucc) | succ | |
fail: | (V2TIMFail) | fail | |
1.1 Create a custom group (the advanced version API allows you to specify initial group members)
info | Custom group information, including the groupID, groupType, groupName, notification, introduction, and faceURL fields |
memberList | Specify initial group members (Audio-video groups do not support specifying initial group members. Pass in null for memberList.) |
- (void) getJoinedGroupList: | (V2TIMGroupInfoListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
1.2 Get the list of groups that the current user has joined
- (void) getGroupsInfo: | (NSArray< NSString * > *) | groupIDList | |
succ: | (V2TIMGroupInfoResultListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.1 Pull group profiles
groupIDList | List of group IDs |
- (void) searchGroups: | (V2TIMGroupSearchParam *) | searchParam | |
succ: | (V2TIMGroupInfoListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.2 Search for group profiles (supported only in 5.4.666 and later versions and need to buy Flagship Edition)
This API will search all the groups whose group name is included in the keyword list specifed in searchParam and return the group profiles list. The keyword list supports up to 5 keywords.
- (void) setGroupInfo: | (V2TIMGroupInfo *) | info | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.3 Modify group profiles
- (void) initGroupAttributes: | (NSString *) | groupID | |
attributes: | (NSDictionary< NSString *, NSString * > *) | attributes | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.4 Initialize group attributes (this operation will clear the existing group attribute list)
- (void) setGroupAttributes: | (NSString *) | groupID | |
attributes: | (NSDictionary< NSString *, NSString * > *) | attributes | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.5 Set group attributes. (If the group attributes already exist, their values are updated. Otherwise, the group attributes are added.)
- (void) deleteGroupAttributes: | (NSString *) | groupID | |
keys: | (NSArray< NSString * > *) | keys | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.6 Delete specified group attributes (If null is passed in for keys, all group attributes are cleared.)
- (void) getGroupAttributes: | (NSString *) | groupID | |
keys: | (NSArray< NSString * > *) | keys | |
succ: | (V2TIMGroupAttributeListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.7 Get specified group attributes (If null is passed in for keys, all group attributes are obtained.)
- (void) getGroupOnlineMemberCount: | (NSString *) | groupID | |
succ: | (V2TIMGroupOnlineMemberCountSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.8 Get the number of online members of a group
- (void) setGroupCounters: | (NSString *) | groupID | |
counters: | (NSDictionary< NSString *, NSNumber * > *) | counters | |
succ: | (V2TIMGroupCounterResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.9 Set group counters (supported only in 7.0 and later versions)
- (void) getGroupCounters: | (NSString *) | groupID | |
keys: | (NSArray< NSString * > *) | keys | |
succ: | (V2TIMGroupCounterResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.10 Get group counters (supported only in 7.0 and later versions)
- (void) increaseGroupCounter: | (NSString *) | groupID | |
key: | (NSString *) | key | |
value: | (NSInteger) | value | |
succ: | (V2TIMGroupCounterResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.11 Increase group counters (supported only in 7.0 and later versions)
groupID | Group ID |
key | The key of counter |
value | Increment of group counter, the value will be updated as new_value = old_value + value. |
succ | Callback of success,returns the value of the current counter after increment |
fail | Callback of failure |
- (void) decreaseGroupCounter: | (NSString *) | groupID | |
key: | (NSString *) | key | |
value: | (NSInteger) | value | |
succ: | (V2TIMGroupCounterResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
2.12 Decrease group counters (supported only in 7.0 and later versions)
groupID | Group ID |
key | The key of counter |
value | Decrement of group counter, the value will be updated as new_value = old_value - value. |
succ | Callback of success,returns the value of the current counter after decrement |
fail | Callback of failure |
- (void) getGroupMemberList: | (NSString *) | groupID | |
filter: | (uint32_t) | filter | |
nextSeq: | (uint64_t) | nextSeq | |
succ: | (V2TIMGroupMemberInfoResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.1 Get the group member list
filter | Specify the group member type. |
nextSeq | Pulling-by-page flag. It is set to 0 when the information is pulled for the first time. If the callback succeeds and nextSeq is not 0, pagination is needed. The value of this field is passed in for the next pull until the value becomes 0. |
- (void) getGroupMembersInfo: | (NSString *) | groupID | |
memberList: | (NSArray< NSString * > *) | memberList | |
succ: | (V2TIMGroupMemberInfoListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.2 Get the profiles of specified group members
- (void) searchGroupMembers: | (V2TIMGroupMemberSearchParam *) | searchParam | |
succ: | (V2TIMGroupMemberInfoListSearchSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.3 Search for group members (supported only in 5.4.666 and later versions and need to buy Flagship Edition)
searchParam | Search parameters |
- (void) setGroupMemberInfo: | (NSString *) | groupID | |
info: | (V2TIMGroupMemberFullInfo *) | info | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.4 Modify the profiles of specified group members
- (void) muteGroupMember: | (NSString *) | groupID | |
member: | (NSString *) | userID | |
muteTime: | (uint32_t) | seconds | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.5 Mute (this API can be called by the admin or group owner)
seconds | Time period in seconds from calling this API which indicates how many seconds the mute user will be forbidden to speak. |
- (void) inviteUserToGroup: | (NSString *) | groupID | |
userList: | (NSArray< NSString * > *) | userList | |
succ: | (V2TIMGroupMemberOperationResultListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.6 Invite users to a group
- (void) kickGroupMember: | (NSString *) | groupID | |
memberList: | (NSArray< NSString * > *) | memberList | |
reason: | (NSString *) | reason | |
duration: | (uint32_t) | duration | |
succ: | (V2TIMGroupMemberOperationResultListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.7 Remove a member from a group
groupID | Group ID |
memberList | The member list of kicked off |
reason | The reason why the member needed to kick off |
duration | Time interval during which the target users will not be allowed to join the group again after being kicked out of the group in seconds |
succ | Callback of success |
fail | Callback of failure |
- (void) setGroupMemberRole: | (NSString *) | groupID | |
member: | (NSString *) | userID | |
newRole: | (uint32_t) | role | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.8 Set the role of a group member
- (void) markGroupMemberList: | (NSString *) | groupID | |
memberList: | (NSArray< NSString * > *) | memberList | |
markType: | (uint32_t) | markType | |
enableMark: | (BOOL) | enableMark | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.9 Mark group member(supported only in 6.6 and later versions and need to buy Flagship Edition)
groupID | Group's identifier. |
memberList | Group member's identifier list. |
markType | The mark type is uint32_t, and the value must be equal or greater than 1000. You can customize it. A maximum of 10 marks are allowed to be defined in an AVChatRoom. |
enableMark | Set or remove. YES means setting the mark, and NO means removing the mark. |
- (void) transferGroupOwner: | (NSString *) | groupID | |
member: | (NSString *) | userID | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.10 Change the group owner
- (void) kickGroupMember: | (NSString *) | groupID | |
memberList: | (NSArray< NSString * > *) | memberList | |
reason: | (NSString *) | reason | |
succ: | (V2TIMGroupMemberOperationResultListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
3.11 Remove a member from a group(Removing a member from AVChatRoom is supported only in 6.6 and later versions and need to buy Flagship Edition)
- (void) getGroupApplicationList: | (V2TIMGroupApplicationResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
4.1 Get the group joining request list
- (void) acceptGroupApplication: | (V2TIMGroupApplication *) | application | |
reason: | (NSString *) | reason | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
4.2 Approve a group joining request
- (void) refuseGroupApplication: | (V2TIMGroupApplication *) | application | |
reason: | (NSString *) | reason | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
4.3 Reject a group joining request
- (void) setGroupApplicationRead: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
4.4 Mark the group joining request list as read
- (void) getJoinedCommunityList: | (V2TIMGroupInfoListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
5.1 Get the list of Community-groups that the current user has joined
- (void) createTopicInCommunity: | (NSString *) | groupID | |
topicInfo: | (V2TIMTopicInfo *) | topicInfo | |
succ: | (V2TIMCreateTopicSucc) | succ | |
fail: | (V2TIMFail) | fail | |
5.2 Create topic
- (void) deleteTopicFromCommunity: | (NSString *) | groupID | |
topicIDList: | (NSArray< NSString * > *) | topicIDList | |
succ: | (V2TIMTopicOperationResultSucc) | succ | |
fail: | (V2TIMFail) | fail | |
5.3 Delete topic
- (void) setTopicInfo: | (V2TIMTopicInfo *) | topicInfo | |
succ: | (V2TIMSucc) | succ | |
fail: | (V2TIMFail) | fail | |
5.4 Modify topic information
- (void) getTopicInfoList: | (NSString *) | groupID | |
topicIDList: | (NSArray< NSString * > *) | topicIDList | |
succ: | (V2TIMTopicInfoResultListSucc) | succ | |
fail: | (V2TIMFail) | fail | |
5.5 Get topic list