IMSDK
IM features a comprehensive suite of solutions including global access, one-to-one chat, group chat, message push, profile and relationship chain hosting, and account authentication. It also provides complete app access and backend management APIs.
V2TIMGroup.h File Reference

Data Structures

struct  V2TIMGroupMemberInfo
 
struct  V2TIMGroupMemberFullInfo
 
struct  V2TIMGroupMemberInfoResult
 
struct  V2TIMGroupChangeInfo
 
struct  V2TIMGroupMemberChangeInfo
 
struct  V2TIMGroupAtInfo
 
struct  V2TIMGroupInfo
 
struct  V2TIMGroupInfoResult
 
struct  V2TIMGroupApplication
 
struct  V2TIMGroupMemberOperationResult
 
struct  V2TIMCreateGroupMemberInfo
 
struct  V2TIMGroupApplicationResult
 
struct  V2TIMGroupSearchParam
 
struct  V2TIMGroupMemberSearchParam
 

Typedefs

typedef TXV2TIMGroupMemberInfoVector V2TIMGroupMemberInfoVector
 
typedef TXV2TIMGroupMemberFullInfoVector V2TIMGroupMemberFullInfoVector
 
typedef TXV2TIMGroupChangeInfoVector V2TIMGroupChangeInfoVector
 
typedef TXV2TIMGroupMemberChangeInfoVector V2TIMGroupMemberChangeInfoVector
 
typedef TXV2TIMGroupAtInfoVector V2TIMGroupAtInfoVector
 
typedef TXV2TIMGroupInfoVector V2TIMGroupInfoVector
 
typedef TXV2TIMGroupInfoResultVector V2TIMGroupInfoResultVector
 
typedef TXV2TIMGroupApplicationVector V2TIMGroupApplicationVector
 
typedef TXV2TIMGroupMemberOperationResultVector V2TIMGroupMemberOperationResultVector
 
typedef TXV2TIMCreateGroupMemberInfoVector V2TIMCreateGroupMemberInfoVector
 
typedef TXV2TIMStringToV2TIMGroupMemberFullInfoVectorMap V2TIMGroupSearchGroupMembersMap
 

Enumerations

enum  V2TIMGroupMemberRole
 
enum  V2TIMGroupInfoChangeType
 
enum  V2TIMGroupAddOpt
 
enum  V2TIMGroupInfoModifyFlag
 
enum  V2TIMGroupMemberResult
 
enum  V2TIMGroupMemberFilter
 
enum  V2TIMGroupMemberInfoModifyFlag
 
enum  V2TIMGroupApplicationType
 
enum  V2TIMGroupApplicationHandleStatus
 
enum  V2TIMGroupApplicationHandleResult
 
enum  V2TIMGroupAtType
 

Typedef Documentation

◆ V2TIMGroupMemberInfoVector

typedef TXV2TIMGroupMemberInfoVector V2TIMGroupMemberInfoVector

◆ V2TIMGroupMemberFullInfoVector

typedef TXV2TIMGroupMemberFullInfoVector V2TIMGroupMemberFullInfoVector

◆ V2TIMGroupChangeInfoVector

typedef TXV2TIMGroupChangeInfoVector V2TIMGroupChangeInfoVector

◆ V2TIMGroupMemberChangeInfoVector

typedef TXV2TIMGroupMemberChangeInfoVector V2TIMGroupMemberChangeInfoVector

◆ V2TIMGroupAtInfoVector

typedef TXV2TIMGroupAtInfoVector V2TIMGroupAtInfoVector

◆ V2TIMGroupInfoVector

typedef TXV2TIMGroupInfoVector V2TIMGroupInfoVector

◆ V2TIMGroupInfoResultVector

typedef TXV2TIMGroupInfoResultVector V2TIMGroupInfoResultVector

◆ V2TIMGroupApplicationVector

typedef TXV2TIMGroupApplicationVector V2TIMGroupApplicationVector

◆ V2TIMGroupMemberOperationResultVector

typedef TXV2TIMGroupMemberOperationResultVector V2TIMGroupMemberOperationResultVector

◆ V2TIMCreateGroupMemberInfoVector

typedef TXV2TIMCreateGroupMemberInfoVector V2TIMCreateGroupMemberInfoVector

◆ V2TIMGroupSearchGroupMembersMap

typedef TXV2TIMStringToV2TIMGroupMemberFullInfoVectorMap V2TIMGroupSearchGroupMembersMap

SearchGroupMembers Result.

Enumeration Type Documentation

◆ V2TIMGroupMemberRole

Group member role.

Enumerator
V2TIM_GROUP_MEMBER_UNDEFINED 

Undefined (this field is not obtained)

V2TIM_GROUP_MEMBER_ROLE_MEMBER 

Group member.

V2TIM_GROUP_MEMBER_ROLE_ADMIN 

Group admin.

V2TIM_GROUP_MEMBER_ROLE_SUPER 

Group owner.

◆ V2TIMGroupInfoChangeType

Change type to group information.

Enumerator
V2TIM_GROUP_INFO_CHANGE_TYPE_NAME 

Change the group name.

V2TIM_GROUP_INFO_CHANGE_TYPE_INTRODUCTION 

Modify the group introduction.

V2TIM_GROUP_INFO_CHANGE_TYPE_NOTIFICATION 

Modify the group notice.

V2TIM_GROUP_INFO_CHANGE_TYPE_FACE 

Modify the group profile photo.

V2TIM_GROUP_INFO_CHANGE_TYPE_OWNER 

Change the group owner.

V2TIM_GROUP_INFO_CHANGE_TYPE_CUSTOM 

Change the custom group field.

V2TIM_GROUP_INFO_CHANGE_TYPE_SHUT_UP_ALL 

Change the group muting field.

V2TIM_GROUP_INFO_CHANGE_TYPE_TOPIC_CUSTOM_DATA 

Change the topic custom data field.

V2TIM_GROUP_INFO_CHANGE_TYPE_RECEIVE_MESSAGE_OPT 

Change the group message receive option field.

V2TIM_GROUP_INFO_CHANGE_TYPE_GROUP_ADD_OPT 

In the mode of applying to join the group, the administrator approval option has changed.

V2TIM_GROUP_INFO_CHANGE_TYPE_GROUP_APPROVE_OPT 

In the mode of inviting into the group, the administrator's approval option has changed.

V2TIM_GROUP_INFO_CHANGE_TYPE_ENABLE_PERMISSION_GROUP 

Change the enable permission group field, only supports community from 7.8 version.

V2TIM_GROUP_INFO_CHANGE_TYPE_DEFAULT_PERMISSIONS 

Change the group default permissions field, only supports community from 7.8 version.

◆ V2TIMGroupAddOpt

Group joining approval type.

Enumerator
V2TIM_GROUP_ADD_FORBID 

Forbid anyone to join the group.

V2TIM_GROUP_ADD_AUTH 

Require admin approval.

V2TIM_GROUP_ADD_ANY 

Anyone can join.

V2TIM_GROUP_ADD_UNKNOWN 

Unknown option.

◆ V2TIMGroupInfoModifyFlag

Group info modification flag.

Enumerator
V2TIM_GROUP_INFO_MODIFY_FLAG_UNKNOWN 

Unknown.

V2TIM_GROUP_INFO_MODIFY_FLAG_GROUP_NAME 

Group name.

V2TIM_GROUP_INFO_MODIFY_FLAG_NOTIFICATION 

Group notification.

V2TIM_GROUP_INFO_MODIFY_FLAG_INTRODUCTION 

Group introduction.

V2TIM_GROUP_INFO_MODIFY_FLAG_FACE_URL 

Group avatar.

V2TIM_GROUP_INFO_MODIFY_FLAG_GROUP_ADD_OPTION 

In the mode of applying to join the group, the administrator approval option has changed.

V2TIM_GROUP_INFO_MODIFY_FLAG_SHUTUP_ALL 

Mute all gorup members.

V2TIM_GROUP_INFO_MODIFY_FLAG_CUSTOM_INFO 

Group info custom data.

V2TIM_TOPIC_INFO_MODIFY_FLAG_CUSTOM_STRING 

Topic info custom data.

V2TIM_GROUP_INFO_MODIFY_FLAG_GROUP_APPROVE_OPTION 

In the mode of inviting into the group, the administrator's approval option has changed.

V2TIM_GROUP_INFO_MODIFY_FLAG_ENABLE_PERMISSION_GROUP 

Enable permission group field, only supports community from 7.8 version.

V2TIM_GROUP_INFO_MODIFY_FLAG_DEFAULT_PERMISSIONS 

Group default permissions field, only supports community from 7.8 version.

◆ V2TIMGroupMemberResult

Operation result related to group members.

Enumerator
V2TIM_GROUP_MEMBER_RESULT_FAIL 

Operation failed.

V2TIM_GROUP_MEMBER_RESULT_SUCC 

Operation succeeded.

V2TIM_GROUP_MEMBER_RESULT_INVALID 

Invalid operation: already in the group when being added to the group, or not in the group when being removed from the group.

V2TIM_GROUP_MEMBER_RESULT_PENDING 

To be processed: waiting to be approved when being invited to join a group.

V2TIM_GROUP_MEMBER_RESULT_OVERLIMIT 

Operation failed: when specifying the initial group member list or inviting a user to join the group during group creation, the total number of groups that the invitee joins exceeds the limit.

◆ V2TIMGroupMemberFilter

Filter type for group members.

Enumerator
V2TIM_GROUP_MEMBER_FILTER_ALL 

All group members.

V2TIM_GROUP_MEMBER_FILTER_OWNER 

Group owner.

V2TIM_GROUP_MEMBER_FILTER_ADMIN 

Group admin.

V2TIM_GROUP_MEMBER_FILTER_COMMON 

Group member.

◆ V2TIMGroupMemberInfoModifyFlag

Group member data modification flag.

Enumerator
V2TIM_GROUP_MEMBER_INFO_MODIFY_FLAG_UNKNOWN 

Unknown.

V2TIM_GROUP_MEMBER_INFO_MODIFY_FLAG_MEMBER_ROLE 

Group member role.

V2TIM_GROUP_MEMBER_INFO_MODIFY_FLAG_SHUTUP_TIME 

Mute time.

V2TIM_GROUP_MEMBER_INFO_MODIFY_FLAG_NAME_CARD 

Group name card.

V2TIM_GROUP_MEMBER_INFO_MODIFY_FLAG_CUSTOM_INFO 

Group member custom data.

◆ V2TIMGroupApplicationType

Group request type.

Enumerator
V2TIM_GROUP_JOIN_APPLICATION_NEED_APPROVED_BY_ADMIN 

Request to join a group and need for administer or group owner's approval.

V2TIM_GROUP_INVITE_APPLICATION_NEED_APPROVED_BY_INVITEE 

Be invited to join a group and need for invitee's approval.

V2TIM_GROUP_INVITE_APPLICATION_NEED_APPROVED_BY_ADMIN 

Be invited to join a group and need for administer or group owner's approval.

◆ V2TIMGroupApplicationHandleStatus

Processing status for group request.

Enumerator
V2TIM_GROUP_APPLICATION_HANDLE_STATUS_UNHANDLED 

Not handled.

V2TIM_GROUP_APPLICATION_HANDLE_STATUS_HANDLED_BY_OTHER 

Handled by others.

V2TIM_GROUP_APPLICATION_HANDLE_STATUS_HANDLED_BY_SELF 

Handled by yourself.

◆ V2TIMGroupApplicationHandleResult

Process result for group request.

Enumerator
V2TIM_GROUP_APPLICATION_HANDLE_RESULT_REFUSE 

Reject a request.

V2TIM_GROUP_APPLICATION_HANDLE_RESULT_AGREE 

Accept a request.

◆ V2TIMGroupAtType

@ type

Enumerator
V2TIM_AT_ME 

@me

V2TIM_AT_ALL 

@all

V2TIM_AT_ALL_AT_ME 

@all in the group and @me alone