Extensions on V2TIMManager

You can mention someone only in group chats. For example, if you want the current text message to @denny, @lucy, and @all, pass in ["denny", "lucy", kImSDK_MesssageAtALL] for atUserList.

• The maximum number of @ target users is 30 by default. If this limit is exceeded, message sending will fail.

• The total number of users specified by atUserList cannot exceed the default maximum number, including the case of @all.

• AVChatRoom groups do not support @ messages.

The Chat SDK does not provide an emoji package. Developers can use index to store the indexes of the emojis they have in their emoji packages. Alternatively, they can directly use data to store emoji binary data and the string key. Either way, developers can customize emojis. The Chat SDK is only responsible for passing them through.

A typical combined message looks like this on the UI:

|Chat History of Vinson and Lynx | -- title

|Vinson: When is the new version of SDK scheduled to go online? | -- abstract1

|Lynx: Next Monday. The specific time depends on the system test result in these two days. | -- abstract2

|Vinson: OK | -- abstract3

The chat UI usually displays only the title and abstract of the combined message. The complete combined message list will be displayed only when the user clicks the combined message on the UI.

You can create a combined message (V2TIMMessage) for multiple messages to be forwarded and call the sendMessage API to send the combined message. The procedure is as follows:

1. Call createMergerMessage to create a combined message V2TIMMessage.

2. Call sendMessage to send the forward V2TIMMessage.

The procedure for parsing a combined message received is as follows:

1. Obtain mergerElem via V2TIMMessage.

2. Obtain title and abstractList via mergerElem for UI display.

3. When the user clicks the combined message on the UI, call downloadMessageList to get the list of forwarded messages. for a text message, the format can be "sender:text" format. For an image message, the format can be "sender:[image]". For a file message, the format can be in the "sender:[file]". - Parameters: - messageList : Message list (Up to 300 messages are supported. The message object must be in the V2TIM_MSG_STATUS_SEND_SUCC status. The message type cannot be V2TIMGroupTipsElem.) - title : Source of the combined message, for example, "Chat History of Vinson and Lynx" and "xxx group chat history" - abstractList : Combined message abstract list (supports up to 5 abstracts, each containing a maximum of 100 characters). You can use different abstract formats for different message types. For example, - compatibleText : Text to be displayed if the SDK version does not support combined messages. This parameter cannot be null.

If you need to forward a message, you cannot directly call the sendMessage API to send the original message. Instead, you need to call createForwardMessage to create a forward message first and send it.

If you need to send a message to a specified group member list within a group, you can create a targeted group message. Only the specified group member can receive the targeted group message.

• The original message object does not support group @ message.

• You can specify up to 50 message receivers.

• Targeted group messages are not supported in community or avchatroom groups.

• Targeted group messages will not be counted as unread messages.

If you need to send a group message with the mentioning (@) feature, use this API to create a message. For example, if you want the current message to @denny, @lucy, and @all, pass in @[@"denny", @"lucy", kImSDK_MesssageAtALL] for atUserList.

• The maximum number of @ target users is 30 by default. If this limit is exceeded, message sending will fail.

• The total number of users specified by atUserList cannot exceed the default maximum number, including the case of @all.

• AVChatRoom groups do not support @ messages.

• In v6.0 or later, you can specify both groupID and receiver, and the message will be sent to the specified user in the group. If you want to send a message to multiple users in a group, you need to call the createTargetedGroupMessage API to create a targeted group message first.

• Before setting the offlinePushInfo field, you need to enable push via V2TIMOfflinePushManager. After push is enabled, all messages except custom messages will be pushed by default.

• If you want to push custom messages as well, set the desc field in offlinePushInfo so that the information specified by desc will be displayed by default during push.

• Audio-video groups (AVChatRoom) do not support the onlineUserOnly field. You need to set onlineUserOnly to false for audio-video groups (AVChatRoom).

• If onlineUserOnly is set to true, the message is an online message and is not counted as an unread message.

Supported only in 5.3.425 and later versions. V2TIMReceiveMessageOpt.V2TIM_RECEIVE_MESSAGE: messages will be received when the user is online, and push notifications will be received when the user is offline. V2TIMReceiveMessageOpt.V2TIM_NOT_RECEIVE_MESSAGE: no message will be received. V2TIMReceiveMessageOpt.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE: messages will be received when the user is online, and no push notification will be received when the user is offline. - Parameters: - opt : There are three message receiving options: - Warning: Note that: * This API supports batch setting. You can use the userIDList field to specify up to 30 users for batch setting. * This API can be called for up to 5 times per second.

Supported only in 5.3.425 and later versions.

V2TIMReceiveMessageOpt.V2TIM_RECEIVE_MESSAGE: messages will be received when the user is online, and push notifications will be received when the user is offline. V2TIMReceiveMessageOpt.V2TIM_NOT_RECEIVE_MESSAGE: no group message will be received. V2TIMReceiveMessageOpt.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE: messages will be received when the user is online, and no push notification will be received when the user is offline. V2TIMReceiveMessageOpt.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE_EXCEPT_AT: messages will be received when the user is online, and no push notification will be received when the user is offline but except @ message. V2TIMReceiveMessageOpt.V2TIM_NOT_RECEIVE_MESSAGE_EXCEPT_AT: only receive @ messages.

V2TIMReceiveMessageOpt.V2TIM_RECEIVE_MESSAGE：messages will be received when the user is online, and notifications will be received when the user is offline. V2TIMReceiveMessageOpt.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE：messages will be received when the user is online, and no push notification will be received when the user is offline.（you can use this to mute group chat notifications）

• If duration is less than 246060, group chat notifications will be muted starting from "startHour:startMinute:startSecond" every day and unmuted after the specified duration elapses.

• If the duration is 246061 or longer, group chat notifications will be muted indefinitely starting from startHour:startMinute:startSecond of the day when the API is called.

V2TIMReceiveMessageOpt.V2TIM_RECEIVE_MESSAGE：messages will be received when the user is online, and notifications will be received when the user is offline. V2TIMReceiveMessageOpt.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE：messages will be received when the user is online, and no push notification will be received when the user is offline.（you can use this to mute group chat notifications）

• If the login API is not called，calling this API will not return any historical messages.

• If login failed, calling this API will return local historical messages.

• If login is successful and the network is disconnected, calling this API will return local historical messages.

• If login is successful and the network is normal, after this API is called, cloud historical messages will be pulled first, which will be merged with local historical messages before being returned.

• If the login API is not called，calling this API will not return any historical messages.

• If login failed, calling this API will return local historical messages.

• If login is successful and the network is disconnected, calling this API will return local historical messages.

• If login is successful and the network is normal, after this API is called, cloud historical messages will be pulled first, which will be merged with local historical messages before being returned.

• Only meeting groups (Meeting) support pulling historical messages of members before they join the groups. For audio-video groups (AVChatRoom), messages are not saved to the roaming and local databases, and therefore this API does not take effect.

• If the login interface is not called，calling this interface will not return any historical messages.

• If the login is failed, calling this interface will return local historical messages.

• If the login is successful and the network is disconnected, calling this interface will return local historical messages.

• If the login is successful and the network is connected, when the option param is set to pull cloud historical messages, calling this interface will first request cloud historical messages, and then merge them with local historical messages before returning.

• Only meeting groups (Meeting) support pulling historical messages of members before they join the groups. For audio-video groups (AVChatRoom), messages are not saved to the roaming and local databases, and therefore this API does not take effect.

• By default, you can recall only messages that are sent within 2 minutes. You can customize the time limit for message recall via the console (Feature Configuration -> Login and Message -> Message Recall Settings).

• Only common messages sent in one-to-one chats and group chats can be recalled. You cannot recall messages that can be received only by online users (onlineUserOnly is set to true).

• If the sender recalls a message, the recipient will receive the V2TIMAdvancedMsgListener -> onRecvMessageRevoked callback.

• This API is available for all group types, including audio-video groups (AVChatRoom) and community groups, in 7.4 and later versions.

• In one-to-one chats, messages can only be recalled by their senders.

• In group chats, not only the sender can recall their own message, but administrators or group owners can also recall messages sent by other group members through this API.

• If the message is modified successfully, both the sender and recipients (of one-to-one or group messages) will receive the onRecvMessageModified callback.

• While a message is being modified, if another user successfully modified it, the ERR_SDK_MSG_MODIFY_CONFLICT error will be returned upon completion.

• The latest message object will be returned regardless of whether a message is modified successfully.

• However, after the app is uninstalled and reinstalled, the local delete marker of the message will get lost, and the message can still be pulled via getHistoryMessage.

• Up to 50 messages can be deleted at a time.

• The messages to be deleted at a time must belong to the same conversation.

• This API can be called only once per second.

• If the account has pulled these messages from other devices, the messages will still be stored on those devices after this API is called to delete them. That is, the operation of message deletion cannot be synchronized across multiple devices.

Supported only in 5.4.666 and later versions. - Warning: Note that: * When messages in a conversation are deleted from local storage, they are deleted simultaneously from the server.

Supported only in 5.4.666 and later versions. - Warning: Note that: * When messages in a conversation are deleted from local storage, they are also deleted from the server.

This API is mainly used to insert informative messages in a group chat, such as "you have exited the group". Such messages are shown to the local user but not sent to others. In this sense, insertGroupMessageToLocalStorage() is sendMessage() API with the message delivery feature disabled.

This API is mainly used to insert informative messages in a one-to-one, such as "you have successfully sent the message". Such messages are shown to the local user but not sent to the remote user. In this sense, insertGroupMessageToLocalStorage() is sendMessage() API with the message delivery feature disabled.

• This feature is a value-added service of Chat. Please refer to the pricing details for more information.

• If you have not activated this service, calling the interface will return error code 60020.

• The returned list does not include messages with the status V2TIM_MSG_STATUS_LOCAL_REVOKED (recalled) and V2TIM_MSG_STATUS_HAS_DELETED (deleted).

• To send a read receipt for a group message, you need to turn on the corresponding feature in the Chat console.

• The messages in messageList must be in the same conversation.

• After the API is called successfully, the sender's message unread count will not change. Instead, the sender will receive the onRecvMessageReadReceipts callback, which indicates whether the message has been read.

• To obtain the read receipt of group message, you need to go to the console and turn on the corresponding switch.

• The messages in messageList must be in the same conversation.

• You need to buy Premium Edition to use this feature. And you need to go to the IM console to enable this feature.

• The extension key supports a maximum of 100 bytes, the extension value supports a maximum of 1KB, a maximum of 20 extensions can be set at a time, and a maximum of 300 extensions can be set for a single message.

• If multiple users set the same extension key at the same time, only the first user can execute it successfully. The other users will receive the 23001 error code and the newest extension information, and can try again afterward.

• We strongly recommend that different users set different extension keys, so that conflict will not appear in most scenarios. For example, you can use your userID as an extension key for voting, solitaire, and questionnaires.

• If multiple users delete the same extension key at the same time, only the first user can execute it successfully. The other users will receive the 23001 error code and the newest extension information, and can try again afterward.

Emoji response function refers to the interaction response to a message through emoji symbols. We can see the number of responses and the list of responders for each emoji.

Currently, there are two common styles of message response display:

Style one:

----------------------------

| lucy, happy birthday! |

----------------------------

| 😄 1 💐 2 👍🏻 10 |

----------------------------

Style two:

---------------------------------------------------------

| lucy, happy birthday! |

---------------------------------------------------------

| 😁 bob 💐olivia 🎂david |

| 👍🏻 denny、james、lucy、linda、thomas and other 10 people |

----------------------------------------------------------

When the user clicks on an emoji, it will jump to the emoji response detail interface:

| 😄 | 💐 | 👍🏻 |

| bob | olivia | lucy |

| ... | ... | denny |

| ... | ... | ... |

You can pull a list of users who responded with an emoji by page.

You can implement emoji response capabilities using the following SDK APIs:

1、Call addMessageReaction to add an emoji reaction to a message. If it succeeds, the current user will be added to the response list for that emoji.

2、Call removeMessageReaction to delete an added emoji reaction. If it succeeds, the current user will be removed from the response list for that emoji.

3、Call getMessageReactions to get the emoji reactions of multiple messages. The number of users who responded with each emoji and the information of the first N users (10 by default) will be returned.

4、Call getAllUserListOfMessageReaction to get the information of all users who responded with the emojis by page.

5、Listen to the onRecvMessageReactionsChanged callback to receive notifications about the change of emoji response. The callback will return the latest response information, including the total number of users who responded with each emoji and the information of the first N users.

- Parameters: - reactionID : Message reaction ID. In the emoji response scenario, reactionID is the emojiID. A single message supports up to 10 reactions, and a single reaction supports up to 100 users. - Warning: Note that: * You need to buy the Premium edition to use this feature. * If the total count of reactions in a single message exceeds the maximum limit, the interface will report ERR_SVR_MSG_REACTION_COUNT_LIMIT error. * If the total count of users in a single reaction exceeds the maximum limit, the interface will report ERR_SVR_MSG_REACTION_USER_COUNT_LIMIT error. * If the current user is already in the specified emoji's response list, the interface will report the ERR_SVR_MSG_REACTION_ALREADY_CONTAIN_USER error.

• You need to buy Premium Edition to use this feature.

• If the reaction does not exist, the interface will report ERR_SVR_MSG_REACTION_NOT_EXISTS error.

• If the current user is not in the specified emoji's response list, the interface will report the ERR_SVR_MSG_REACTION_NOT_CONTAIN_USER error.

• You need to buy Premium Edition to use this feature.

• You need to buy Premium Edition to use this feature.

• After the API is successfully called, your unread count will be cleared to 0, and the remote user will receive the onRecvC2CReadReceipt callback, which will contain the time when the messages were marked as read.

• If userID is null, all one-to-one messages will be marked as read. This is only supported in 5.8 and later versions.

• After the API is successfully called, your unread count will be cleared to 0.

• If the groupID is nil, all group messages wil be marked as read. More importantly, it only supported in 5.8 and later versions.

• The maximum number of messages that can be pinned is 10.

• This interface is used to pin and cancel pinned group messages. If the number of pinned messages exceeds the limit, the SDK will return error code 10070.

• This interface is used to obtain the pinned message list. If the pinned message has expired, it will not be returned.