Instance Methods
(void)	- addAdvancedMsgListener:

(void)	- removeAdvancedMsgListener:

(V2TIMMessage *)	- createTextMessage:

(V2TIMMessage *)	- createTextAtMessage:atUserList:

(V2TIMMessage *)	- createCustomMessage:

(V2TIMMessage *)	- createCustomMessage:desc:extension:

(V2TIMMessage *)	- createImageMessage:

(V2TIMMessage *)	- createSoundMessage:duration:

(V2TIMMessage *)	- createVideoMessage:type:duration:snapshotPath:

(V2TIMMessage *)	- createFileMessage:fileName:

(V2TIMMessage *)	- createLocationMessage:longitude:latitude:

(V2TIMMessage *)	- createFaceMessage:data:

(V2TIMMessage *)	- createMergerMessage:title:abstractList:compatibleText:

(V2TIMMessage *)	- createForwardMessage:

(V2TIMMessage *)	- createTargetedGroupMessage:receiverList:

(V2TIMMessage *)	- createAtSignedGroupMessage:atUserList:

(NSString *)	- sendMessage:receiver:groupID:priority:onlineUserOnly:offlinePushInfo:progress:succ:fail:

(void)	- setC2CReceiveMessageOpt:opt:succ:fail:

(void)	- getC2CReceiveMessageOpt:succ:fail:

(void)	- setGroupReceiveMessageOpt:opt:succ:fail:

(void)	- setAllReceiveMessageOpt:startHour:startMinute:startSecond:duration:succ:fail:

(void)	- setAllReceiveMessageOpt:startTimeStamp:duration:succ:fail:

(void)	- getAllReceiveMessageOpt:fail:

(void)	- getC2CHistoryMessageList:count:lastMsg:succ:fail:

(void)	- getGroupHistoryMessageList:count:lastMsg:succ:fail:

(void)	- getHistoryMessageList:succ:fail:

(void)	- revokeMessage:succ:fail:

(void)	- modifyMessage:completion:

(void)	- deleteMessageFromLocalStorage:succ:fail:

(void)	- deleteMessages:succ:fail:

(void)	- clearC2CHistoryMessage:succ:fail:

(void)	- clearGroupHistoryMessage:succ:fail:

(NSString *)	- insertGroupMessageToLocalStorage:to:sender:succ:fail:

(NSString *)	- insertC2CMessageToLocalStorage:to:sender:succ:fail:

(void)	- findMessages:succ:fail:

(void)	- searchLocalMessages:succ:fail:

(void)	- searchCloudMessages:succ:fail:

(void)	- sendMessageReadReceipts:succ:fail:

(void)	- getMessageReadReceipts:succ:fail:

(void)	- getGroupMessageReadMemberList:filter:nextSeq:count:succ:fail:

(void)	- setMessageExtensions:extensions:succ:fail:

(void)	- getMessageExtensions:succ:fail:

(void)	- deleteMessageExtensions:keys:succ:fail:

(void)	- addMessageReaction:reactionID:succ:fail:

(void)	- removeMessageReaction:reactionID:succ:fail:

(void)	- getMessageReactions:maxUserCountPerReaction:succ:fail:

(void)	- getAllUserListOfMessageReaction:reactionID:nextSeq:count:succ:fail:

(void)	- translateText:sourceLanguage:targetLanguage:completion:

(void)	- pinGroupMessage:message:isPinned:succ:fail:

(void)	- getPinnedGroupMessageList:succ:fail:

(void)	- markC2CMessageAsRead:succ:fail:

(void)	- markGroupMessageAsRead:succ:fail:

(void)	- markAllMessageAsRead:fail:

Member Typedef Documentation

◆ V2TIMMessageListSucc

- (typedef void(^ V2TIMMessageListSucc) (NSArray< V2TIMMessage * > *msgs))

protected

Callback definition on get history message list.

◆ V2TIMSearchMessageListSucc

- (typedef void(^ V2TIMSearchMessageListSucc) (V2TIMMessageSearchResult *searchResult))

protected

Callback definition on search history message.

◆ V2TIMProgress

- (typedef void(^ V2TIMProgress) (uint32_t progress))

protected

Callback definition for file upload progress.

◆ V2TIMDownLoadProgress

- (typedef void(^ V2TIMDownLoadProgress) (NSInteger curSize, NSInteger totalSize))

protected

Callback definition for file download progress.

◆ V2TIMReceiveMessageOptListSucc

- (typedef void(^ V2TIMReceiveMessageOptListSucc) (NSArray< V2TIMReceiveMessageOptInfo * > *optList))

protected

Callback definition for get message receive option.

◆ V2TIMReceiveMessageOptSucc

- (typedef void(^ V2TIMReceiveMessageOptSucc) (V2TIMReceiveMessageOptInfo *optInfo))

protected

Callback definition for get all message receive option.

◆ V2TIMMessageReadReceiptsSucc

- (typedef void(^ V2TIMMessageReadReceiptsSucc) (NSArray< V2TIMMessageReceipt * > *receiptList))

protected

Callback definition for get receipt for group message.

◆ V2TIMGroupMessageReadMemberListSucc

- (typedef void(^ V2TIMGroupMessageReadMemberListSucc) (NSMutableArray< V2TIMGroupMemberInfo * > *members, uint64_t nextSeq, BOOL isFinished))

protected

Callback definition for get read or unread members for group message.

◆ V2TIMMessageModifyCompletion

- (typedef void(^ V2TIMMessageModifyCompletion) (int code, NSString *desc, V2TIMMessage *msg))

protected

Callback definition for message modification completed.

◆ V2TIMMessageExtensionsSetSucc

- (typedef void(^ V2TIMMessageExtensionsSetSucc) (NSArray< V2TIMMessageExtensionResult * > *extensionResultList))

protected

Callback definition for set message extensions.

◆ V2TIMMessageExtensionsGetSucc

- (typedef void(^ V2TIMMessageExtensionsGetSucc) (NSArray< V2TIMMessageExtension * > *extensionList))

protected

Callback definition for get message extensions.

◆ V2TIMMessageExtensionsDeleteSucc

- (typedef void(^ V2TIMMessageExtensionsDeleteSucc) (NSArray< V2TIMMessageExtensionResult * > *extensionResultList))

protected

Callback definition for delete message extensions.

◆ V2TIMGetMessageReactionsSucc

- (typedef void(^ V2TIMGetMessageReactionsSucc) (NSArray< V2TIMMessageReactionResult * > *resultList))

protected

Callback definition for get message reactions.

◆ V2TIMGetMessageReactionUserListSucc

- (typedef void(^ V2TIMGetMessageReactionUserListSucc) (NSArray< V2TIMUserInfo * > *userList, uint32_t nextSeq, BOOL isFinished))

protected

Callback definition for get message reaction user list.

◆ V2TIMPinnedMessageListSucc

- (typedef void(^ V2TIMPinnedMessageListSucc) (NSArray< V2TIMMessage * > *messageList))

protected

Callback for successful acquisition of pinned message list.

Member Enumeration Documentation

◆ V2TIMMessageStatus

- (enum V2TIMMessageStatus) :

protected

Enumeration definition of 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 recalled.

◆ V2TIMElemType

- (enum V2TIMElemType) :

protected

Enumeration definition of 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	Forwarded message.

◆ V2TIMOfflinePushFlag

- (enum V2TIMOfflinePushFlag) :

protected

Enumeration definition of 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

- (enum V2TIMImageType) :

protected

Enumeration definition of image type.

Enumerator
V2TIM_IMAGE_TYPE_ORIGIN	Original image.
V2TIM_IMAGE_TYPE_THUMB	Thumbnail.
V2TIM_IMAGE_TYPE_LARGE	Large image.

◆ V2TIMGroupTipsType

- (enum V2TIMGroupTipsType) :

protected

Enumeration definition of group tip type.

Enumerator
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; supports all group types except AVChatRoom from version 8.0)
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 messages.
V2TIM_GROUP_TIPS_TYPE_PINNED_MESSAGE_DELETED	Cancel pinned group messages.

◆ V2TIMGroupInfoChangeType

- (enum V2TIMGroupInfoChangeType) :

protected

Enumeration definition of change type to group information.

Enumerator
V2TIM_GROUP_INFO_CHANGE_TYPE_NAME	Change the group name.
V2TIM_GROUP_INFO_CHANGE_TYPE_INTRODUCTION	Modify the group introduction.
V2TIM_GROUP_INFO_CHANGE_TYPE_NOTIFICATION	Modify the group notice.
V2TIM_GROUP_INFO_CHANGE_TYPE_FACE	Modify the group profile photo.
V2TIM_GROUP_INFO_CHANGE_TYPE_OWNER	Change the group owner.
V2TIM_GROUP_INFO_CHANGE_TYPE_CUSTOM	Change the custom group field.
V2TIM_GROUP_INFO_CHANGE_TYPE_SHUT_UP_ALL	Change the group muting field.
V2TIM_GROUP_INFO_CHANGE_TYPE_TOPIC_CUSTOM_DATA	Change the topic custom data field.
V2TIM_GROUP_INFO_CHANGE_TYPE_RECEIVE_MESSAGE_OPT	Change the group receive message option field.
V2TIM_GROUP_INFO_CHANGE_TYPE_GROUP_ADD_OPT	In the mode of applying to join the group, the administrator approval option has changed.
V2TIM_GROUP_INFO_CHANGE_TYPE_GROUP_APPROVE_OPT	In the mode of inviting into the group, the administrator's approval option has changed.
V2TIM_GROUP_INFO_CHANGE_TYPE_ENABLE_PERMISSION_GROUP	Enable permission group field.
V2TIM_GROUP_INFO_CHANGE_TYPE_DEFAULT_PERMISSIONS	Change the group default permissions field.

◆ V2TIMMessageGetType

- (enum V2TIMMessageGetType) :

protected

Enumeration definition of 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.

◆ V2TIMReceiveMessageOpt

- (enum V2TIMReceiveMessageOpt) :

protected

Enumeration definition of message receive option.

Enumerator
V2TIM_RECEIVE_MESSAGE	Messages will be received when the user is online, and offline push notifications will be received when the user is offline.
V2TIM_NOT_RECEIVE_MESSAGE	No message will be received.
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.
V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE_EXCEPT_AT	Receive messages online, and only receive @ message push offline.
V2TIM_NOT_RECEIVE_MESSAGE_EXCEPT_AT	Only receive @ messages.

◆ V2TIMKeywordListMatchType

- (enum V2TIMKeywordListMatchType) :

protected

Enumeration definition of keyword list matching type when search message.

Enumerator
V2TIM_KEYWORD_LIST_MATCH_TYPE_OR
V2TIM_KEYWORD_LIST_MATCH_TYPE_AND

◆ V2TIMGroupMessageReadMembersFilter

- (enum V2TIMGroupMessageReadMembersFilter) :

protected

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

- (enum V2TIMIOSOfflinePushType) :

protected

The type of offline push on iOS.

Enumerator
V2TIM_IOS_OFFLINE_PUSH_TYPE_APNS	APNs.
V2TIM_IOS_OFFLINE_PUSH_TYPE_VOIP	VoIP push.

Method Documentation

◆ addAdvancedMsgListener:()

- (void) addAdvancedMsgListener: (addAdvancedMsgListener(listener:)) NS_SWIFT_NAME

1.1 Add an event listener for advanced messages

◆ removeAdvancedMsgListener:()

- (void) removeAdvancedMsgListener: (removeAdvancedMsgListener(listener:)) NS_SWIFT_NAME

1.2 Remove the event listener for advanced messages

◆ createTextMessage:()

- (V2TIMMessage *) createTextMessage: (NSString *) text

2.1 Create a text message

◆ createTextAtMessage:atUserList:()

- (V2TIMMessage *) createTextAtMessage:	(NSString *)	text
atUserList:	(NSMutableArray< NSString * > *)	atUserList

2.2 Create a text message with the mentioning(@) feature

You can mention someone only in group chats.

Parameters

atUserList List of @ target users. To @all, please pass in the kImSDK_MesssageAtALL constant string. For example, if you want the current text message to @denny, @lucy, and @all, pass in @["denny", @"lucy", kImSDK_MesssageAtALL] for atUserList.

Attention

The following are use limits 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.

◆ createCustomMessage:()

- (V2TIMMessage *) createCustomMessage: (NSData *) data

2.3 Create a custom message

◆ createCustomMessage:desc:extension:()

- (V2TIMMessage *) createCustomMessage:	(NSData *)	data
desc:	(NSString *)	desc
extension:	(createCustomMessage(data:desc:ext:))	NS_SWIFT_NAME

2.4 Create a custom message and set offline push information

Parameters

desc	Custom message description to be displayed for offline push
extension	Extension field for offline push

◆ createImageMessage:()

- (V2TIMMessage *) createImageMessage: (NSString *) imagePath

2.5 Create an image message (image size limit: 28 MB)

◆ createSoundMessage:duration:()

- (V2TIMMessage *) createSoundMessage:	(NSString *)	audioFilePath
duration:	(int)	duration

2.6 Create a voice message (voice size limit: 28 MB)

Parameters

duration Voice duration, in seconds

◆ createVideoMessage:type:duration:snapshotPath:()

- (V2TIMMessage *) createVideoMessage:	(NSString *)	videoFilePath
type:	(NSString *)	type
duration:	(int)	duration
snapshotPath:	(NSString *)	snapshotPath

2.7 Create a video message (video size limit: 100 MB)

Parameters

type	Video type, such as mp4 and mov
duration	Video duration, in seconds
snapshotPath	Video cover image path

◆ createFileMessage:fileName:()

- (V2TIMMessage *) createFileMessage:	(NSString *)	filePath
fileName:	(NSString *)	fileName

2.8 Create a file message (file size limit: 100 MB)

◆ createLocationMessage:longitude:latitude:()

- (V2TIMMessage *) createLocationMessage:	(NSString *)	desc
longitude:	(double)	longitude
latitude:	(double)	latitude

2.9 Create a location message

◆ createFaceMessage:data:()

- (V2TIMMessage *) createFaceMessage:	(int)	index
data:	(NSData *)	data

2.10 Create an emoji message

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.

Parameters

index	Emoji index
data	Custom data

◆ createMergerMessage:title:abstractList:compatibleText:()

- (V2TIMMessage *) createMergerMessage:	(NSArray< V2TIMMessage * > *)	messageList
title:	(NSString *)	title
abstractList:	(NSArray< NSString * > *)	abstractList
compatibleText:	(NSString *)	compatibleText

2.11 Create a combined message (supported only in 5.2.210 and later versions)

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.

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, 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]".
compatibleText	Text to be displayed if the SDK version does not support combined messages. This parameter cannot be null.

◆ createForwardMessage:()

- (V2TIMMessage *) createForwardMessage: (V2TIMMessage *) message

2.12 Create a forward message (supported only in 5.2.210 and later versions)

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.

Parameters

message Message object to be forwarded. The message status must be V2TIM_MSG_STATUS_SEND_SUCC. The message type cannot be V2TIMGroupTipsElem.

Returns: Forward message object. The elem content is the same as the original message.

◆ createTargetedGroupMessage:receiverList:()

- (V2TIMMessage *) createTargetedGroupMessage:	(V2TIMMessage *)	message
receiverList:	(NSMutableArray< NSString * > *)	receiverList

2.13 Create a targeted group message（supported only in 6.0 and later versions）

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.

Parameters

message	Original message object
receiverList	Message receivers

Returns: Targeted group message object

Attention

Please note：

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.

◆ createAtSignedGroupMessage:atUserList:()

- (V2TIMMessage *) createAtSignedGroupMessage:	(V2TIMMessage *)	message
atUserList:	(NSMutableArray< NSString * > *)	atUserList

2.14 Create a group message that mentions others（supported only in 7.0 and later versions）

If you need to send a group message with the mentioning (@) feature, use this API to create a message.

Parameters

message	Original message object
atUserList	List of @ target users. To @all, please pass in the kImSDK_MesssageAtALL constant string. For example, if you want the current message to @denny, @lucy, and @all, pass in @["denny", @"lucy", kImSDK_MesssageAtALL] for atUserList.

Returns: Group @ message object

Attention

The following are use limits 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.

◆ sendMessage:receiver:groupID:priority:onlineUserOnly:offlinePushInfo:progress:succ:fail:()

- (NSString *) sendMessage:	(V2TIMMessage *)	message
receiver:	(NSString *)	receiver
groupID:	(NSString *)	groupID
priority:	(V2TIMMessagePriority)	priority
onlineUserOnly:	(BOOL)	onlineUserOnly
offlinePushInfo:	(V2TIMOfflinePushInfo *)	offlinePushInfo
progress:	(V2TIMProgress)	progress
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

3.1 Send an advanced message (advanced version: provides the features of specifying message priorities and push information)

Parameters

message	Message object to be sent, which needs to be created via the corresponding message creation API
receiver	Message recipient's userID. For a one-to-one message, you only need to specify this field.
groupID	Target group ID. For a group chat message, you only need to specify this field.
priority	Message priorities. This field is valid only for group chat messages. You are advised to set higher priorities for important messages (such as red packet and gift messages) and set lower priorities for frequent but unimportant messages (such as like messages).
onlineUserOnly	Whether the message can be received only by online users. If this field is set to true, the message will not appear in the recipient's historical message list. This field is often used to implement less important notifications such as typing indicators. This field is not supported by audio-video groups (AVChatRoom).
offlinePushInfo	Title and voice carried when the message pushing offline.

Returns: msgID Unique ID of the message

Attention

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.

◆ setC2CReceiveMessageOpt:opt:succ:fail:()

- (void) setC2CReceiveMessageOpt:	(NSArray< NSString * > *)	userIDList
opt:	(V2TIMReceiveMessageOpt)	opt
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

4.1 Set the one-to-one message receiving option for specified users (batch setting supported)

Supported only in 5.3.425 and later versions.

Attention

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.

Parameters

opt There are three message receiving options: 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.

◆ getC2CReceiveMessageOpt:succ:fail:()

- (void) getC2CReceiveMessageOpt:	(NSArray< NSString * > *)	userIDList
succ:	(V2TIMReceiveMessageOptListSucc)	succ
fail:	(V2TIMFail)	fail

4.2 Query the one-to-one message receiving option for specified users

Supported only in 5.3.425 and later versions.

◆ setGroupReceiveMessageOpt:opt:succ:fail:()

- (void) setGroupReceiveMessageOpt:	(NSString *)	groupID
opt:	(V2TIMReceiveMessageOpt)	opt
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

4.3 Set the group message receiving option

Parameters

opt There are five message receiving options: 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.

◆ setAllReceiveMessageOpt:startHour:startMinute:startSecond:duration:succ:fail:()

- (void) setAllReceiveMessageOpt:	(V2TIMReceiveMessageOpt)	opt
startHour:	(int32_t)	startHour
startMinute:	(int32_t)	startMinute
startSecond:	(int32_t)	startSecond
duration:	(uint32_t)	duration
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

4.4 Set message receiving option for all conversations，supported only in 7.4 and later versions.

Parameters

opt	There are two message receiving options for you to choose: 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）
startHour	(0 - 23) The starting hour of the muting duration
startMinute	(0 - 59) The starting minute of the muting duration
startSecond	(0 - 59) The starting second of the muting duration
duration	(0 - 246060) The muting duration in seconds

Attention

When the value of duration is less than 24*60*60, it can be used to implement "Repeated Do Not Disturb" which means the Message Do Not Disturb starts from the time point represented by "startHour:startMinute:startSecond" every day and durations for specified interval represented by this field.
When the duration value is not less than 24*60*60, it can be used to achieve "Permanent Do Not Disturb" which means the Message Do Not Disturb starts from the time point represented by "startHour:startMinute:startSecond" and keep going for ever.

◆ setAllReceiveMessageOpt:startTimeStamp:duration:succ:fail:()

- (void) setAllReceiveMessageOpt:	(V2TIMReceiveMessageOpt)	opt
startTimeStamp:	(uint32_t)	startTimeStamp
duration:	(uint32_t)	duration
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

4.5 Set message receiving option for all conversations，supported only in 7.4 and later versions.

Parameters

opt	There are two message receiving options for you to choose: 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）
startTimeStamp	The start time of muting, UTC timestamp, unit: second
duration	The muting duration in seconds

◆ getAllReceiveMessageOpt:fail:()

- (void) getAllReceiveMessageOpt:	(V2TIMReceiveMessageOptSucc)	succ
fail:	(V2TIMFail)	fail

4.6 Get the all Message receiving option，supported only in 7.4 and later versions.

◆ getC2CHistoryMessageList:count:lastMsg:succ:fail:()

- (void) getC2CHistoryMessageList:	(NSString *)	userID
count:	(int)	count
lastMsg:	(V2TIMMessage *)	lastMsg
succ:	(V2TIMMessageListSucc)	succ
fail:	(V2TIMFail)	fail

5.1 Get historical one-to-one messages

Parameters

count	Number of messages pulled at a time. The value of this field cannot be too large; otherwise, the pulling speed is affected. We recommend that you pull 20 messages at a time.
lastMsg	Start message for message pulling. If null is passed in, the newest message of the conversation will be considered as the start message.

Attention

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.

◆ getGroupHistoryMessageList:count:lastMsg:succ:fail:()

- (void) getGroupHistoryMessageList:	(NSString *)	groupID
count:	(int)	count
lastMsg:	(V2TIMMessage *)	lastMsg
succ:	(V2TIMMessageListSucc)	succ
fail:	(V2TIMFail)	fail

5.2 Get historical group messages

Parameters

count	Number of messages pulled at a time. The value of this field cannot be too large; otherwise, the pulling speed is affected. We recommend that you pull 20 messages at a time.
lastMsg	Start message for message pulling. If null is passed in, the newest message of the conversation will be considered as the start message.

Attention

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.

◆ getHistoryMessageList:succ:fail:()

- (void) getHistoryMessageList:	(V2TIMMessageListGetOption *)	option
succ:	(V2TIMMessageListSucc)	succ
fail:	(V2TIMFail)	fail

5.3 Get historical messages (advanced API)

Parameters

option Message pulling option, which can be set to pull older or newer messages from local storage or the cloud

Attention

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 connected, when the option param is set to pull cloud historical messages, calling this API 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.

◆ revokeMessage:succ:fail:()

- (void) revokeMessage:	(V2TIMMessage *)	msg
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

5.4 Recall messages

Attention

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.

◆ modifyMessage:completion:()

- (void) modifyMessage:	(V2TIMMessage *)	msg
completion:	(V2TIMMessageModifyCompletion)	completion

5.5 Modify a message

Attention

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.

◆ deleteMessageFromLocalStorage:succ:fail:()

- (void) deleteMessageFromLocalStorage:	(V2TIMMessage *)	msg
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

5.6 Delete a message from local storage

Attention: Messages can only be deleted locally. After a message is deleted, the SDK marks the message as deleted locally, and the message can no longer be pulled via getHistoryMessage. 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.

◆ deleteMessages:succ:fail:()

- (void) deleteMessages:	(NSArray< V2TIMMessage * > *)	msgList
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

5.7 Delete messages from local storage and the cloud

Attention

In addition to deleting messages from the local storage (deleteMessageFromLocalStorage), this API simultaneously deletes messages from the cloud, and the deleted messages cannot be recovered. Please note that:

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.

◆ clearC2CHistoryMessage:succ:fail:()

- (void) clearC2CHistoryMessage:	(NSString *)	userID
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

5.8 Clear chat history with a user from local storage and the cloud (without deleting the conversation)

Supported only in 5.4.666 and later versions.

Attention

When messages in a conversation are deleted from local storage, they are deleted simultaneously from the server.

◆ clearGroupHistoryMessage:succ:fail:()

- (void) clearGroupHistoryMessage:	(NSString *)	groupID
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

5.9 Clear chat history of a group from local storage and the cloud (without deleting the conversation)

Supported only in 5.4.666 and later versions.

Attention

When messages in a conversation are deleted from local storage, they are also deleted from the server.

◆ insertGroupMessageToLocalStorage:to:sender:succ:fail:()

- (NSString *) insertGroupMessageToLocalStorage:	(V2TIMMessage *)	msg
to:	(NSString *)	groupID
sender:	(NSString *)	sender
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

5.10 Add a message to the group message list

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.

Returns: msgID Unique ID of a message

Attention: Messages saved via this API are saved only to the local storage and will get lost after the app is uninstalled.

◆ insertC2CMessageToLocalStorage:to:sender:succ:fail:()

- (NSString *) insertC2CMessageToLocalStorage:	(V2TIMMessage *)	msg
to:	(NSString *)	userID
sender:	(NSString *)	sender
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

5.11 Insert a message in a one-to-one chat

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.

Returns: msgID Unique ID of a message

Attention: Messages saved via this API are saved only to the local storage and will get lost after the app is uninstalled.

◆ findMessages:succ:fail:()

- (void) findMessages:	(NSArray< NSString * > *)	messageIDList
succ:	(V2TIMMessageListSucc)	succ
fail:	(V2TIMFail)	fail

5.12 Query local messages in a specified conversation by messageID, including messages with the status V2TIM_MSG_STATUS_LOCAL_REVOKED (recalled) and V2TIM_MSG_STATUS_HAS_DELETED (deleted).

Parameters

messageIDList Message ID list

Attention: Distinguish the status of a message by its status in V2TIMMessage

◆ searchLocalMessages:succ:fail:()

- (void) searchLocalMessages:	(V2TIMMessageSearchParam *)	param
succ:	(V2TIMSearchMessageListSucc)	succ
fail:	(V2TIMFail)	fail

5.13 Search for local messages (supported only in Chat Premium 5.4.666 and later versions)

Parameters

searchParam Message search parameter. For details, see the definition of V2TIMMessageSearchParam.

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

◆ searchCloudMessages:succ:fail:()

- (void) searchCloudMessages:	(V2TIMMessageSearchParam *)	param
succ:	(V2TIMSearchMessageListSucc)	succ
fail:	(V2TIMFail)	fail

5.14 Search for cloud messages (supported only in 7.3 and later versions)

Parameters

searchParam Message search parameter. For details, see the definition of V2TIMMessageSearchParam.

Attention

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).

◆ sendMessageReadReceipts:succ:fail:()

- (void) sendMessageReadReceipts:	(NSArray< V2TIMMessage * > *)	messageList
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

5.15 Send read receipts to the message sender (supported only in Chat Premium 6.1 and later versions）

Attention

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.

◆ getMessageReadReceipts:succ:fail:()

- (void) getMessageReadReceipts:	(NSArray< V2TIMMessage * > *)	messageList
succ:	(V2TIMMessageReadReceiptsSucc)	succ
fail:	(V2TIMFail)	fail

5.16 Get read receipts for messages sent (Supported only in Chat Premium 6.1 and later versions)

Attention

To obtain read receipts 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.

◆ getGroupMessageReadMemberList:filter:nextSeq:count:succ:fail:()

- (void) getGroupMessageReadMemberList:	(V2TIMMessage *)	message
filter:	(V2TIMGroupMessageReadMembersFilter)	filter
nextSeq:	(uint64_t)	nextSeq
count:	(uint32_t)	count
succ:	(V2TIMGroupMessageReadMemberListSucc)	succ
fail:	(V2TIMFail)	fail

5.17 Get group members who have read a group message (Supported only in Chat Premium 6.1 and later)

Parameters

message	group message
filter	Whether to get members who have or who have not read the message.
nextSeq	Pulling-by-page cursor. It is set to 0 when the information is pulled for the first time. The value of this field in the callback for the current paginated pulling is passed in for the next pull.
count	Number of members (max 100) pulled per page.

Attention

Please go to the console and turn on the corresponding switch before using this feature.

◆ setMessageExtensions:extensions:succ:fail:()

- (void) setMessageExtensions:	(V2TIMMessage *)	message
extensions:	(NSArray< V2TIMMessageExtension * > *)	extensions
succ:	(V2TIMMessageExtensionsSetSucc)	succ
fail:	(V2TIMFail)	fail

5.18 Set message extensions (supported only in 6.7 and later versions)

Parameters

message	The target message must be sent successfully and its supportMessageExtension field must be set to YES before sending. In addition, AVChatRoom message do not support this feature.
extensions	The existing message extensions will be updated, and non-existing message extensions will be added directly.

Attention

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.

◆ getMessageExtensions:succ:fail:()

- (void) getMessageExtensions:	(V2TIMMessage *)	message
succ:	(V2TIMMessageExtensionsGetSucc)	succ
fail:	(V2TIMFail)	fail

5.19 Get message extensions (supported only in 6.7 and later versions)

◆ deleteMessageExtensions:keys:succ:fail:()

- (void) deleteMessageExtensions:	(V2TIMMessage *)	message
keys:	(NSArray< NSString * > *)	keys
succ:	(V2TIMMessageExtensionsDeleteSucc)	succ
fail:	(V2TIMFail)	fail

5.20 Delete message extensions (supported only in 6.7 and later versions)

Parameters

keys	Message extension key list. If this is null, it means to delete all extensions of the message.

Attention

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.

◆ addMessageReaction:reactionID:succ:fail:()

- (void) addMessageReaction:	(V2TIMMessage *)	message
reactionID:	(NSString *)	reactionID
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

5.21 Add a message reaction (can be used for emoji response) (supported only in 7.4 and later versions)

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.

Attention

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.

◆ removeMessageReaction:reactionID:succ:fail:()

- (void) removeMessageReaction:	(V2TIMMessage *)	message
reactionID:	(NSString *)	reactionID
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

5.22 Remove message reaction (supported only in 7.4 and later versions)

Attention

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.

◆ getMessageReactions:maxUserCountPerReaction:succ:fail:()

- (void) getMessageReactions:	(NSArray< V2TIMMessage * > *)	messageList
maxUserCountPerReaction:	(uint32_t)	maxUserCountPerReaction
succ:	(V2TIMGetMessageReactionsSucc)	succ
fail:	(V2TIMFail)	fail

5.23 Get message reactions (supported only in 7.4 and later versions)

Parameters

messageList	Message list, supports up to 20 messages at a time, which must belong to the same conversation.
maxUserCountPerReaction	The value range is 【0,10】. Every reaction only supports returning the first 10 user profile at most. If you need more user profile, you can call the getAllUserListOfMessageReaction interface to pull in pages.

Attention

You need to buy Premium Edition to use this feature.

◆ getAllUserListOfMessageReaction:reactionID:nextSeq:count:succ:fail:()

- (void) getAllUserListOfMessageReaction:	(V2TIMMessage *)	message
reactionID:	(NSString *)	reactionID
nextSeq:	(uint32_t)	nextSeq
count:	(uint32_t)	count
succ:	(V2TIMGetMessageReactionUserListSucc)	succ
fail:	(V2TIMFail)	fail

5.24 Get a list of users who responded with an emoji (supported only in 7.4 and later versions)

Parameters

message	Message object
reactionID	Message reaction ID
nextSeq	The pulling-by-page cursor. Pass 0 for the first time, and pass the nextSeq returned by succ for subsequent pagination.
count	The maximum count of users fetched per page, up to 100.

Attention

You need to buy Premium Edition to use this feature.

◆ translateText:sourceLanguage:targetLanguage:completion:()

- (void) translateText:	(NSArray< NSString * > *)	sourceTextList
sourceLanguage:	(NSString *)	source
targetLanguage:	(NSString *)	target
completion:	(void(^)(int code, NSString desc, NSDictionary< NSString , NSString * > *result))	callback

5.25 Translate text message.

Parameters

sourceTextList	Texts to be translated.
source	Source language. You can pass the specific language or "auto". "auto" means identifying the source language automatically. If you set it to nil, "auto" will be filled as default.
target	Target language. Multi languages are supported, like: English-"en", Simplified Chinese-"zh", French-"fr", German-"ge" and so on. For more languages, please refer to this documentation: Language support.
callback	Translated result callback. The key represents the source text and value represents target text.

◆ pinGroupMessage:message:isPinned:succ:fail:()

- (void) pinGroupMessage:	(NSString *)	groupID
message:	(V2TIMMessage *)	message
isPinned:	(BOOL)	isPinned
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

5.26 Set the group message to the top（supported only in Chat Premium 7.9 and later versions）

Parameters

groupID	Group ID
isPinned	Whether to pin it to the top

Attention

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.

◆ getPinnedGroupMessageList:succ:fail:()

- (void) getPinnedGroupMessageList:	(NSString *)	groupID
succ:	(V2TIMPinnedMessageListSucc)	succ
fail:	(V2TIMFail)	fail

5.27 Get the list of pinned group messages（supported only in Chat Premium 7.9 and later versions）

Parameters

groupID Group ID

Attention

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

◆ markC2CMessageAsRead:succ:fail:()

- (void) markC2CMessageAsRead:	(NSString *)	userID
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

5.28 Mark all messages of a one-to-one conversation as read (This is to be deprecated. Please call cleanConversationUnreadMessageCount instead.)

Attention

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.

◆ markGroupMessageAsRead:succ:fail:()

- (void) markGroupMessageAsRead:	(NSString *)	groupID
succ:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

5.29 Mark all messages of a group chat as read (This is to be deprecated. Please call cleanConversationUnreadMessageCount instead.)

Attention

After the API is successfully called, your unread count will be cleared to 0.
If groupID is null, all group messages will be marked as read. This is only supported in 5.8 and later versions.

◆ markAllMessageAsRead:fail:()

- (void) markAllMessageAsRead:	(V2TIMSucc)	succ
fail:	(V2TIMFail)	fail

5.30 Mark all messages as read (This is to be deprecated. Please call cleanConversationUnreadMessageCount instead.)

Field Documentation

◆ kImSDK_MesssageAtALL

- (NSString* const) kImSDK_MesssageAtALL

protected

A constant string indicateds @all when filled in createTextAtMessage API.

Instance Methods

Member Typedef Documentation

◆ V2TIMMessageListSucc

◆ V2TIMSearchMessageListSucc

◆ V2TIMProgress

◆ V2TIMDownLoadProgress

◆ V2TIMReceiveMessageOptListSucc

◆ V2TIMReceiveMessageOptSucc

◆ V2TIMMessageReadReceiptsSucc

◆ V2TIMGroupMessageReadMemberListSucc

◆ V2TIMMessageModifyCompletion

◆ V2TIMMessageExtensionsSetSucc

◆ V2TIMMessageExtensionsGetSucc

◆ V2TIMMessageExtensionsDeleteSucc

◆ V2TIMGetMessageReactionsSucc

◆ V2TIMGetMessageReactionUserListSucc

◆ V2TIMPinnedMessageListSucc

Member Enumeration Documentation

◆ V2TIMMessageStatus

◆ V2TIMElemType

◆ V2TIMOfflinePushFlag

◆ V2TIMImageType

◆ V2TIMGroupTipsType

◆ V2TIMGroupInfoChangeType

◆ V2TIMMessageGetType

◆ V2TIMReceiveMessageOpt

◆ V2TIMKeywordListMatchType

◆ V2TIMGroupMessageReadMembersFilter

◆ V2TIMIOSOfflinePushType

Method Documentation

◆ addAdvancedMsgListener:()

◆ removeAdvancedMsgListener:()

◆ createTextMessage:()

◆ createTextAtMessage:atUserList:()

◆ createCustomMessage:()

◆ createCustomMessage:desc:extension:()

◆ createImageMessage:()

◆ createSoundMessage:duration:()

◆ createVideoMessage:type:duration:snapshotPath:()

◆ createFileMessage:fileName:()

◆ createLocationMessage:longitude:latitude:()

◆ createFaceMessage:data:()

◆ createMergerMessage:title:abstractList:compatibleText:()

◆ createForwardMessage:()

◆ createTargetedGroupMessage:receiverList:()

◆ createAtSignedGroupMessage:atUserList:()

◆ sendMessage:receiver:groupID:priority:onlineUserOnly:offlinePushInfo:progress:succ:fail:()

◆ setC2CReceiveMessageOpt:opt:succ:fail:()

◆ getC2CReceiveMessageOpt:succ:fail:()

◆ setGroupReceiveMessageOpt:opt:succ:fail:()

◆ setAllReceiveMessageOpt:startHour:startMinute:startSecond:duration:succ:fail:()

◆ setAllReceiveMessageOpt:startTimeStamp:duration:succ:fail:()

◆ getAllReceiveMessageOpt:fail:()

◆ getC2CHistoryMessageList:count:lastMsg:succ:fail:()

◆ getGroupHistoryMessageList:count:lastMsg:succ:fail:()

◆ getHistoryMessageList:succ:fail:()

◆ revokeMessage:succ:fail:()

◆ modifyMessage:completion:()

◆ deleteMessageFromLocalStorage:succ:fail:()

◆ deleteMessages:succ:fail:()

◆ clearC2CHistoryMessage:succ:fail:()

◆ clearGroupHistoryMessage:succ:fail:()

◆ insertGroupMessageToLocalStorage:to:sender:succ:fail:()

◆ insertC2CMessageToLocalStorage:to:sender:succ:fail:()

◆ findMessages:succ:fail:()

◆ searchLocalMessages:succ:fail:()

◆ searchCloudMessages:succ:fail:()

◆ sendMessageReadReceipts:succ:fail:()

◆ getMessageReadReceipts:succ:fail:()

◆ getGroupMessageReadMemberList:filter:nextSeq:count:succ:fail:()

◆ setMessageExtensions:extensions:succ:fail:()

◆ getMessageExtensions:succ:fail:()

◆ deleteMessageExtensions:keys:succ:fail:()

◆ addMessageReaction:reactionID:succ:fail:()

◆ removeMessageReaction:reactionID:succ:fail:()

◆ getMessageReactions:maxUserCountPerReaction:succ:fail:()

◆ getAllUserListOfMessageReaction:reactionID:nextSeq:count:succ:fail:()

◆ translateText:sourceLanguage:targetLanguage:completion:()

◆ pinGroupMessage:message:isPinned:succ:fail:()

◆ getPinnedGroupMessageList:succ:fail:()