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

Data Structures

struct  V2TIMOfflinePushConfig
 
struct  V2TIMOfflinePushInfo
 
class  V2TIMValueCallback< T >
 
struct  V2TIMMessage
 
struct  V2TIMElem
 
struct  V2TIMTextElem
 
struct  V2TIMCustomElem
 
struct  V2TIMImage
 
struct  V2TIMImageElem
 
struct  V2TIMSoundElem
 
struct  V2TIMVideoElem
 
struct  V2TIMFileElem
 
struct  V2TIMLocationElem
 
struct  V2TIMFaceElem
 
struct  V2TIMMergerElem
 
struct  V2TIMGroupTipsElem
 
struct  V2TIMMessageReceipt
 
struct  V2TIMGroupMessageReadMemberList
 
struct  V2TIMReceiveMessageOptInfo
 
struct  V2TIMMessageSearchParam
 
struct  V2TIMMessageSearchResultItem
 
struct  V2TIMMessageSearchResult
 
struct  V2TIMMessageListGetOption
 
struct  V2TIMMessageExtension
 
struct  V2TIMMessageExtensionResult
 
struct  V2TIMMessageReaction
 
struct  V2TIMMessageReactionResult
 
struct  V2TIMMessageReactionUserResult
 
struct  V2TIMMessageReactionChangeInfo
 

Macros

#define kIOSOfflinePushNoSound   "push.no_sound"
 
#define kIOSOfflinePushDefaultSound   "default"
 
#define kImSDK_MesssageAtALL   "__kImSDK_MesssageAtALL__"
 

Typedefs

typedef TXV2TIMElemTypeVector V2TIMElemTypeVector
 
typedef TXPV2TIMElemVector V2TIMElemVector
 
typedef TXV2TIMMessageVector V2TIMMessageVector
 
typedef TXV2TIMImageVector V2TIMImageVector
 
typedef TXV2TIMMessageReceiptVector V2TIMMessageReceiptVector
 
typedef TXV2TIMReceiveMessageOptInfoVector V2TIMReceiveMessageOptInfoVector
 
typedef TXV2TIMMessageSearchResultItemVector V2TIMMessageSearchResultItemVector
 
typedef TXV2TIMMessageExtensionVector V2TIMMessageExtensionVector
 
typedef TXV2TIMMessageExtensionResultVector V2TIMMessageExtensionResultVector
 
typedef TXV2TIMMessageReactionVector V2TIMMessageReactionVector
 
typedef TXV2TIMMessageReactionResultVector V2TIMMessageReactionResultVector
 
typedef TXV2TIMMessageReactionChangeInfoVector V2TIMMessageReactionChangeInfoVector
 

Enumerations

enum  V2TIMMessagePriority
 
enum  V2TIMMessageStatus
 
enum  V2TIMElemType
 
enum  V2TIMOfflinePushFlag
 
enum  V2TIMImageType
 
enum  V2TIMGroupTipsType
 
enum  V2TIMMessageGetType
 
enum  V2TIMKeywordListMatchType
 
enum  V2TIMGroupMessageReadMembersFilter
 
enum  V2TIMIOSOfflinePushType
 
enum  V2TIMOfflinePushTokenType
 

Macro Definition Documentation

◆ kIOSOfflinePushNoSound

#define kIOSOfflinePushNoSound   "push.no_sound"

No sound will be played when receiving messages.

◆ kIOSOfflinePushDefaultSound

#define kIOSOfflinePushDefaultSound   "default"

Play system sound when receiving messages.

◆ kImSDK_MesssageAtALL

#define kImSDK_MesssageAtALL   "__kImSDK_MesssageAtALL__"

Typedef Documentation

◆ V2TIMElemTypeVector

typedef TXV2TIMElemTypeVector V2TIMElemTypeVector

◆ V2TIMElemVector

typedef TXPV2TIMElemVector V2TIMElemVector

◆ V2TIMMessageVector

typedef TXV2TIMMessageVector V2TIMMessageVector

◆ V2TIMImageVector

typedef TXV2TIMImageVector V2TIMImageVector

◆ V2TIMMessageReceiptVector

typedef TXV2TIMMessageReceiptVector V2TIMMessageReceiptVector

◆ V2TIMReceiveMessageOptInfoVector

typedef TXV2TIMReceiveMessageOptInfoVector V2TIMReceiveMessageOptInfoVector

◆ V2TIMMessageSearchResultItemVector

typedef TXV2TIMMessageSearchResultItemVector V2TIMMessageSearchResultItemVector

◆ V2TIMMessageExtensionVector

typedef TXV2TIMMessageExtensionVector V2TIMMessageExtensionVector

◆ V2TIMMessageExtensionResultVector

typedef TXV2TIMMessageExtensionResultVector V2TIMMessageExtensionResultVector

◆ V2TIMMessageReactionVector

typedef TXV2TIMMessageReactionVector V2TIMMessageReactionVector

◆ V2TIMMessageReactionResultVector

typedef TXV2TIMMessageReactionResultVector V2TIMMessageReactionResultVector

◆ V2TIMMessageReactionChangeInfoVector

typedef TXV2TIMMessageReactionChangeInfoVector V2TIMMessageReactionChangeInfoVector

Enumeration Type Documentation

◆ V2TIMMessagePriority

Message priority.

Enumerator
V2TIM_PRIORITY_DEFAULT 

Defaulted to normal priority.

V2TIM_PRIORITY_HIGH 

High priority, usually used for important messages such as gift messages.

V2TIM_PRIORITY_NORMAL 

Normal priority, usually used for common messages.

V2TIM_PRIORITY_LOW 

Low priority, usually used for like messages.

◆ V2TIMMessageStatus

Message status.

Enumerator
V2TIM_MSG_STATUS_SENDING 

Message being sent.

V2TIM_MSG_STATUS_SEND_SUCC 

Message sent successfully.

V2TIM_MSG_STATUS_SEND_FAIL 

Message fails to be sent.

V2TIM_MSG_STATUS_HAS_DELETED 

Message deleted.

V2TIM_MSG_STATUS_LOCAL_IMPORTED 

Message imported to local storage.

V2TIM_MSG_STATUS_LOCAL_REVOKED 

Message revoked.

◆ V2TIMElemType

Message element type.

Enumerator
V2TIM_ELEM_TYPE_NONE 

No element.

V2TIM_ELEM_TYPE_TEXT 

Text message.

V2TIM_ELEM_TYPE_CUSTOM 

Custom message.

V2TIM_ELEM_TYPE_IMAGE 

Image message.

V2TIM_ELEM_TYPE_SOUND 

Voice message.

V2TIM_ELEM_TYPE_VIDEO 

Video message.

V2TIM_ELEM_TYPE_FILE 

File message.

V2TIM_ELEM_TYPE_LOCATION 

Geographical location message.

V2TIM_ELEM_TYPE_FACE 

Emoji message.

V2TIM_ELEM_TYPE_GROUP_TIPS 

Group tip message.

V2TIM_ELEM_TYPE_MERGER 

Forward message.

◆ V2TIMOfflinePushFlag

Offline push flag.

Enumerator
V2TIM_OFFLINE_PUSH_DEFAULT 

Push mesage when offline according to the default rules.

V2TIM_OFFLINE_PUSH_NO_PUSH 

Don't push mesage when offline.

◆ V2TIMImageType

Image type.

Enumerator
V2TIM_IMAGE_TYPE_ORIGIN 

Original image.

V2TIM_IMAGE_TYPE_THUMB 

Thumbnail.

V2TIM_IMAGE_TYPE_LARGE 

Large image.

◆ V2TIMGroupTipsType

Group tip type.

Enumerator
V2TIM_GROUP_TIPS_TYPE_NONE 

Undefined.

V2TIM_GROUP_TIPS_TYPE_JOIN 

Proactively join a group (memberList joins a group; valid only for non-Work groups)

V2TIM_GROUP_TIPS_TYPE_INVITE 

Be invited to a group (opMember invites memberList to join a group; valid only for Work groups)

V2TIM_GROUP_TIPS_TYPE_QUIT 

Quit a group.

V2TIM_GROUP_TIPS_TYPE_KICKED 

Be kicked out of a group (opMember kicks memberList out of the group)

V2TIM_GROUP_TIPS_TYPE_SET_ADMIN 

Set an admin (opMember sets memberList as an admin)

V2TIM_GROUP_TIPS_TYPE_CANCEL_ADMIN 

Cancel an admin (opMember cancels memberList as an admin)

V2TIM_GROUP_TIPS_TYPE_GROUP_INFO_CHANGE 

Group profile change (opMember modifies group information:groupName & introduction & notification & faceUrl & owner & allMute & custom)

V2TIM_GROUP_TIPS_TYPE_MEMBER_INFO_CHANGE 

Group member profile change (opMember modifies group member information:muteTime)

V2TIM_GROUP_TIPS_TYPE_TOPIC_INFO_CHANGE 

Topic profile change(opMember modifies topic information:topicName & introduction & notification & faceUrl & allMute & topicCustomData)

V2TIM_GROUP_TIPS_TYPE_PINNED_MESSAGE_ADDED 

Pinned Group Message.

V2TIM_GROUP_TIPS_TYPE_PINNED_MESSAGE_DELETED 

Cancel Pinned Group Message.

◆ V2TIMMessageGetType

Message pull type.

Enumerator
V2TIM_GET_CLOUD_OLDER_MSG 

Get older messages from the cloud.

V2TIM_GET_CLOUD_NEWER_MSG 

Get newer messages from the cloud.

V2TIM_GET_LOCAL_OLDER_MSG 

Get older messages from local storage.

V2TIM_GET_LOCAL_NEWER_MSG 

Get newer messages from local storage.

◆ V2TIMKeywordListMatchType

Keyword list matching type when search message.

Enumerator
V2TIM_KEYWORD_LIST_MATCH_TYPE_OR 
V2TIM_KEYWORD_LIST_MATCH_TYPE_AND 

◆ V2TIMGroupMessageReadMembersFilter

Group message read member list filter type.

Enumerator
V2TIM_GROUP_MESSAGE_READ_MEMBERS_FILTER_READ 

Group message read member list.

V2TIM_GROUP_MESSAGE_READ_MEMBERS_FILTER_UNREAD 

Group message unread member list.

◆ V2TIMIOSOfflinePushType

The type of offline push on iOS.

Enumerator
V2TIM_IOS_OFFLINE_PUSH_TYPE_APNS 

APNs.

V2TIM_IOS_OFFLINE_PUSH_TYPE_VOIP 

VoIP push.

◆ V2TIMOfflinePushTokenType

The type of device token when register offline push.

Enumerator
V2TIM_OFFLINE_PUSH_TOKEN_TYPE_DEFAULT 

Default is OEM token: APNS/xiaomi push/Huawei push etc.

V2TIM_OFFLINE_PUSH_TOKEN_TYPE_TPNS 

TPNS.

V2TIM_OFFLINE_PUSH_TOKEN_TYPE_VOIP 

VoIP push,only supported for iOS.