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.
V2TIMFriendship.h File Reference

Data Structures

struct  V2TIMUserInfo
 
struct  V2TIMUserFullInfo
 
struct  V2TIMUserStatus
 
struct  V2TIMFriendInfo
 
struct  V2TIMFriendInfoResult
 
struct  V2TIMFriendAddApplication
 
struct  V2TIMFriendApplication
 
struct  V2TIMFriendApplicationResult
 
struct  V2TIMFriendCheckResult
 
struct  V2TIMFriendOperationResult
 
struct  V2TIMFriendGroup
 
struct  V2TIMFriendSearchParam
 
struct  V2TIMFollowOperationResult
 
struct  V2TIMUserInfoResult
 
struct  V2TIMFollowInfo
 
struct  V2TIMFollowTypeCheckResult
 

Typedefs

typedef TXV2TIMUserInfoVector V2TIMUserInfoVector
 
typedef TXV2TIMUserFullInfoVector V2TIMUserFullInfoVector
 
typedef TXV2TIMUserStatusVector V2TIMUserStatusVector
 
typedef TXV2TIMFriendInfoVector V2TIMFriendInfoVector
 
typedef TXV2TIMFriendInfoResultVector V2TIMFriendInfoResultVector
 
typedef TXV2TIMFriendApplicationVector V2TIMFriendApplicationVector
 
typedef TXV2TIMFriendCheckResultVector V2TIMFriendCheckResultVector
 
typedef TXV2TIMFriendOperationResultVector V2TIMFriendOperationResultVector
 
typedef TXV2TIMFriendGroupVector V2TIMFriendGroupVector
 
typedef TXV2TIMFollowOperationResultVector V2TIMFollowOperationResultVector
 
typedef TXV2TIMFollowInfoVector V2TIMFollowInfoVector
 
typedef TXV2TIMFollowTypeCheckResultVector V2TIMFollowTypeCheckResultVector
 

Enumerations

enum  V2TIMUserStatusType
 
enum  V2TIMGender
 
enum  V2TIMFriendAllowType
 
enum  V2TIMFriendApplicationType
 
enum  V2TIMFriendType
 
enum  V2TIMFriendRelationType
 
enum  V2TIMFriendAcceptType
 
enum  V2TIMUserInfoModifyFlag
 
enum  V2TIMFriendInfoModifyFlag
 
enum  V2TIMFollowType
 

Typedef Documentation

◆ V2TIMUserInfoVector

typedef TXV2TIMUserInfoVector V2TIMUserInfoVector

◆ V2TIMUserFullInfoVector

typedef TXV2TIMUserFullInfoVector V2TIMUserFullInfoVector

◆ V2TIMUserStatusVector

typedef TXV2TIMUserStatusVector V2TIMUserStatusVector

◆ V2TIMFriendInfoVector

typedef TXV2TIMFriendInfoVector V2TIMFriendInfoVector

◆ V2TIMFriendInfoResultVector

typedef TXV2TIMFriendInfoResultVector V2TIMFriendInfoResultVector

◆ V2TIMFriendApplicationVector

typedef TXV2TIMFriendApplicationVector V2TIMFriendApplicationVector

◆ V2TIMFriendCheckResultVector

typedef TXV2TIMFriendCheckResultVector V2TIMFriendCheckResultVector

◆ V2TIMFriendOperationResultVector

typedef TXV2TIMFriendOperationResultVector V2TIMFriendOperationResultVector

◆ V2TIMFriendGroupVector

typedef TXV2TIMFriendGroupVector V2TIMFriendGroupVector

◆ V2TIMFollowOperationResultVector

typedef TXV2TIMFollowOperationResultVector V2TIMFollowOperationResultVector

◆ V2TIMFollowInfoVector

typedef TXV2TIMFollowInfoVector V2TIMFollowInfoVector

◆ V2TIMFollowTypeCheckResultVector

typedef TXV2TIMFollowTypeCheckResultVector V2TIMFollowTypeCheckResultVector

Enumeration Type Documentation

◆ V2TIMUserStatusType

Enumeration definition of user status type.

Enumerator
V2TIM_USER_STATUS_UNKNOWN 

Unknown status.

V2TIM_USER_STATUS_ONLINE 

Online status.

V2TIM_USER_STATUS_OFFLINE 

Offline status.

V2TIM_USER_STATUS_UNLOGINED 

Unlogined status (such as logout or registering)

◆ V2TIMGender

Gender.

Enumerator
V2TIM_GENDER_UNKNOWN 

Unknown gender.

V2TIM_GENDER_MALE 

Male.

V2TIM_GENDER_FEMALE 

Female.

◆ V2TIMFriendAllowType

Friend verification method.

Enumerator
V2TIM_FRIEND_ALLOW_ANY 

Automatically accept all new friend requests.

V2TIM_FRIEND_NEED_CONFIRM 

Friend request verification is required.

V2TIM_FRIEND_DENY_ANY 

Automatically reject all new friend requests.

◆ V2TIMFriendApplicationType

Friend request type.

Enumerator
V2TIM_FRIEND_APPLICATION_COME_IN 

Friend request received by me.

V2TIM_FRIEND_APPLICATION_SEND_OUT 

Friend request sent by me.

V2TIM_FRIEND_APPLICATION_BOTH 

Friend requests received and sent by me. Valid only during pulling.

◆ V2TIMFriendType

Friend type.

Enumerator
V2TIM_FRIEND_TYPE_SINGLE 

One-way friend.

V2TIM_FRIEND_TYPE_BOTH 

Two-way friend.

◆ V2TIMFriendRelationType

Relation type.

Enumerator
V2TIM_FRIEND_RELATION_TYPE_NONE 

Not a friend.

V2TIM_FRIEND_RELATION_TYPE_IN_MY_FRIEND_LIST 

The peer party is on my friend list.

V2TIM_FRIEND_RELATION_TYPE_IN_OTHER_FRIEND_LIST 

I am on the peer party's friend list.

V2TIM_FRIEND_RELATION_TYPE_BOTH_WAY 

Two-way friend.

◆ V2TIMFriendAcceptType

Friend acception type.

Enumerator
V2TIM_FRIEND_ACCEPT_AGREE 

Accept the friend request (build a one-way friend relationship)

V2TIM_FRIEND_ACCEPT_AGREE_AND_ADD 

Accept the friend request and add the peer party as a friend (build a two-way friend relationship)

◆ V2TIMUserInfoModifyFlag

User Info modify flag.

Enumerator
V2TIM_USER_INFO_MODIFY_FLAG_UNKNOWN 

unknown

V2TIM_USER_INFO_MODIFY_FLAG_NICK 

nick name

V2TIM_USER_INFO_MODIFY_FLAG_FACE_URL 

face URL

V2TIM_USER_INFO_MODIFY_FLAG_GENDER 

gender

V2TIM_USER_INFO_MODIFY_FLAG_BIRTHDAY 

birthdsay

V2TIM_USER_INFO_MODIFY_FLAG_SELF_SIGNATURE 

self signature

V2TIM_USER_INFO_MODIFY_FLAG_LEVEL 

lever

V2TIM_USER_INFO_MODIFY_FLAG_ROLE 

role

V2TIM_USER_INFO_MODIFY_FLAG_ALLOW_TYPE 

allow type

V2TIM_USER_INFO_MODIFY_FLAG_CUSTOM 

custom field

◆ V2TIMFriendInfoModifyFlag

Friend Info modify flag.

Enumerator
V2TIM_FRIEND_INFO_MODIFY_FLAG_UNKNOWN 

unknown

V2TIM_FRIEND_INFO_MODIFY_FLAG_REMARK 

friend remark

V2TIM_FRIEND_INFO_MODIFY_FLAG_CUSTOM 

friend custom field

◆ V2TIMFollowType

Enumeration definition of follow type.

Enumerator
V2TIM_FOLLOW_TYPE_NONE 

No relationship of following.

V2TIM_FOLLOW_TYPE_IN_MY_FOLLOWING_LIST 

The peer party is in my following list.

V2TIM_FOLLOW_TYPE_IN_MY_FOLLOWERS_LIST 

The peer party is in my followers list.

V2TIM_FOLLOW_TYPE_IN_BOTH_FOLLOWERS_LIST 

The peer party and I are mutually following each other.