Message
introduction
Message
IM messages can be classified by message storage policy into two types: online messages and non-online messages.
Online messages can be received only by online users and will not be pushed when they are offline. Non-online messages can be received by users whether they are online or not.
Online messages are delivered in real time and not stored on the server or in the SDK. Therefore, they cannot be pulled from historical messages after the device is changed or the application is uninstalled and reinstalled.
All messages in an audio-video group are online messages.
Messages pushed to all users are online messages.
Non-online messages are stored in the SDK and on the server. By default, they are stored on the roaming server for seven days. If you want a longer storage period, you need to purchase the value-added service. For more information on the service content and billing, see Pricing.
These messages, for example, all types of ordinary messages, can be pulled from historical messages after the device is changed or the application is uninstalled and reinstalled.
Parameter introduction
message_elem_array
- Parameter type : List< Elem >
- Parameter description : Read & Write (Required), element list in the message
message_conv_id
- Parameter type : string
- Parameter description : Read & Write (Optional), conversation ID of the message
message_conv_type
- Parameter type : TIMConvType?
- Parameter description : Read & Write (Optional), conversation type of the message
message_sender
- Parameter type : string
- Parameter description : Read & Write (Optional), message sender
message_priority
- Parameter type : TIMMsgPriority?
- Parameter description : Read & Write (Optional), message priority
message_client_time
- Parameter type : ulong?
- Parameter description : Read & Write (Optional), message client time
message_server_time
- Parameter type : ulong?
- Parameter description : Read & Write (Optional), message server time
message_is_from_self
- Parameter type : bool?
- Parameter description : Read & Write (Optional), message is from self
message_platform
- Parameter type : TIMPlatform?
- Parameter description : Read & Write (Optional), message platform
message_is_read
- Parameter type : bool?
- Parameter description : Read & Write (Optional), message is read or not
message_is_online_msg
- Parameter type : bool?
- Parameter description : Read & Write (Optional), is online message or not. False means normal message, ture means dissolve after read
message_is_peer_read
- Parameter type : bool?
- Parameter description : Read only, message is read by peer or not
message_receipt_peer_read
- Parameter type : bool?
- Parameter description : Read only, message receipt is read by peer or not. It's true only when msg_time <= the time peer marked read receipt
message_need_read_receipt
- Parameter type : bool?
- Parameter description : Read & Write (Optional), message needs read receipt or not, (SDK ver. ^6.1, only for Flagship Package). Before activate it, please go to IM console and set the group for read receipt feature.
message_support_message_extension
- Parameter type : bool?
- Parameter description : Read & Write (Optional), whether the message needs extension
message_has_sent_receipt
- Parameter type : bool?
- Parameter description : Read only, has sent receipt or not
message_group_receipt_read_count
- Parameter type : int?
- Parameter description : Read only. Caveat: this is SDK internal field, please call MsgGetMessageReadReceipts to get group message read receipts.
message_group_receipt_unread_count
- Parameter type : int?
- Parameter description : Read only. Caveat: this is SDK internal field, please call MsgGetMessageReadReceipts to get group message read receipts.
message_version
- Parameter type : ulong?
- Parameter description : Read only. Caveat: this is SDK internal field, don not use it.
message_status
- Parameter type : TIMMsgStatus?
- Parameter description : Read & Write (Optional), message status
message_unique_id
- Parameter type : ulong
- Parameter description : Read only, message unique ID, please use kTIMMsgMsgId instead
message_msg_id
- Parameter type : string
- Parameter description : Read only, message ID
message_rand
- Parameter type : ulong
- Parameter description : Read only, message random
message_seq
- Parameter type : ulong
- Parameter description : Read only, message sequence
message_custom_int
- Parameter type : int?
- Parameter description : Read & Write (Optional), message custom integer, (stored locally, won't be sent to peers, dismissed after unload the App)
message_custom_str
- Parameter type : string
- Parameter description : Read & Write (Optional), message custom string, (stored locally, won't be sent to peers, dismissed after unload the App)
message_cloud_custom_str
- Parameter type : string
- Parameter description : Read & Write (Optional), message custom string, (stored online, will be sent to peers, dismissed after unload the App)
message_is_excluded_from_unread_count
- Parameter type : bool?
- Parameter description : Read & Write (Optional), message is excluded from unread count or not: Default False.
message_is_forward_message
- Parameter type : bool?
- Parameter description : Read & Write (Optional), message is forward message or not
message_group_at_user_array
- Parameter type : List< string >
- Parameter description : Read & Write (Optional), group @ userID list, kImSDK_MesssageAtALL means @ALL
message_sender_profile
- Parameter type : UserProfile
- Parameter description : Read & Write (Optional), message sender profile
message_sender_group_member_info
- Parameter type : GroupMemberInfo
- Parameter description : Read & Write (Optional), group message sender info, only for group message, only kTIMGroupMemberInfoIdentifier, kTIMGroupMemberInfoNameCard are available here, others can be retrieved by TIMGroupGetMemberInfoList.
message_target_group_member_array
- Parameter type : List< string >
- Parameter description : Read & Write (Optional), message target group member userID list, not support for group @ message, not support for Community and AVChatRoom. Once set, this message won't be counted in conversation unread count
message_offlie_push_config
- Parameter type : OfflinePushConfig
- Parameter description : Read & Write (Optional), message offline push config
message_excluded_from_last_message
- Parameter type : bool
- Parameter description : Read & Write (Optional), message is excluded from the lastMessage