IMSDK
即时通信 IM 提供全球接入、单聊、群聊、消息推送、资料关系链托管、账号鉴权等全方位解决方案，并提供完备的 App 接入、后台管理接口。
结构体 | 宏定义 | 类型定义 | 枚举
V2TIMMessage.h 文件参考

结构体

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
 

宏定义

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

类型定义

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
 

枚举

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

宏定义说明

◆ kIOSOfflinePushNoSound

#define kIOSOfflinePushNoSound   "push.no_sound"

接收时不会播放声音

◆ kIOSOfflinePushDefaultSound

#define kIOSOfflinePushDefaultSound   "default"

接收时播放系统声音

◆ kImSDK_MesssageAtALL

#define kImSDK_MesssageAtALL   "__kImSDK_MesssageAtALL__"

类型定义说明

◆ 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

枚举类型说明

◆ V2TIMMessagePriority

enum V2TIMMessagePriority

消息优先级

枚举值
V2TIM_PRIORITY_DEFAULT 

默认

V2TIM_PRIORITY_HIGH 

高优先级，一般用于礼物等重要消息

V2TIM_PRIORITY_NORMAL 

常规优先级，一般用于普通消息

V2TIM_PRIORITY_LOW 

低优先级，一般用于点赞消息

◆ V2TIMMessageStatus

enum V2TIMMessageStatus

消息状态

枚举值
V2TIM_MSG_STATUS_SENDING 

消息发送中

消息发送成功

V2TIM_MSG_STATUS_SEND_SUCC 

消息发送失败

V2TIM_MSG_STATUS_SEND_FAIL 

消息被删除

V2TIM_MSG_STATUS_HAS_DELETED 

导入到本地的消息

V2TIM_MSG_STATUS_LOCAL_IMPORTED 

被撤销的消息

V2TIM_MSG_STATUS_LOCAL_REVOKED 

◆ V2TIMElemType

enum V2TIMElemType

消息类型

枚举值
V2TIM_ELEM_TYPE_NONE 

未知消息

文本消息

V2TIM_ELEM_TYPE_TEXT 

自定义消息

V2TIM_ELEM_TYPE_CUSTOM 

图片消息

V2TIM_ELEM_TYPE_IMAGE 

语音消息

V2TIM_ELEM_TYPE_SOUND 

视频消息

V2TIM_ELEM_TYPE_VIDEO 

文件消息

V2TIM_ELEM_TYPE_FILE 

地理位置消息

V2TIM_ELEM_TYPE_LOCATION 

表情消息

V2TIM_ELEM_TYPE_FACE 

群 Tips 消息

V2TIM_ELEM_TYPE_GROUP_TIPS 

合并消息

V2TIM_ELEM_TYPE_MERGER 

◆ V2TIMOfflinePushFlag

enum V2TIMOfflinePushFlag

推送规则

枚举值
V2TIM_OFFLINE_PUSH_DEFAULT 

按照默认规则进行推送

不进行推送

V2TIM_OFFLINE_PUSH_NO_PUSH 

◆ V2TIMImageType

enum V2TIMImageType

图片类型

枚举值
V2TIM_IMAGE_TYPE_ORIGIN 

原图

缩略图

V2TIM_IMAGE_TYPE_THUMB 

大图

V2TIM_IMAGE_TYPE_LARGE 

◆ V2TIMGroupTipsType

enum V2TIMGroupTipsType

群 Tips 类型

枚举值
V2TIM_GROUP_TIPS_TYPE_NONE 

未定义

主动入群（memberList 加入群组，非 Work 群有效）

V2TIM_GROUP_TIPS_TYPE_JOIN 

被邀请入群（opMember 邀请 memberList 入群，Work 群有效）

V2TIM_GROUP_TIPS_TYPE_INVITE 

退出群 (opMember 退出群组)

V2TIM_GROUP_TIPS_TYPE_QUIT 

踢出群 (opMember 把 memberList 踢出群组)

V2TIM_GROUP_TIPS_TYPE_KICKED 

设置管理员 (opMember 把 memberList 设置为管理员)

V2TIM_GROUP_TIPS_TYPE_SET_ADMIN 

取消管理员 (opMember 取消 memberList 管理员身份)

V2TIM_GROUP_TIPS_TYPE_CANCEL_ADMIN 

群资料变更 (opMember 修改群资料： groupName & introduction & notification & faceUrl & owner & allMute & custom)

V2TIM_GROUP_TIPS_TYPE_GROUP_INFO_CHANGE 

群成员资料变更 (opMember 修改群成员资料：muteTime)

V2TIM_GROUP_TIPS_TYPE_MEMBER_INFO_CHANGE 

◆ V2TIMMessageGetType

enum V2TIMMessageGetType

消息拉取方式

枚举值
V2TIM_GET_CLOUD_OLDER_MSG 

获取云端更老的消息

获取云端更新的消息

V2TIM_GET_CLOUD_NEWER_MSG 

获取本地更老的消息

V2TIM_GET_LOCAL_OLDER_MSG 

获取本地更新的消息

V2TIM_GET_LOCAL_NEWER_MSG 

◆ V2TIMKeywordListMatchType

enum V2TIMKeywordListMatchType

消息搜索关键字匹配类型

枚举值
V2TIM_KEYWORD_LIST_MATCH_TYPE_OR 
V2TIM_KEYWORD_LIST_MATCH_TYPE_AND 

◆ V2TIMGroupMessageReadMembersFilter

enum V2TIMGroupMessageReadMembersFilter

群消息已读成员列表过滤类型

枚举值
V2TIM_GROUP_MESSAGE_READ_MEMBERS_FILTER_READ 

群消息已读成员列表

群消息未读成员列表

V2TIM_GROUP_MESSAGE_READ_MEMBERS_FILTER_UNREAD 

◆ V2TIMIOSOfflinePushType

enum V2TIMIOSOfflinePushType

iOS 离线推送的类型

枚举值
V2TIM_IOS_OFFLINE_PUSH_TYPE_APNS 

普通的 APNs 推送

VoIP 推送

V2TIM_IOS_OFFLINE_PUSH_TYPE_VOIP 

◆ V2TIMOfflinePushTokenType

enum V2TIMOfflinePushTokenType

配置离线推送时，注册的设备 token 类型

枚举值
V2TIM_OFFLINE_PUSH_TOKEN_TYPE_DEFAULT 

默认是厂商 token: APNS/小米 push/Huawei push 等

TPNS

V2TIM_OFFLINE_PUSH_TOKEN_TYPE_TPNS 

VoIP push，目前仅支持 iOS

V2TIM_OFFLINE_PUSH_TOKEN_TYPE_VOIP