Interface
ZIMAllRoomLeftResult
Callback for the results of leaving all rooms.
Properties
roomIDs
roomIDs: string[] Room IDs.
ZIMAppConfig
ZIM application configuration, including AppID and AppSign.
Properties
appID
appID: number - Required: Required.
appSign
appSign: string - Required: Required.
ZIMAudioANSParam
ANS Parameter
Details
Includes noise suppression mode.
Properties
mode
ZIMAudioError
Details
It can be used to record the error type and error information generated by the SDK, check the error code table on the ZEGO official website, and seek assistance from ZEGO technical support.
Properties
code
code: ZIMAudioErrorCode Error code.
message
message: string It can be used to record the error type and error information generated by the SDK, check the error code table on the ZEGO official website, and seek assistance from ZEGO technical support.
ZIMAudioFrameParam
Details
Audio frame attribute parameters.
Properties
sampleRate
sampleRate: Number The audio sample rate.
channels
channels: Number The number of audio channels.
ZIMAudioMessage
Audio message object.
Details
Identifies the basic parameters of a message.
- Caution: If the Type parameter of the base class is Audio during callback, you can force the base class message object to be of this type.
Properties
audioDuration
audioDuration: number - Required: Required by the sender, if not filled, the audio message will fail to be sent When sending local audio messages.
fileLocalPath
fileLocalPath: string - Required: If a local file is sent, this parameter must be set by the sender. Otherwise, the message fails to be sent.
fileDownloadUrl
fileDownloadUrl: string Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.
Required or not: If an external URL is sent, this parameter is mandatory on the sender end.
fileUID
fileUID: string Detail description: The unique ID of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
fileName
fileName: string Detail description: The filename of the media file.
Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.
fileSize
fileSize: number Detail description: The size of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
type
messageID
messageID: string The unique ID that identifies this message.
- Use cases: Can be used to index other messages.
- Caution: When the developer actively creates a message, there is no need to modify this parameter. This parameter only has a value during callback.
timestamp
timestamp: number Identifies the sending time of a message
- Use cases: Used to present the sending time of a message, and can be used for message sorting.
- Caution: This is a standard UNIX timestamp, in milliseconds.
senderUserID
senderUserID: string Displays the userID of the sender of this message.
conversationID
conversationID: string Conversation ID. Ids of the same conversation type are unique.
direction
sentStatus
conversationType
conversationType: ZIMConversationType The type of conversation to which the message belongs.
conversationSeq
conversationSeq: number Indicates the sequence number of the message in the conversation.
orderKey
orderKey: number The larger the orderKey, the newer the message, and can be used for ordering messages.
localMessageID
localMessageID: string SDK locally generated MessageID, developers do not need to pay attention to.
isUserInserted
isUserInserted: boolean Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].
Default: false.
receiptStatus
receiptStatus: ZIMMessageReceiptStatus Describe the receipt status of the message
Business scenario: used to determine the status of the current message in the receipt message
extendedData
extendedData: string message extension field
- Use cases: You can add extended fields to the message and send it to the peer
- Required: no
- Caution: the length is 1k, you can contact technical support for configuration
- Available since: 2.6.0 or higher
localExtendedData
localExtendedData: string The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
isBroadcastMessage
isBroadcastMessage: boolean Whether the message is pushed by all employees.
- Required: Internal assignment.
isMentionAll
isMentionAll: boolean Whether to mention everyone. It can be presented as "@Everyone".
- Use cases: For example, it can be used in groups or rooms.
- Required: No.
- Default value: false.
- Recommended value: Set to true if you need to mention everyone.
- Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
mentionedUserIDs
mentionedUserIDs: string[] Whether to mention everyone. It can be presented as "@User".
- Use cases: For example, it can be used in sending messages.
- Required: No.
- Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
messageSeq
messageSeq: number Indicates the sequence number of the message in the conversation.
rootRepliedCount
rootRepliedCount: number The number of reply messages corresponding to the root message of the reply message tree.
repliedInfo
repliedInfo: ZIMMessageRepliedInfo Information about the source message referenced by the reply message.
editorUserID
editorUserID: string The latest editor's userID for this message.
editedTime
editedTime: number The latest editing timestamp for this message.
isGroupTargetedMessage
isGroupTargetedMessage: boolean Identify if this message is group targeted message.
pinnedUserID
pinnedUserID: string The last user who pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
pinnedTime
pinnedTime: number The last timestamp when pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
ZIMAudioMessageLiteInfo
Audio message lite info object.
Details
Identifies the basic parameters of a audio message.
Properties
audioDuration
audioDuration: number - Required: Required by the sender, if not filled, the audio message will fail to be sent When sending local audio messages.
fileLocalPath
fileLocalPath: string - Required: If a local file is sent, this parameter must be set by the sender. Otherwise, the message fails to be sent.
fileDownloadUrl
fileDownloadUrl: string Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.
Required or not: If an external URL is sent, this parameter is mandatory on the sender end.
fileName
fileName: string Detail description: The filename of the media file.
Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.
fileSize
fileSize: number Detail description: The size of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
type
ZIMAudioPlayConfig
Audio Playback Configuration
Details
Playing configuration. Configuration specifies the audio file path and routing type that currently need to be played.
Properties
filePath
filePath: string The absolute path of the file needs to be played. Currently, only full absolute paths with the suffix .mp3 or .m4a are supported. When passing in file paths in other formats, the SDK will throw an illegal file path error.
routeType
ZIMAudioRecordConfig
Audio Recording Configuration
Details
Configure the recording file output path and maximum recording time during recording.
Properties
filePath
filePath: string The output path of the recording file. Currently, only full absolute paths with the suffix .mp3 or .m4a are supported. When passing in file paths in other formats, the SDK will throw an illegal file path error.
maxDuration
maxDuration: number The maximum recording time, the default is 60000 ms, which is 60s. The unit of this parameter is milliseconds, and the maximum value does not exceed 300000.
ZIMBarrageMessage
Barrage message class.
Details
The barrage message class does not appear in the session and does not store historical messages.
Properties
message
message: string The content of barrage message.
type
messageID
messageID: string The unique ID that identifies this message.
- Use cases: Can be used to index other messages.
- Caution: When the developer actively creates a message, there is no need to modify this parameter. This parameter only has a value during callback.
timestamp
timestamp: number Identifies the sending time of a message
- Use cases: Used to present the sending time of a message, and can be used for message sorting.
- Caution: This is a standard UNIX timestamp, in milliseconds.
senderUserID
senderUserID: string Displays the userID of the sender of this message.
conversationID
conversationID: string Conversation ID. Ids of the same conversation type are unique.
direction
sentStatus
conversationType
conversationType: ZIMConversationType The type of conversation to which the message belongs.
conversationSeq
conversationSeq: number Indicates the sequence number of the message in the conversation.
orderKey
orderKey: number The larger the orderKey, the newer the message, and can be used for ordering messages.
localMessageID
localMessageID: string SDK locally generated MessageID, developers do not need to pay attention to.
isUserInserted
isUserInserted: boolean Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].
Default: false.
receiptStatus
receiptStatus: ZIMMessageReceiptStatus Describe the receipt status of the message
Business scenario: used to determine the status of the current message in the receipt message
extendedData
extendedData: string message extension field
- Use cases: You can add extended fields to the message and send it to the peer
- Required: no
- Caution: the length is 1k, you can contact technical support for configuration
- Available since: 2.6.0 or higher
localExtendedData
localExtendedData: string The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
isBroadcastMessage
isBroadcastMessage: boolean Whether the message is pushed by all employees.
- Required: Internal assignment.
isMentionAll
isMentionAll: boolean Whether to mention everyone. It can be presented as "@Everyone".
- Use cases: For example, it can be used in groups or rooms.
- Required: No.
- Default value: false.
- Recommended value: Set to true if you need to mention everyone.
- Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
mentionedUserIDs
mentionedUserIDs: string[] Whether to mention everyone. It can be presented as "@User".
- Use cases: For example, it can be used in sending messages.
- Required: No.
- Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
messageSeq
messageSeq: number Indicates the sequence number of the message in the conversation.
rootRepliedCount
rootRepliedCount: number The number of reply messages corresponding to the root message of the reply message tree.
repliedInfo
repliedInfo: ZIMMessageRepliedInfo Information about the source message referenced by the reply message.
editorUserID
editorUserID: string The latest editor's userID for this message.
editedTime
editedTime: number The latest editing timestamp for this message.
isGroupTargetedMessage
isGroupTargetedMessage: boolean Identify if this message is group targeted message.
pinnedUserID
pinnedUserID: string The last user who pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
pinnedTime
pinnedTime: number The last timestamp when pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
ZIMBlacklistCheckedResult
Return of results confirming whether the user has been blacklisted.
Details
Return of results confirming whether the user has been blacklisted.
- Use cases: After confirming whether the user has been blocked, the success or failure can be known through this callback.
Related API: [checkUserIsInBlacklist],Check if the user has been blacklisted.
Properties
isUserInBlacklist
isUserInBlacklist: boolean Whether the user has been blacklisted.
ZIMBlacklistQueriedResult
Return of blacklist query results.
Details
Return of results for querying blacklist.
- Use cases: After querying the blacklist, the success or failure can be known through this callback.
Related API: [queryBlacklist],querying the blacklist.
Properties
blacklist
nextFlag
nextFlag: number The index of the current query anchor point.
ZIMBlacklistQueryConfig
Query the blacklist configuration.
Details
Through this configuration, you can set the total number of queries and the pagination query.
Properties
count
count: number count.
- Required: Required.
nextFlag
nextFlag: number nextFlag.
- Required: Not required, it is 0 by default for the first time, which means to start the query from the beginning.
ZIMBlacklistUsersAddedResult
Return of results for adding user to blacklist.
Details
Return of results for adding user to blacklist.
- Use cases: After adding a user to the blacklist, the success or failure can be known through this callback.
Related API: [addUsersToBlacklist], adding user to blacklist.
Properties
errorUserList
errorUserList: ZIMErrorUserInfo[] List of failed messages for adding users to the blacklist.
ZIMBlacklistUsersRemovedResult
Return of results for removing users from blacklist.
Details
Return of results for removing users from blacklist.
- Use cases: After removing users from the blacklist, the success or failure can be known through this callback.
Related API: [removeUsersFromBlacklist], adding user to blacklist.
Properties
errorUserList
errorUserList: ZIMErrorUserInfo[] List of failed messages for removing users from the blacklist.
ZIMCacheConfig
Cache configuration
Details
Configure the storage path of cache files (such as chat records).
Properties
cachePath
cachePath: string The storage path of the cache files. Refer to the official website document for the default path.
ZIMCallAcceptConfig
Behavior property set by accepting a call invitation.
Details
Behavior property set by accepting a call invitation.
Properties
extendedData
extendedData: string Extended field, through which the inviter can carry information to the invitee.
- Required: Required.
ZIMCallAcceptanceSentResult
Call acceptance sent message.
Properties
callID
callID: string call ID.
ZIMCallCancelConfig
Behavior property that cancels the call invitation setting.
Details
Behavior property that cancels the call invitation setting.
Properties
extendedData
extendedData: string Extended field, through which the inviter can carry information to the invitee.
- Required: not required.
- Default value: "".
pushConfig
ZIMCallCancelSentResult
Call cancel sent message.
Details
Call cancel sent message.
Properties
errorInvitees
errorInvitees: string[] The user ID who failed to cancel the call invitation.
callID
callID: string call ID.
ZIMCallEndConfig
End the behavior attribute of the call invitation setting.
Details
End the behavior attribute of the call invitation setting.
Properties
extendedData
extendedData: string Extended field, through which the inviter can carry information to the invitee.
- Required: not required.
pushConfig
ZIMCallEndSentResult
End the return result of the current call.
Properties
callID
callID: string call ID.
createTime
createTime: number Time stamp of creating the call invitation.
acceptTime
acceptTime: number The current user accepts the time stamp of the call invitation.
endTime
endTime: number End the current call invitation time stamp.
ZIMCallInfo
Call invitation information.
Details
Call invitation information.
Properties
callID
callID: string Call invite ID.
caller
caller: string Call invitation initiator ID.
mode
state
extendedData
extendedData: string Create a call invitation additional information.
createTime
createTime: number Call invites to create a timestamp.
endTime
endTime: number Call invitation end time.
callUserList
ZIMCallInvitationListQueriedResult
Query the return result of the call invitation list.
Properties
callList
nextFlag
nextFlag: number The flag of the paging query. For the first query, set this field to an empty string. If the "nextFlag" field of the callback is not an empty string, it needs to be set here to continue the query on the next page.
ZIMCallInvitationQueryConfig
Inquiry the setting attribute of the call invitation list
Details
Inquiry the setting attribute of the call invitation list
Properties
count
count: number The query number is limited to up to 100.
- Required: required.
nextFlag
nextFlag: number The flag of the query list.No padding is required for the first query. After the query, callback will return a nextFlag, which can be filled in the next query to continue the query based on the last query.
- Required: not required.
ZIMCallInvitationSentResult
Call invitation sent message.
Details
Call invitation sent message.
Properties
timeout
timeout: number The timeout setting of the call invitation, the unit is seconds.
errorInvitees
callID
callID: string call ID.
errorUserList
errorUserList: ZIMErrorUserInfo[] User id that has not received a call invitation and the reason.
ZIMCallInviteConfig
The behavior property of the Send Call Invitation setting.
Details
The behavior property of the Send Call Invitation setting.
Properties
timeout
timeout: number The timeout setting of the call invitation, the unit is seconds. The range is [1, 600].
- Required: not required.
Default: 90.
extendedData
extendedData: string Extended field, through which the inviter can carry information to the invitee.
pushConfig
mode
mode: ZIMCallInvitationMode Call invitation mode configuration. Supported Version: 2.9.0 or later.
- Required: required. default：GENERAL
enableNotReceivedCheck
enableNotReceivedCheck: boolean If the pass value is true, the system checks whether the call invitation is delivered in this call and subsequent calls.
- Use cases: After the calling party sends a call invitation, if the called party does not receive the invitation within 5 seconds (3 or 4 seconds can be configured for technical support) because the user is disconnected or not online, the user status changes to notYetReceived. You can use this state flow to indicate to the user that the user may not be online. If the called party goes online before the call times out, the status changes to received received.
- Required: This is not required.
- Default value: false
- Recommended value: This property takes effect in version 2.15.0 and later, when the new version sends an invitation to a call with delivery detection turned on to the old version, which will continue to display the inviting status instead of notYetReceived.
ZIMCallJoinConfig
Add the behavior attribute of the call invitation setting.
Details
Add the behavior attribute of the call invitation setting.
Properties
extendedData
extendedData: string Extended field, through which the inviter can carry information to the invitee.
ZIMCallJoinSentResult
Result callback of joining the call invitation.
Properties
callID
callID: string call ID.
createTime
createTime: number Timestamp of the time when the call invitation was created.
joinTime
joinTime: number Time stamp of the person join the call invitation.
extendedData
extendedData: string The pass-through field that comes with invoking the end of the call.
callUserList
callUserList: ZIMCallUserInfo[] List of user information in the current call invitation.
ZIMCallQuitConfig
Behavior property set by quit a call invitation.
Details
Behavior property set by quit a call invitation.
Properties
extendedData
extendedData: string Extended field, through which the inviter can carry information to the invitee.
- Required: Required.
pushConfig
ZIMCallQuitSentResult
Exit the return result of the current call.
Properties
callID
callID: string call ID.
createTime
createTime: number Time stamp of creating the call invitation.
acceptTime
acceptTime: number The current user accepts the time stamp of the call invitation.
quitTime
quitTime: number The current user withdraws from the time stamp of the call invitation.
ZIMCallRejectConfig
This parameter is used to set the configuration item of call invitation rejection.
Details
This command is used to customize the call invitation when sending invitation rejection.
- Use cases: You need to pass the configuration item to the interface when invoking the call rejection invitation.
Properties
extendedData
extendedData: string Additional fields for attaching custom content when sending a reject invitation.
- Use cases: When the user needs to refuse to send some custom content to the inviter.
- Required: Required.
- Default value: "".
ZIMCallRejectionSentResult
Call rejection sent message.
Properties
callID
callID: string call ID.
ZIMCallUserInfo
Call invitation user information.
Details
Call invitation user information.
Properties
userID
userID: string User ID, a string with a maximum length of 32 bytes or less. It is customized by the developer. Only support numbers, English characters and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.
state
extendedData
extendedData: string Call the additional information in user information.
ZIMCallingInvitationSentResult
Invite others to enter the call back result information.
Properties
callID
callID: string call ID.
errorInvitees
errorInvitees: ZIMErrorUserInfo[] User id that has not received a call invitation and the reason.
ZIMCallingInviteConfig
Behavior property set by quit a call invitation.
Details
Behavior property set by quit a call invitation.
Properties
pushConfig
ZIMCombineMessage
Base class for combine message objects.
- Available since: 2.14.0 and above.
Properties
title
title: string The title of combine message
summary
summary: string The summary of combine message
combineID
combineID: string Combine ID, internal user
messageList
type
messageID
messageID: string The unique ID that identifies this message.
- Use cases: Can be used to index other messages.
- Caution: When the developer actively creates a message, there is no need to modify this parameter. This parameter only has a value during callback.
timestamp
timestamp: number Identifies the sending time of a message
- Use cases: Used to present the sending time of a message, and can be used for message sorting.
- Caution: This is a standard UNIX timestamp, in milliseconds.
senderUserID
senderUserID: string Displays the userID of the sender of this message.
conversationID
conversationID: string Conversation ID. Ids of the same conversation type are unique.
direction
sentStatus
conversationType
conversationType: ZIMConversationType The type of conversation to which the message belongs.
conversationSeq
conversationSeq: number Indicates the sequence number of the message in the conversation.
orderKey
orderKey: number The larger the orderKey, the newer the message, and can be used for ordering messages.
localMessageID
localMessageID: string SDK locally generated MessageID, developers do not need to pay attention to.
isUserInserted
isUserInserted: boolean Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].
Default: false.
receiptStatus
receiptStatus: ZIMMessageReceiptStatus Describe the receipt status of the message
Business scenario: used to determine the status of the current message in the receipt message
extendedData
extendedData: string message extension field
- Use cases: You can add extended fields to the message and send it to the peer
- Required: no
- Caution: the length is 1k, you can contact technical support for configuration
- Available since: 2.6.0 or higher
localExtendedData
localExtendedData: string The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
isBroadcastMessage
isBroadcastMessage: boolean Whether the message is pushed by all employees.
- Required: Internal assignment.
isMentionAll
isMentionAll: boolean Whether to mention everyone. It can be presented as "@Everyone".
- Use cases: For example, it can be used in groups or rooms.
- Required: No.
- Default value: false.
- Recommended value: Set to true if you need to mention everyone.
- Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
mentionedUserIDs
mentionedUserIDs: string[] Whether to mention everyone. It can be presented as "@User".
- Use cases: For example, it can be used in sending messages.
- Required: No.
- Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
messageSeq
messageSeq: number Indicates the sequence number of the message in the conversation.
rootRepliedCount
rootRepliedCount: number The number of reply messages corresponding to the root message of the reply message tree.
repliedInfo
repliedInfo: ZIMMessageRepliedInfo Information about the source message referenced by the reply message.
editorUserID
editorUserID: string The latest editor's userID for this message.
editedTime
editedTime: number The latest editing timestamp for this message.
isGroupTargetedMessage
isGroupTargetedMessage: boolean Identify if this message is group targeted message.
pinnedUserID
pinnedUserID: string The last user who pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
pinnedTime
pinnedTime: number The last timestamp when pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
ZIMCombineMessageDetailQueriedResult
Callback of the result of querying combine message.
Details
A callback that executes the result after the developer pulls the details of the combine message.
- When to call: This callback is triggered when a developer invokes the [queryCombineMessageDetail] interface.
- Caution: Use [queryCombineMessageDetail] to pull the details of the combine message, and the success of the pull will be notified through this callback.
- Available since: 2.5.0 or above.
Properties
message
ZIMCombineMessageLiteInfo
Base class for combine message lite info objects.
Details
Detail description: Identifies a combine message.
Properties
title
title: string The title of combine message
summary
summary: string The summary of combine message
type
ZIMCommandMessage
Custom binary message object.
Details
Identifies a binary message.
- Caution: If the Type parameter of the base class is Custom during callback, you can force the base class message object to be of this type.
Properties
message
message: Uint8Array The content of the custom message.
type
messageID
messageID: string The unique ID that identifies this message.
- Use cases: Can be used to index other messages.
- Caution: When the developer actively creates a message, there is no need to modify this parameter. This parameter only has a value during callback.
timestamp
timestamp: number Identifies the sending time of a message
- Use cases: Used to present the sending time of a message, and can be used for message sorting.
- Caution: This is a standard UNIX timestamp, in milliseconds.
senderUserID
senderUserID: string Displays the userID of the sender of this message.
conversationID
conversationID: string Conversation ID. Ids of the same conversation type are unique.
direction
sentStatus
conversationType
conversationType: ZIMConversationType The type of conversation to which the message belongs.
conversationSeq
conversationSeq: number Indicates the sequence number of the message in the conversation.
orderKey
orderKey: number The larger the orderKey, the newer the message, and can be used for ordering messages.
localMessageID
localMessageID: string SDK locally generated MessageID, developers do not need to pay attention to.
isUserInserted
isUserInserted: boolean Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].
Default: false.
receiptStatus
receiptStatus: ZIMMessageReceiptStatus Describe the receipt status of the message
Business scenario: used to determine the status of the current message in the receipt message
extendedData
extendedData: string message extension field
- Use cases: You can add extended fields to the message and send it to the peer
- Required: no
- Caution: the length is 1k, you can contact technical support for configuration
- Available since: 2.6.0 or higher
localExtendedData
localExtendedData: string The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
isBroadcastMessage
isBroadcastMessage: boolean Whether the message is pushed by all employees.
- Required: Internal assignment.
isMentionAll
isMentionAll: boolean Whether to mention everyone. It can be presented as "@Everyone".
- Use cases: For example, it can be used in groups or rooms.
- Required: No.
- Default value: false.
- Recommended value: Set to true if you need to mention everyone.
- Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
mentionedUserIDs
mentionedUserIDs: string[] Whether to mention everyone. It can be presented as "@User".
- Use cases: For example, it can be used in sending messages.
- Required: No.
- Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
messageSeq
messageSeq: number Indicates the sequence number of the message in the conversation.
rootRepliedCount
rootRepliedCount: number The number of reply messages corresponding to the root message of the reply message tree.
repliedInfo
repliedInfo: ZIMMessageRepliedInfo Information about the source message referenced by the reply message.
editorUserID
editorUserID: string The latest editor's userID for this message.
editedTime
editedTime: number The latest editing timestamp for this message.
isGroupTargetedMessage
isGroupTargetedMessage: boolean Identify if this message is group targeted message.
pinnedUserID
pinnedUserID: string The last user who pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
pinnedTime
pinnedTime: number The last timestamp when pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
ZIMConversation
Session specific content.
Details
The specific content of the session.
Properties
conversationID
conversationID: string conversationID.
conversationName
conversationName: string conversationName is the same as the groupName/userName value corresponding to the session.
type
unreadMessageCount
unreadMessageCount: number Session unread.
lastMessage
orderKey
orderKey: number OrderKey is used to describe the order of messages in the session. The larger orderKey is, the newer it is.
notificationStatus
notificationStatus: ZIMConversationNotificationStatus session notification status.
conversationAvatarUrl
conversationAvatarUrl: string Detail description: Conversation avatar URL. The peer to peer chat conversation avatar URL is the same as the user avatar URL, and the group chat conversation avatar URL is the same as the group avatar URL.
Use Limit: the maximum number of characters is 500 bytes. There is no limit on special characters.
isPinned
isPinned: boolean Whether the conversation is pinned.
mentionedInfoList
mentionedInfoList: ZIMMessageMentionedInfo[] When reminded in a message or reminded to everyone in a conversation, this array will record the reminders.
- Use cases: For example, you can display the number of reminders in the conversation list based on this array, and also display which user's reminder it is.
conversationAlias
conversationAlias: string After the friend remarks are set through [updateFriendAlias], this parameter is changed for each chat conversation. After setting a group alias by [updateGroupAlias], the corresponding group chat conversation's parameter will be modified synchronously.
- Use cases: After update alias for friends or groups, the corresponding conversation chooses to display the alias over the conversation name when rendering the conversation page.
marks
marks: std::vector\<int> Describes all the existing marks for the conversation.
- Use cases: The business layer can group logic, etc., according to different conversations with different marks.
draft
draft: string Conversation draft, when draft set conversation will carry this parameter.
ZIMConversationBaseInfo
Conversation base content.
Details
The base content of the session.
Properties
conversationID
conversationID: string conversationID.
conversationType
ZIMConversationChangeInfo
Session change information.
Details
Contains information after session changes.
Properties
event
conversation
ZIMConversationDeleteConfig
Delete session configuration.
Details
Delete the related configuration of the session.
Properties
isAlsoDeleteServerConversation
isAlsoDeleteServerConversation: boolean Whether to delete the conversation on the server
- Required: not required.
- Default value: true.
ZIMConversationDeletedResult
Callback for conversation deletion.
Properties
conversationID
conversationID: string Conversation ID.
conversationType
ZIMConversationDraftSetResult
Result for setting conversation draft
Properties
conversationID
conversationID: string Conversation ID.
conversationType
ZIMConversationFilterOption
Search filters related to the conversation.
Details
Configurable filter options when querying conversation list.
Properties
marks
marks: std::vector\<int> Conversation marks. Only integers in the range [1, 20] are supported. If the list contains -1, the query result will be all marked conversation; if the list contains 0, the query result will be all unmarked conversations; if multiple markers are passed, the query result will be the union of all passed markers; if the list is empty, the query result will be all conversations.
- Use cases: This filter can be used when needing to search for conversations that include specified conversation marks.
conversationTypes
conversationTypes: std::vector<ZIMConversationType> Conversation types. Only support one-on-one and group conversations.
- Use cases: When you need to search by conversation type, you can use this filter.
isOnlyUnreadConversation
isOnlyUnreadConversation: boolean Whether to only query conversations with unread counts. Pass true to only query conversations with unread counts. Pass false to query without considering whether conversations have unread counts.
- Use cases: It is necessary to query conversations that have a message unread count.
ZIMConversationListQueriedResult
Conversation list query callback.
Properties
conversationList
ZIMConversationMessageReceiptReadSentResult
Callback interface for setting the read receipt conversation.
Details
Supported version: 2.5.0 and above.
Detailed description: Set the callback interface for the read receipt conversation.
Business scenario: Developers can judge whether the sending is successful through [errorCode] in the callback.
Notification timing: When the developer calls the [sendConversationMessageReceiptRead] interface, this callback will be triggered.
Relevant interface: The success or failure of the conversation read result set by [sendConversationMessageReceiptRead] will be notified through this callback.
Properties
conversationID
conversationID: string Conversation ID.
conversationType
ZIMConversationNotificationStatusSetResult
Callback for conversation notification state settings.
Properties
conversationID
conversationID: string Conversation ID.
conversationType
ZIMConversationPinnedListQueriedResult
Callback for querying the pinned conversation list.
Details
After the conversation pinned list is queried, the callback is used to return the query result.
- Use cases: The logic after the pinned conversation list query can be done in this callback.
- When to call /Trigger: Triggered when the conversation pinned list is queried.
- Available since: 2.8.0 and above.
Properties
conversationList
ZIMConversationPinnedStateUpdatedResult
Callback for conversation pinned state updated.
Details
After updating the pinned status of the conversation, the query result is returned through this callback.
- Use cases: The logic after updating the pinned status of the conversation can be done in this callback.
- When to call /Trigger: Triggered after updating the pinned status of the conversation.
- Available since: 2.8.0 and above.
Properties
conversationID
conversationID: string Conversation ID.
conversationType
ZIMConversationQueriedResult
Conversation query callback.
Details
After the conversation is queried, the callback is used to return the query result.
- Use cases: The logic after the conversation query can be done in this callback.
- When to call /Trigger: Triggered when the conversation is queried.
- Available since: 2.8.0 and above.
Properties
conversation
ZIMConversationQueryConfig
Query the relevant configuration of the session.
Details
Configurable information when querying a session.
Properties
nextConversation
nextConversation: ZIMConversation Session that needs to be queried.
- Required: Not required.
count
count: number The number of sessions to query.
- Required: Required.
ZIMConversationSearchConfig
Conversation search configuration.
Details
Conversation search configuration.
Properties
nextFlag
nextFlag: number Pagination token, fill in 0 initially, and then fill in the nextFlag returned from the callback to retrieve data for the next page.
totalConversationCount
totalConversationCount: number The number of messages that can be retrieved in one search. It is recommended to be less than 20 to reduce performance overhead.
- Required: Required.
conversationMessageCount
conversationMessageCount: number The number of local messages that can be retrieved for a single conversation in one search. It is recommended to be less than 10 to reduce performance overhead.
keywords
keywords: string[] Search keywords, supports up to 5. Otherwise, an error will occur. For example, if you pass in "1" and "2", the search results will only display conversations that contain both "1" and "2" keywords in the messages.
messageTypes
messageTypes: ZIMMessageType[] Message types, can be used to specify message types. Support passing in multiple types.
subMessageTypes
subMessageTypes: number[] The subtypes of custom messages have a value range of [0,200]. Developers can use this range to search for specific custom types.
senderUserIDs
senderUserIDs: string[] Send user ID, supports up to 5. For example, if you pass in "zego2023", the search results will only display conversations where messages have been sent by the user "zego2023".
startTime
startTime: number The starting point of the search, in milliseconds, with a default value of 0. The format is UTC timestamp.
endTime
endTime: number The ending point of the search, which must be greater than the startTime, in milliseconds. The default value is 0 and the format is UTC timestamp.
ZIMConversationSearchInfo
Conversations search info.
Properties
conversationID
conversationID: string The conversation ID of the local message to be search.
conversationType
totalMessageCount
totalMessageCount: number Total message count
messageList
ZIMConversationTotalUnreadMessageCountQueryConfig
Search filters related to the conversation total unread message count.
Details
Configurable filter options when querying conversation total unread message count.
Properties
marks
marks: std::vector\<int> Conversation marks. Only integers in the range [1, 20] are supported. If the list contains -1, the query result will be all marked conversation; if the list contains 0, the query result will be all unmarked conversations; if multiple markers are passed, the query result will be the union of all passed markers; if the list is empty, the query result will be all conversations.
- Use cases: This filter can be used when needing to search for conversations that include specified conversation marks.
conversationTypes
conversationTypes: std::vector<ZIMConversationType> Conversation types. Only support one-on-one and group conversations.
- Use cases: When you need to search by conversation type, you can use this filter.
ZIMConversationUnreadMessageCountClearedResult
Callback for conversation unread clearing.
Properties
conversationID
conversationID: string Conversation ID.
conversationType
ZIMConversationsSearchedResult
Search for the return of local conversations results based on local messages.
Details
Search the results of local conversations based on local messages.
- Use cases: After performing a local session message search operation, the success or failure can be known through this callback.
Related API: [searchLocalConversations], search for local conversations based on local messages.
Properties
conversationSearchInfoList
conversationSearchInfoList: ZIMConversationSearchInfo[] List of searched conversation messages.
nextFlag
nextFlag: number The next flag.
ZIMCustomMessage
Custom message object.
Details
Identifies a custom message.
- Caution: When calling back, if the Type parameter of the base class is Custom, the base class message object can be forcibly converted to this class.
- Available since: 2.8.0 and above.
Properties
message
message: string The text content of the message.
subType
subType: number The subtype of the message, which is used by customers to customize the usage of different custom messages.
- Required: The sender is required, otherwise the message will fail to be sent.
searchedContent
searchedContent: string Search fields for custom messages. Since you cannot search for a custom message by directly searching the message field, you can concatenate the content you want to be searched in the custom message (such as the title of the poll, etc.) and put it in this parameter (the length is 64 bytes by default), so that follow-up search.
type
messageID
messageID: string The unique ID that identifies this message.
- Use cases: Can be used to index other messages.
- Caution: When the developer actively creates a message, there is no need to modify this parameter. This parameter only has a value during callback.
timestamp
timestamp: number Identifies the sending time of a message
- Use cases: Used to present the sending time of a message, and can be used for message sorting.
- Caution: This is a standard UNIX timestamp, in milliseconds.
senderUserID
senderUserID: string Displays the userID of the sender of this message.
conversationID
conversationID: string Conversation ID. Ids of the same conversation type are unique.
direction
sentStatus
conversationType
conversationType: ZIMConversationType The type of conversation to which the message belongs.
conversationSeq
conversationSeq: number Indicates the sequence number of the message in the conversation.
orderKey
orderKey: number The larger the orderKey, the newer the message, and can be used for ordering messages.
localMessageID
localMessageID: string SDK locally generated MessageID, developers do not need to pay attention to.
isUserInserted
isUserInserted: boolean Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].
Default: false.
receiptStatus
receiptStatus: ZIMMessageReceiptStatus Describe the receipt status of the message
Business scenario: used to determine the status of the current message in the receipt message
extendedData
extendedData: string message extension field
- Use cases: You can add extended fields to the message and send it to the peer
- Required: no
- Caution: the length is 1k, you can contact technical support for configuration
- Available since: 2.6.0 or higher
localExtendedData
localExtendedData: string The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
isBroadcastMessage
isBroadcastMessage: boolean Whether the message is pushed by all employees.
- Required: Internal assignment.
isMentionAll
isMentionAll: boolean Whether to mention everyone. It can be presented as "@Everyone".
- Use cases: For example, it can be used in groups or rooms.
- Required: No.
- Default value: false.
- Recommended value: Set to true if you need to mention everyone.
- Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
mentionedUserIDs
mentionedUserIDs: string[] Whether to mention everyone. It can be presented as "@User".
- Use cases: For example, it can be used in sending messages.
- Required: No.
- Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
messageSeq
messageSeq: number Indicates the sequence number of the message in the conversation.
rootRepliedCount
rootRepliedCount: number The number of reply messages corresponding to the root message of the reply message tree.
repliedInfo
repliedInfo: ZIMMessageRepliedInfo Information about the source message referenced by the reply message.
editorUserID
editorUserID: string The latest editor's userID for this message.
editedTime
editedTime: number The latest editing timestamp for this message.
isGroupTargetedMessage
isGroupTargetedMessage: boolean Identify if this message is group targeted message.
pinnedUserID
pinnedUserID: string The last user who pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
pinnedTime
pinnedTime: number The last timestamp when pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
ZIMCustomMessageLiteInfo
Custom message lite info object.
Details
Identifies a custom message.
Properties
message
message: string The text content of the message.
subType
subType: number The subtype of the message, which is used by customers to customize the usage of different custom messages.
- Required: The sender is required, otherwise the message will fail to be sent.
searchedContent
searchedContent: string Search fields for custom messages. Since you cannot search for a custom message by directly searching the message field, you can concatenate the content you want to be searched in the custom message (such as the title of the poll, etc.) and put it in this parameter (the length is 64 bytes by default), so that follow-up search.
type
ZIMError
Error infomation
Details
Error infomation.
Properties
code
code: ZIMErrorCode The storage path of the log files. Refer to the official website document for the default path.
message
message: string Error infomation description.
ZIMErrorUserInfo
Error user information class.
Details
Used to show the failed user and the reason for the failure.
Properties
userID
userID: string User ID, a string with a maximum length of 32 bytes or less. It is customized by the developer. Only support numbers, English characters and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.
reason
reason: number Description Reason for the query failure.
ZIMEventHandler
Details
Callback.
Methods
blacklistChanged
blacklistChanged(zim: ZIM, data: ZIMEventOfBlacklistChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfBlacklistChangedResult | The result of the event callback. |
- When to call: After creating a ZIM instance through [create].
- Related APIs: [addUsersToBlacklist].
friendListChanged
friendListChanged(zim: ZIM, data: ZIMEventOfFriendListChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfFriendListChangedResult | The result of the event callback. |
- When to call: After creating a ZIM instance through [create].
- Related APIs: [addFriend].
friendApplicationListChanged
friendApplicationListChanged(zim: ZIM, data: ZIMEventOfFriendApplicationListChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfFriendApplicationListChangedResult | The result of the event callback. |
- When to call: After creating a ZIM instance through [create].
- Related APIs: [sendFriendApplication].
friendApplicationUpdated
friendApplicationUpdated(zim: ZIM, data: ZIMEventOfFriendApplicationUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfFriendApplicationUpdatedResult | The result of the event callback. |
- When to call: After creating a ZIM instance through [create].
- Related APIs: [acceptFriendApplication] [rejectFriendApplication]。
friendInfoUpdated
friendInfoUpdated(zim: ZIM, data: ZIMEventOfFriendInfoUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfFriendInfoUpdatedResult | The result of the event callback. |
- When to call: After creating a ZIM instance through [create].
- Related APIs: [updateFriendAlias] [updateFriendAttributes]。
userStatusUpdated
userStatusUpdated(zim: ZIM, userStatusList: List<ZIMUserStatus>): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | zim instance. |
| userStatusList | List<ZIMUserStatus> | A list with data about the user's online status. |
Details
User online status change notification.
- Use cases: This callback can be used when you needs to pay attention to the online status of certain users, for example, the online group members need to be displayed. After subscribing to users through the subscribeUsersStatus method, the online status of the targeted users and the changes of their online status during the validity period of the subscription will be notified to you through this callback.
- When to call /Trigger: After the current user subscribes to the target user for the first time, the event will be triggered if the target user is added to the subscription list for the first time, or the subscribed user's online status or online platform list. In addition, the callback will also be triggered if the current user has opened a multi-terminal login and the online platform has changed.
- Available since: 2.18.0
- Restrictions: When the userStatusUpdated callback returns the userStatus information of the current user, the onlineStatus will be unknown and the lastUpdateTime will be 0, which cannot truly present the online status. Map the online status of the current user according to connectionStateChanged.
error
Parameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| errorInfo | ZIMError | Error information, please refer to the error codes document. |
Details
When an EXCEPTION occurs in the SDK, the callback prompts detailed exception information.
- Use cases: It is recommended that developers listen for this callback notification and print the error information to the console during debugging after accessing the SDK, so that they can learn about the errors occurred during development and modify them in time.
- When to call: When an error occurs within the SDK, the SDK notifies the developer through this function callback.
- Available since: 1.1.0 or above.
connectionStateChanged
connectionStateChanged(zim: ZIM, data: ZIMEventOfConnectionStateChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfConnectionStateChangedResult | The result of the event callback. |
Details
When the connection status changes, the user will be notified of the current status and events through this callback.
- Use cases: The [ZIMConnectionState] and [ZIMConnectionEvent] in this callback can be used to accomplish different business logic when you need to monitor the connection state and the events that cause the connection state to change.
- When to call: This function is called back when connection state changes.
- Available since: 1.1.0 or above.
tokenWillExpire
tokenWillExpire(zim: ZIM, data: ZIMEventOfTokenWillExpireResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfTokenWillExpireResult | The result of the event callback. |
Details
When receiving this callback, the developer should call the [renewToken] function to update the Token in time.
- Use cases: When the authentication Token has only 30 seconds left, the SDK calls back this function to notify the developer to update the authentication Token. If the validity period of the authentication Token passed by the developer when [login] is less than 30 seconds, the authentication Token will be recalled after [login] is successful.
- When to call: For details, see authentication Token Generation https://doc-zh.zego.im/article/11617.
- Available since: 1.1.0 or above.
userInfoUpdated
userInfoUpdated(zim: ZIM, data: ZIMEventOfUserInfoUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfUserInfoUpdatedResult | The result of the event callback. |
Details
In the multi-terminal login scenario, after the user modifies their information on device A, other online multi-terminal devices will receive this callback. For offline devices, after the user goes online, they need to call the [queryUsersInfo] interface to actively query user information.
- Available since: 2.11.0 or above.
userRuleUpdated
userRuleUpdated(zim: ZIM, data: ZIMEventOfUserRuleUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfUserRuleUpdatedResult | The result of the event callback. |
Details
Callback of user rule changes.
When to
- Trigger: When the user rule of the current user is changed, all users are notified by the callback.
- Available since: 2.15.0 and later versions.
callInvitationReceived
callInvitationReceived(zim: ZIM, data: ZIMEventOfCallInvitationReceivedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfCallInvitationReceivedResult | The result of the event callback. |
- When to call: After creating a ZIM instance through [create].
If the user is not in the invitation list or not online, this callback will not be called.
- Related APIs: [callInvite].
callInvitationCreated
callInvitationCreated(zim: ZIM, data: ZIMEventOfCallInvitationCreatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfCallInvitationCreatedResult | The result of the event callback. |
- When to call: After creating a ZIM instance through [create].
- Related APIs: [callInvite].
callInvitationCancelled
callInvitationCancelled(zim: ZIM, data: ZIMEventOfCallInvitationCancelledResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfCallInvitationCancelledResult | The result of the event callback. |
- When to call: After creating a ZIM instance through [create].
If the user is not in the cancel invitation list or is offline, this callback will not be called.
- Related APIs: [callCancel].
callInvitationTimeout
callInvitationTimeout(zim: ZIM, data: ZIMEventOfCallInvitationTimeoutResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfCallInvitationTimeoutResult | The result of the event callback. |
- When to call: After creating a ZIM instance through [create].
If the user is not on the invitation list or is not online, the callback will not be received.
- Related APIs: [callInvite], [callAccept], [callReject].
callInvitationAccepted
callInvitationAccepted(zim: ZIM, data: ZIMEventOfCallInvitationAcceptedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfCallInvitationAcceptedResult | The result of the event callback. |
- When to call: After creating a ZIM instance through [create].
This callback will not be called if the user is not online.
- Related APIs: [callAccept].
callInvitationRejected
callInvitationRejected(zim: ZIM, data: ZIMEventOfCallInvitationRejectedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfCallInvitationRejectedResult | The result of the event callback. |
Details
This callback will be received when the inviter is online after the inviter rejects the call invitation.
- Use cases: The inviter will receive this callback after the inviter declines the call invitation.
- Default value: After creating a ZIM instance through [create] and logging in.
- When to call /Trigger: After creating a ZIM instance through [create] and logging in.
- Related APIs: [callReject].
- Available since: 2.0.0 and above.
- Restrictions: If the user is not the inviter of the call invitation or is not online, the callback will not be received.
callInviteesAnsweredTimeout
callInviteesAnsweredTimeout(zim: ZIM, data: ZIMEventOfCallInviteesAnsweredTimeoutResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfCallInviteesAnsweredTimeoutResult | The result of the event callback. |
- When to call: After creating a ZIM instance through [create].
If the user is not the inviter who initiated this call invitation or is not online, the callback will not be received.
- Related APIs: [callInvite], [callAccept], [callReject].
callInvitationEnded
callInvitationEnded(zim: ZIM, data: ZIMEventOfCallInvitationEndedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfCallInvitationEndedResult | The result of the event callback. |
- Related APIs: [callEnd]
callUserStateChanged
callUserStateChanged(zim: ZIM, data: ZIMEventOfCallUserStateChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfCallUserStateChangedResult | The result of the event callback. |
- When to call: When a new member is invited to a call, or a member accepts, rejects, exits, or a member response times out, all users on the current call invitation whose status is "Inviting," "Accepted," and "Received" receive the callback here. If the member is not online at the time of notification, the call is still ongoing when the login succeeds. The status changes of all members during the offline period will be sent to the user at one time.
If the user is not the inviter who initiated this call invitation or is not online, the callback will not be received.
- Related APIs: [callInvite], [callingInvite], [callAccept], [callReject],[callQuit].
groupStateChanged
groupStateChanged(zim: ZIM, data: ZIMEventOfGroupStateChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfGroupStateChangedResult | The result of the event callback. |
Details
allback notification of group status change.
- Use cases: Scenarios that require interaction based on the group status.
- When to call /Trigger: A notification is triggered when a group is created, joined, left, or dismissed.
- Related APIs: [createGroup] : creates a group. [joinGroup] : joins a group. [leaveGroup], leave the group. [dismissGroup]; dismiss the group.
groupAliasUpdated
groupAliasUpdated(zim: ZIM, data: ZIMEventOfGroupAliasUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfGroupAliasUpdatedResult | The result of the event callback. |
Details
Group alias change notification callback.
- Use cases: When the group alias is changed, this notification synchronizes the latest group alias to all devices of the user who made the modification.
When to
- Trigger: The group alias is changed.
- Related APIs: [updateGroupAlias].
groupNameUpdated
groupNameUpdated(zim: ZIM, data: ZIMEventOfGroupNameUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfGroupNameUpdatedResult | The result of the event callback. |
Details
Group name change notification callback.
- Use cases: If the group name is changed, you need to synchronize the latest group name.
- When to call /Trigger: The group name is changed. Procedure
- Related APIs: [updateGroupName] : updates the group name.
groupAvatarUrlUpdated
groupAvatarUrlUpdated(zim: ZIM, data: ZIMEventOfGroupAvatarUrlUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfGroupAvatarUrlUpdatedResult | The result of the event callback. |
- Related APIs: [updateGroupAvatarUrl], update group avatar URL.
groupNoticeUpdated
groupNoticeUpdated(zim: ZIM, data: ZIMEventOfGroupNoticeUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfGroupNoticeUpdatedResult | The result of the event callback. |
Details
Group bulletin Change notification callback.
- Use cases: If a group bulletin changes, you need to synchronize the latest bulletin content.
- When to call /Trigger: The group bulletin is changed. Procedure
- Related APIs: [updateGroupNotice], which updates the group notice.
groupMutedInfoUpdated
groupMutedInfoUpdated(zim: ZIM, data: ZIMEventOfGroupMutedInfoUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfGroupMutedInfoUpdatedResult | The result of the event callback. |
Details
Callback notification for changes in group mute information.
- Use cases: To know the details of changes when group mute information changes.
When to trigger: When group mute information changes.
- Related APIs: [muteGroup], Group Mute.
groupVerifyInfoUpdated
groupVerifyInfoUpdated(zim: ZIM, data: ZIMEventOfGroupVerifyInfoUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfGroupVerifyInfoUpdatedResult | The result of the event callback. |
Details
Callback notification for changes in group verification mode.
When to trigger: When group verification mode changes.
- Related APIs: [updateGroupJoinMode, updateGroupInviteMode, updateGroupBeInviteMode], Update the group verification mode.
groupAttributesUpdated
groupAttributesUpdated(zim: ZIM, data: ZIMEventOfGroupAttributesUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfGroupAttributesUpdatedResult | The result of the event callback. |
Details
Group attribute change notification callback.
- Use cases: When group attributes are changed, you need to synchronize the latest group attributes.
- When to call /Trigger: Triggered when group properties are set, updated, or deleted.
- Related APIs: [setGroupAttributes] updates group attributes. [deleteGroupAttributes], delete the group attribute.
groupMemberStateChanged
groupMemberStateChanged(zim: ZIM, data: ZIMEventOfGroupMemberStateChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfGroupMemberStateChangedResult | The result of the event callback. |
Details
Group member status change notification callback.
- Use cases: Scenarios that require interaction based on group member states.
- When to call /Trigger: Notification is triggered when a group is created, joined, left, or dismissed, or a user is invited to join or kicked out of the group.
- Related APIs: [createGroup], creates a group. [joinGroup], joins a group. [leaveGroup], leave the group. [dismissGroup], dismiss the group. [intiveUsersIntoGroup], which invites users to join the group. [kickGroupMembers], kicks the user out of the group.
groupMemberInfoUpdated
groupMemberInfoUpdated(zim: ZIM, data: ZIMEventOfGroupMemberInfoUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfGroupMemberInfoUpdatedResult | The result of the event callback. |
Details
Return the operation result of changing group member information.
- Use cases: After the basic information of group members is changed, you need to display or interact with group members on the page.
- When to call /Trigger: The result is displayed after the group member information is changed.
- Related APIs: [setGroupMemberNickname], updates the nickname of a group member. [setGroupMemberRole], updates the group member role. [transferGroupOwner], group master transfer.
groupApplicationListChanged
groupApplicationListChanged(zim: ZIM, data: ZIMEventOfGroupApplicationListChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfGroupApplicationListChangedResult | The result of the event callback. |
- When to call: After creating a ZIM instance through [create].
- Related APIs: [sendGroupJoinApplication], [sendGroupInviteApplications].
groupApplicationUpdated
groupApplicationUpdated(zim: ZIM, data: ZIMEventOfGroupApplicationUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfGroupApplicationUpdatedResult | The result of the event callback. |
- When to call: After creating a ZIM instance through [create].
- Related APIs: [acceptGroupJoinApplication], [rejectGroupJoinApplication], [acceptGroupInviteApplication], [rejectGroupInviteApplication].
conversationChanged
conversationChanged(zim: ZIM, data: ZIMEventOfConversationChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfConversationChangedResult | The result of the event callback. |
Details
Trigger this callback to return notification of session updates when a session is added, deleted, modified, pinned or unpinned.
- When to call /Trigger: Notifications are triggered when a new message is updated in the session, or when the session itself is added, deleted, or modified.
- Caution: ConversationID is the same as single chat toUserID and group chat GroupID.
- Related APIs: Triggered by [sendPeerMessage], [sendGroupMessage], [sendRoomMessage], [deleteConversation], [deleteMessage], [deleteMessageByConversationID], [updateConversationPinnedState].
- Available since: 2.0.0 and above.
conversationMessageReceiptChanged
conversationMessageReceiptChanged(zim: ZIM, data: ZIMEventOfMessageReceiptChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfMessageReceiptChangedResult | The result of the event callback. |
Details
When the message receiver has read the session, the message sender knows through this callback.
- Trigger: Trigger a notification when the message receiver has read the session.
- Related APIs: triggered when the peer calls via [sendConversationMessageReceiptRead].
- Available since: 2.5.0 and above.
conversationSyncStateChanged
conversationSyncStateChanged(zim: ZIM, state: ZIMConversationSyncState): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| state | ZIMConversationSyncState | The synchronizing conversation list state from server. |
Details
This callback is triggered to notify of conversation updates when the SDK initiates the process of synchronizing conversations from the server after initial login, and when the process completes or fails.
When to
- Trigger: The notification is triggered when the SDK confirms the need to pull list data from the server.
- Caution: ConversationID is the same as single chat toUserID and group chat GroupID.
- Available since: 2.21.0 and above.
conversationsAllDeleted
conversationsAllDeleted(zim: ZIM, data: ZIMEventOfConversationsAllDeletedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfConversationsAllDeletedResult | The result of the event callback. |
Details
When multiple login ends delete all conversations, the local end triggers the callback to notify the local end that all conversations are deleted.
- When to call /Trigger: When another end clears all unread conversations, the local end triggers a notification.
- Related APIs: Triggered by [deleteAllConversations] .
- Available since: 2.12.0 and above.
messageReceiptChanged
messageReceiptChanged(zim: ZIM, data: ZIMEventOfMessageReceiptChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfMessageReceiptChangedResult | The result of the event callback. |
Details
When the message receiver confirms that the message has been read, the message sender knows through this callback.
- Trigger: Trigger a notification when the message receiver has read the message.
- Related APIs: triggered when the peer calls via [sendMessageReceiptsRead].
- Available since: 2.5.0 and above.
conversationTotalUnreadMessageCountUpdated
conversationTotalUnreadMessageCountUpdated(zim: ZIM, data: ZIMEventOfConversationTotalUnreadMessageCountUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfConversationTotalUnreadMessageCountUpdatedResult | The result of the event callback. |
Details
This callback is used to return the total unread of the session.
- When to call /Trigger: Log in, call [deleteConversation], [deleteMessage], [deleteAllMessageByConversationID], [clearConversationUnreadMessageCount], [clearConversationTotalUnreadMessageCount] Causes the message reading to change to trigger the callback.
- Related APIs: [deleteConversation]、[deleteMessage]、[deleteMessageByConversationID]、[clearConversationUnreadMessageCount]、[clearConversationTotalUnreadMessageCount]
- Available since: 2.0.0 and above.
groupMessageReceived
groupMessageReceived(zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfReceiveConversationMessageResult | The result of the event callback. |
Details
When the user is online, they can receive online group messages through this callback. Also, when the user logs back into the ZIM SDK, they can receive all the group chat messages received during the offline period (up to 7 days) through this callback.
Call timing: This callback occurs when a ZIM instance is created with [create] and a group member sends a message.
- Related callbacks: You can send messages to other group members via [sendGroupMessage].
- Available since: 2.18.0 or above
peerMessageReceived
peerMessageReceived(zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfReceiveConversationMessageResult | The result of the event callback. |
Details
When the user is online, they can receive one-on-one chat messages through this callback. Also, when the user logs back into the ZIM SDK, they can receive all the one-on-one chat messages received during the offline period (up to 7 days) through this callback.
Call timing: This callback occurs when a ZIM instance is created with [create] and the other user sends you a message.
- Related callbacks: You can send messages to other members via [sendPeerMessage].
- Available since: 2.18.0 or above
roomMessageReceived
roomMessageReceived(zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfReceiveConversationMessageResult | The result of the event callback. |
Details
When the user is online, they can receive online room messages through this callback. Also, when the user transitions back to online status from being offline, if they are still in the room, they can receive all the room messages received during the offline period through this callback.
Call timing: This callback occurs when a ZIM instance is created with [create] and a group member sends a message.
- Related callbacks: You can send messages to other group members via [sendRoomMessage].
- Available since: 2.18.0 or above
messageEdited
messageEdited(zim: ZIM, data: ZIMEventOfMessageEditedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfMessageEditedResult | The result of the event callback. |
Details
This callback is received when some one edited a message.
Call timing: This callback occurs when a ZIM instance is created with [create] and the other user edited a message.
- Related callbacks: You can edit the message sent successfully by yourself through [editMessage].
- Available since: 2.20.0 or above.
messagePinStatusChanged
messagePinStatusChanged(zim: ZIM, data: ZIMEventOfMessagePinnedStatusResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfMessagePinnedStatusResult | The result of the event callback. |
Details
This notification is received when a message successfully is pinned or unpinned.
Call timing: This callback occurs after a ZIM instance is created with [create] and another user successfully pins or unpins a message.
- Related APIs: You can pin or unpin a message you successfully sent yourself through [pinMessage].
messageRevokeReceived
messageRevokeReceived(zim: ZIM, data: ZIMEventOfMessageRevokeReceivedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfMessageRevokeReceivedResult | The result of the event callback. |
Details
This callback is received when some one else sends a message and then revoke.
Call timing: This callback occurs when a ZIM instance is created with [create] and the other user revoke a message.
- Related callbacks: You can revoke message to other members via [revokeMessage].
- Available since: 2.5.0 or above.
messageSentStatusChanged
messageSentStatusChanged(zim: ZIM, data: ZIMEventOfMessageSentStatusChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfMessageSentStatusChangedResult | The result of the event callback. |
Details
This callback is received when messages status changed.
Call timing: This callback occurs when messages status changed.
- Related callbacks: You can send message to other members via [sendMessage].
- Available since: 2.6.0 or above.
broadcastMessageReceived
broadcastMessageReceived(zim: ZIM, data: ZIMEventOfBroadcastMessageReceivedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfBroadcastMessageReceivedResult | The result of the event callback. |
Details
The callback is received when the server interface [SendMessageToAllUsers] sends a message.
Call time: This callback is received after logging in to the ZIM service and the server call the [SendMessageToAllUsers] interface to send a message.
messageReactionsChanged
messageReactionsChanged(zim: ZIM, data: ZIMEventOfMessageReactionsChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfMessageReactionsChangedResult | The result of the reaction change. |
Details
The callback is received when reactions change
When to Call: This callback can be registered after the ZIM instance is created by [create] and before login.
When to
- Trigger: After other users add or delete reactions to messages in private or group chats.
- Related APIs: [addMessageReaction]、[deleteMessageReaction]
messageDeleted
messageDeleted(zim: ZIM, data: ZIMEventOfMessageDeletedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfMessageDeletedResult | The result of the event callback. |
Details
In the multi-terminal login scenario, after the user deletes the server level message on device A, other online multi-terminal devices will receive this callback..
receivePeerMessage
receivePeerMessage(zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfReceiveConversationMessageResult | The result of the event callback. |
Details
This callback is received when you receive a point-to-point message from someone else.
Call timing: This callback occurs when a ZIM instance is created with [create] and the other user sends you a message.
- Related callbacks: You can send messages to other members via [sendPeerMessage].
- Available since: 2.0.0 or above
receiveRoomMessage
receiveRoomMessage(zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfReceiveConversationMessageResult | The result of the event callback. |
Details
This callback is received when an in-room message is received.
Call timing: This callback occurs when a ZIM instance is created with [create] and a group member sends a message.
- Related callbacks: You can send messages to other group members via [sendRoomMessage].
- Available since: 2.0.0 or above
messageRepliedCountChanged
messageRepliedCountChanged(zim: ZIM, data: ZIMEventOfMessageRepliedCountChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfMessageRepliedCountChangedResult | The result of the event callback. |
Details
When there is a new reply message, the number of replies to the corresponding root message is notified through this event.
- Available since: 2.17.0 or above
messageRepliedInfoChanged
messageRepliedInfoChanged(zim: ZIM, data: ZIMEventOfMessageRepliedInfoChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfMessageRepliedInfoChangedResult | The result of the event callback. |
Details
Change event for a reply message received after the source message referenced by the reply message is deleted and withdrawn.
- Available since: 2.17.0 or above
receiveGroupMessage
receiveGroupMessage(zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfReceiveConversationMessageResult | The result of the event callback. |
Details
This callback is received when a group message is received.
Call timing: This callback occurs when a ZIM instance is created with [create] and a group member sends a message.
- Related callbacks: You can send messages to other group members via [sendGroupMessage].
- Available since: 2.0.0 or above
roomStateChanged
roomStateChanged(zim: ZIM, data: ZIMEventOfRoomStateChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfRoomStateChangedResult | The result of the event callback. |
Details
event callback when the room connection status changes.
- When to call: creating a ZIM instance through [create], you can call this interface.
- Related APIs: through [onTokenWillExpire], the callback will be received when the token is about to expire.
- Available since: 1.1.0 or above.
roomMemberJoined
roomMemberJoined(zim: ZIM, data: ZIMEventOfRoomMemberChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfRoomMemberChangedResult | The result of the event callback. |
Details
After joining a room, when other members also join this room, they will receive this callback.
- Use cases: When other members in the room join, this callback will be called.
- When to call: After creating a ZIM instance through [create], and the user is in a room joined by other members, you can call this interface.
- Caution: If the user is not currently in this room, this callback will not be called.
- Related APIs: You can use [onRoomMemberLeft] to receive this callback when other room members leave.
- Available since: 1.1.0 or above.
roomMemberLeft
roomMemberLeft(zim: ZIM, data: ZIMEventOfRoomMemberChangedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfRoomMemberChangedResult | The result of the event callback. |
Details
After joining a room, when other members leave the room, they will receive this callback.
- Use cases: When other members in the room leave the room, this callback will be called.
- When to call: After creating a ZIM instance through [create], and the user is in the same room of other members, you can call this interface.
- Caution: If the user is not currently in this room, this callback will not be called.
- Related APIs: You can receive this callback when other room members join through [onRoomMemberJoined].
- Available since: 1.1.0 or above.
roomAttributesUpdated
roomAttributesUpdated(zim: ZIM, data: ZIMEventOfRoomAttributesUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | |
| data | ZIMEventOfRoomAttributesUpdatedResult | The result of the event callback. |
Details
When the room attribute in the room changes, it will be notified through this callback.
- Available since: 1.3.0.
roomAttributesBatchUpdated
roomAttributesBatchUpdated(zim: ZIM, data: ZIMEventOfRoomAttributesUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | |
| data | ZIMEventOfRoomAttributesUpdatedResult | The result of the event callback. |
Details
When the room attribute in the room changes, it will be notified through this callback.
- Available since: 1.3.0.
roomMemberAttributesUpdated
roomMemberAttributesUpdated(zim: ZIM, data: ZIMEventOfRoomMembersAttributesUpdatedResult): voidParameters
| Name | Type | Description |
|---|---|---|
| zim | ZIM | ZIM instance. |
| data | ZIMEventOfRoomMembersAttributesUpdatedResult | The result of the event callback. |
Details
Details: This callback will be received when a user's property in the room is changed.
ZIMEventOfBlacklistChangedResult
The result of the event callback.
Properties
userList
action
ZIMEventOfBroadcastMessageReceivedResult
The result of the event callback.
Properties
message
ZIMEventOfCallInvitationAcceptedResult
The result of the event callback.
Properties
callID
callID: string call ID.
invitee
invitee: string invitee ID.
extendedData
extendedData: string Extended field, through which the inviter can carry information to the invitee.
ZIMEventOfCallInvitationCancelledResult
The result of the event callback.
Properties
callID
callID: string call ID.
inviter
inviter: string Inviter ID.
extendedData
extendedData: string Extended field, through which the inviter can carry information to the invitee.
mode
ZIMEventOfCallInvitationCreatedResult
The result of the callInvitationCreated event callback.
Details
After the call invitation is successfully initiated, the user will receive this callback.
Properties
callID
callID: string call ID.
timeout
timeout: number The timeout setting of the call invitation, the unit is seconds.
extendedData
extendedData: string Extended field, through which the inviter can carry information to the invitee.
caller
caller: string Call invitation initiator ID.
createTime
createTime: number Call invites to create a timestamp.
callUserList
mode
ZIMEventOfCallInvitationEndedResult
The result of the callInvitationEnded event callback.
Properties
callID
callID: string call ID.
mode
caller
caller: string Call initiator.
operatedUserID
operatedUserID: string Call end caller.
extendedData
extendedData: string Call to end extendedData.
endTime
endTime: number End the call time stamp.
ZIMEventOfCallInvitationReceivedResult
The result of the event callback.
Properties
callID
callID: string call ID.
inviter
inviter: string Inviter ID.
timeout
timeout: number The timeout setting of the call invitation, the unit is seconds.
extendedData
extendedData: string Extended field, through which the inviter can carry information to the invitee.
mode
caller
caller: string Call invitation initiator ID.
createTime
createTime: number Call invites to create a timestamp.
callUserList
ZIMEventOfCallInvitationRejectedResult
The result of the event callback.
Properties
callID
callID: string call ID.
invitee
invitee: string invitee ID.
extendedData
extendedData: string Extended field, through which the inviter can carry information to the invitee.
ZIMEventOfCallInvitationTimeoutResult
The result of the event callback.
Properties
callID
callID: string call ID.
mode
ZIMEventOfCallInviteesAnsweredTimeoutResult
The result of the event callback.
Properties
callID
callID: string call ID.
invitees
invitees: string[] Timeout invitee ID.
ZIMEventOfCallUserStateChangedResult
The result of the callUserStateChanged event callback.
Details
Call invites user status to change callback.
Properties
callID
callID: string call ID.
callUserList
callUserList: ZIMCallUserInfo[] List of members who change status changes in invitation.
ZIMEventOfConnectionStateChangedResult
The result of the event callback.
Properties
state
event
extendedData
extendedData: string Extra information when the event occurs, a standard JSON format string.
ZIMEventOfConversationChangedResult
The result of the event callback.
Properties
infoList
ZIMEventOfConversationTotalUnreadMessageCountUpdatedResult
The result of the event callback.
Properties
totalUnreadMessageCount
totalUnreadMessageCount: number Updated total unreads.
ZIMEventOfConversationsAllDeletedResult
The result of the event callback.
Properties
count
count: number Number of total conversations deleted.
ZIMEventOfFriendApplicationListChangedResult
The result of the event callback.
Properties
applicationList
action
ZIMEventOfFriendApplicationUpdatedResult
The result of the event callback.
Properties
applicationList
ZIMEventOfFriendInfoUpdatedResult
The result of the event callback.
Properties
friendList
ZIMEventOfFriendListChangedResult
The result of the event callback.
Properties
friendList
action
ZIMEventOfGroupAliasUpdatedResult
Returns the result of the group alias update.
Details
Return result of group alias update operation.
- Use cases: After a group alias update operation is performed, the success or failure can be determined by this callback.
When to
- Trigger: The result of the group alias update operation is returned.
- Related APIs: [updateGroupAlias], the group alias is updated.
Properties
groupID
groupID: string ID of the group.
groupAlias
groupAlias: string Alias of the group.
ZIMEventOfGroupApplicationListChangedResult
The result of the event callback.
Properties
applicationList
action
ZIMEventOfGroupApplicationUpdatedResult
The result of the event callback.
Properties
applicationList
ZIMEventOfGroupAttributesUpdatedResult
The result of the event callback.
Properties
groupID
groupID: string The groupID for sending group attribute updates.
infoList
operatedInfo
operatedInfo: ZIMGroupOperatedInfo Operation information after the group attribute is updated.
ZIMEventOfGroupAvatarUrlUpdatedResult
The result of the event callback.
Properties
groupID
groupID: string The groupID where the group avatar url update occurred.
groupAvatarUrl
groupAvatarUrl: string The updated group avatar URL.
operatedInfo
operatedInfo: ZIMGroupOperatedInfo Operation information after the group avatar url is updated.
ZIMEventOfGroupMemberInfoUpdatedResult
The result of the event callback.
Properties
operatedInfo
userList
groupID
groupID: string The groupID where the member info change occurred.
ZIMEventOfGroupMemberStateChangedResult
The result of the event callback.
Properties
state
event
operatedInfo
userList
groupID
groupID: string The groupID where the member state change occurred.
ZIMEventOfGroupMutedInfoUpdatedResult
The result of the event callback.
Properties
groupID
groupID: string groupID.
muteInfo
operatedInfo
ZIMEventOfGroupNameUpdatedResult
The result of the event callback.
Properties
groupID
groupID: string The groupID where the group name update occurred.
groupName
groupName: string The updated group name.
operatedInfo
operatedInfo: ZIMGroupOperatedInfo Operation information after the group name is updated.
ZIMEventOfGroupNoticeUpdatedResult
The result of the event callback.
Properties
groupID
groupID: string The groupID where the group announcement update occurred.
groupNotice
groupNotice: string Updated group announcement.
operatedInfo
operatedInfo: ZIMGroupOperatedInfo The group announces the updated operation information.
ZIMEventOfGroupStateChangedResult
The result of the event callback.
Properties
state
event
operatedInfo
groupInfo
ZIMEventOfGroupVerifyInfoUpdatedResult
The result of the event callback.
Properties
groupID
groupID: string groupID.
verifyInfo
operatedInfo
operatedInfo: ZIMGroupOperatedInfo Operation information for changes in group verification mode.
ZIMEventOfMessageDeletedResult
The result of the event callback.
Properties
conversationID
conversationID: string Conversation ID.
conversationType
isDeleteConversationAllMessage
isDeleteConversationAllMessage: boolean Whether to delete all current messages in the conversation.
messageList
messageDeleteType
messageDeleteType: ZIMMessageDeleteType [messageDeleted] Indicates the cause of being triggered.
ZIMEventOfMessageEditedResult
The result of the event callback.
Properties
messageList
ZIMEventOfMessageReactionsChangedResult
The result of the event callback.
Properties
reactions
ZIMEventOfMessageReceiptChangedResult
The result of the event callback.
Properties
infos
ZIMEventOfMessageRepliedCountChangedResult
The result of the messageRepliedCountChanged event callback.
Properties
infos
ZIMEventOfMessageRepliedInfoChangedResult
The result of the messageRepliedInfoChanged event callback.
Properties
messageList
ZIMEventOfMessageRevokeReceivedResult
The result of the event callback.
Properties
messageList
ZIMEventOfMessageSentStatusChangedResult
The result of the event callback.
Properties
infos
ZIMEventOfReceiveConversationMessageResult
The result of the event callback.
Properties
messageList
fromConversationID
fromConversationID: string Conversation ID.
info
info: ZIMMessageReceivedInfo Attributes associated with receiving a message event.
ZIMEventOfRoomAttributesUpdatedResult
The result of the event callback.
Properties
infos
roomID
roomID: string room ID.
ZIMEventOfRoomMemberChangedResult
The result of the event callback.
Properties
memberList
roomID
roomID: string room ID.
ZIMEventOfRoomMembersAttributesUpdatedResult
The result of the roomMemberAttributesUpdated event callback.
Properties
roomID
roomID: string Room ID.
infos
operatedInfo
ZIMEventOfRoomStateChangedResult
The result of the event callback.
Properties
state
event
extendedData
extendedData: string Extra information when the event occurs, a standard JSON format string.
roomID
roomID: string room ID.
ZIMEventOfTokenWillExpireResult
The result of the event callback.
Properties
second
second: number The remaining second before the token expires, The unit is seconds.
ZIMEventOfUserInfoUpdatedResult
The result of the event callback.
Properties
info
ZIMEventOfUserRuleUpdatedResult
The result of the event callback.
Properties
userRule
ZIMFileCacheClearConfig
Clear cache configuration.
Details
Clear cache configuration.
Properties
endTime
endTime: number Expiration stamp of cache cleanup.
- Required: Not required.
ZIMFileCacheQueriedResult
Callback for querying the results of the local cache.
- Related APIs: The local cache is queried using [queryLocalFileCache]. Success or failure is notified by this callback.
Properties
totalFileSize
totalFileSize: number Total file size.
ZIMFileCacheQueryConfig
Query cache configuration.
Details
Query cache configuration.
Properties
endTime
endTime: number Example Query the expiration timestamp of the cache.
- Required: Not required.
ZIMFileMessage
File message object.
Details
Identifies the basic parameters of a message.
- Caution: If the Type parameter of the base class is File during callback, you can force the base class message object to be of this type.
Properties
fileLocalPath
fileLocalPath: string - Required: If a local file is sent, this parameter must be set by the sender. Otherwise, the message fails to be sent.
fileDownloadUrl
fileDownloadUrl: string Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.
Required or not: If an external URL is sent, this parameter is mandatory on the sender end.
fileUID
fileUID: string Detail description: The unique ID of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
fileName
fileName: string Detail description: The filename of the media file.
Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.
fileSize
fileSize: number Detail description: The size of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
type
messageID
messageID: string The unique ID that identifies this message.
- Use cases: Can be used to index other messages.
- Caution: When the developer actively creates a message, there is no need to modify this parameter. This parameter only has a value during callback.
timestamp
timestamp: number Identifies the sending time of a message
- Use cases: Used to present the sending time of a message, and can be used for message sorting.
- Caution: This is a standard UNIX timestamp, in milliseconds.
senderUserID
senderUserID: string Displays the userID of the sender of this message.
conversationID
conversationID: string Conversation ID. Ids of the same conversation type are unique.
direction
sentStatus
conversationType
conversationType: ZIMConversationType The type of conversation to which the message belongs.
conversationSeq
conversationSeq: number Indicates the sequence number of the message in the conversation.
orderKey
orderKey: number The larger the orderKey, the newer the message, and can be used for ordering messages.
localMessageID
localMessageID: string SDK locally generated MessageID, developers do not need to pay attention to.
isUserInserted
isUserInserted: boolean Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].
Default: false.
receiptStatus
receiptStatus: ZIMMessageReceiptStatus Describe the receipt status of the message
Business scenario: used to determine the status of the current message in the receipt message
extendedData
extendedData: string message extension field
- Use cases: You can add extended fields to the message and send it to the peer
- Required: no
- Caution: the length is 1k, you can contact technical support for configuration
- Available since: 2.6.0 or higher
localExtendedData
localExtendedData: string The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
isBroadcastMessage
isBroadcastMessage: boolean Whether the message is pushed by all employees.
- Required: Internal assignment.
isMentionAll
isMentionAll: boolean Whether to mention everyone. It can be presented as "@Everyone".
- Use cases: For example, it can be used in groups or rooms.
- Required: No.
- Default value: false.
- Recommended value: Set to true if you need to mention everyone.
- Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
mentionedUserIDs
mentionedUserIDs: string[] Whether to mention everyone. It can be presented as "@User".
- Use cases: For example, it can be used in sending messages.
- Required: No.
- Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
messageSeq
messageSeq: number Indicates the sequence number of the message in the conversation.
rootRepliedCount
rootRepliedCount: number The number of reply messages corresponding to the root message of the reply message tree.
repliedInfo
repliedInfo: ZIMMessageRepliedInfo Information about the source message referenced by the reply message.
editorUserID
editorUserID: string The latest editor's userID for this message.
editedTime
editedTime: number The latest editing timestamp for this message.
isGroupTargetedMessage
isGroupTargetedMessage: boolean Identify if this message is group targeted message.
pinnedUserID
pinnedUserID: string The last user who pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
pinnedTime
pinnedTime: number The last timestamp when pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
ZIMFileMessageLiteInfo
File message lite info object.
Details
Identifies the basic parameters of a message.
Properties
fileLocalPath
fileLocalPath: string - Required: If a local file is sent, this parameter must be set by the sender. Otherwise, the message fails to be sent.
fileDownloadUrl
fileDownloadUrl: string Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.
Required or not: If an external URL is sent, this parameter is mandatory on the sender end.
fileName
fileName: string Detail description: The filename of the media file.
Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.
fileSize
fileSize: number Detail description: The size of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
type
ZIMFriendAddConfig
The behavior property of the Add Friend setting.
Details
The behavior property of the Add Friend setting.
Properties
wording
wording: string Add a friend postscript.
friendAlias
friendAlias: string Alias of friend.
friendAttributes
friendAttributes: Record<string, string> Friend attributes. Up to 5 can be set. The key of the attribute can only be selected from k0 to k4.
ZIMFriendAddedResult
The return result of adding a friend.
Details
The return of the result of adding a friend.
- Use cases: The callback is used to determine whether a friend has been added.
Related API: [checkUserIsInBlacklist],Add friends.
Properties
friendInfo
ZIMFriendAliasUpdatedResult
Return results of updating friend alias.
Details
Return results of updating friend alias.
- Use cases: After updating friend alias, the success or failure can be known through this callback.
Related API: [updateFriendAlias], update friend alias.
Properties
friendInfo
ZIMFriendApplicationAcceptConfig
Behavior attributes for accepting friend requests.
Details
Behavior attributes for accepting friend requests.
Properties
friendAlias
friendAlias: string friend alias.
friendAttributes
friendAttributes: Record<string, string> friend attributes.
pushConfig
ZIMFriendApplicationAcceptedResult
Accept the returned result of friend application.
Details
Accept the returned result of friend application.
- Use cases: After accepting a friend application, the success or failure can be known through this callback. Related API: [acceptFriendApplication], Accept friend application.
Properties
friendInfo
ZIMFriendApplicationInfo
Friend application information.
Details
Detailed description: Friend application information.
Properties
applyUser
applyUser: ZIMUserInfo Detail description: If you are the applicant, here is the respondent information; if you are the respondent, here is the applicant information;
wording
wording: string The wording of friend application information.
createTime
createTime: number Friend add time.
updateTime
updateTime: number Friend application status update time.
type
state
ZIMFriendApplicationListQueriedResult
Query the returned results of the friend application list.
Details
Query the returned results of the friend application list.
- Use cases: This callback will tell you if the operation to query the list of friend application was successful or not.
Related API: [queryFriendApplicationList], Querying the friend application list.
Properties
applicationList
nextFlag
nextFlag: number The index of the current query anchor point.
ZIMFriendApplicationListQueryConfig
Query the configuration of the friend application list.
Details
Query the configuration of the friend application list.
Properties
count
count: number Total number of current queries.
nextFlag
nextFlag: number The index of the current query anchor point.
ZIMFriendApplicationRejectConfig
Behavior attributes for rejecting friend application.
Details
Behavior attributes for rejecting friend application.
Properties
pushConfig
ZIMFriendApplicationRejectedResult
Reject the returned result of friend application.
Details
Reject the returned result of friend application.
- Use cases: After rejecting a friend application, the success or failure can be known through this callback. Related API: [rejectFriendApplication], Reject friend application.
Properties
userInfo
ZIMFriendApplicationSendConfig
The behavior property of the Send Friend Application setting.
Details
The behavior property of the Send Friend Application setting.
Properties
wording
wording: string Add a friend postscript.
friendAlias
friendAlias: string Alias of friend.
friendAttributes
friendAttributes: Record<string, string> Friend attributes. Up to 5 can be set. The key of the attribute can only be selected from k0 to k4.
pushConfig
ZIMFriendApplicationSentResult
The result of sending a friend application.
Details
The result of sending a friend application.
- Use cases: After sending the friend application operation, the success can be known through the callback.
Related API: [sendFriendApplication],send friend application
Properties
applicationInfo
ZIMFriendAttributesUpdatedResult
Return results of updating friend attributes.
Details
Return results of updating friend attributes.
- Use cases: After updating friend attributes, the success or failure can be known through this callback.
Related API: [updateFriendAttributes], update friend attributes.
Properties
friendInfo
ZIMFriendDeleteConfig
The behavior property of the Delete Friend setting.
Details
The behavior property of the Delete Friend setting.
Properties
type
ZIMFriendInfo
Friend information.
Details
Detailed description: Friend information.
Properties
userID
userID: string Detail description: UserID of the operator.
friendAlias
friendAlias: string The alias of friend.
friendAttributes
friendAttributes: Record<string, string> Friend attributes. Up to 5 can be set. The key of the attribute can only be selected from k0 to k4.
createTime
createTime: number Friend add time.
userName
userName: string User name, defined by you. For version 2.0.0 and onwards, the string has a maximum length of 256 bytes.
- Required: Not required.
- Privacy reminder: Please do not provide sensitive personal information, including but not limited to mobile phone numbers, ID card numbers, passport numbers, and real names.
userAvatarUrl
userAvatarUrl: string The user avatar, which is custom generated by the developer, is not restricted by special characters and has a maximum length of 500 bytes.
- Required: Not required.
- Privacy reminder: Please do not provide sensitive personal information, including but not limited to mobile phone numbers, ID card numbers, passport numbers, and real names.
- Available since: 2.13.0 and above.
userExtendedData
userExtendedData: string Extended field information of the user.
- Caution: This property has a value only for room users.
ZIMFriendListQueriedResult
The returned result of querying the friends list.
Details
The returned result of querying the friends list.
- Use cases: This callback will tell you if the operation to query the list of friends was successful or not.
Related API: [queryFriendList], Querying the friends list.
Properties
friendList
nextFlag
nextFlag: number The index of the current query anchor point.
ZIMFriendListQueryConfig
Query the configuration of the friend list.
Details
Query the configuration of the friend list.
Properties
count
count: number Total number of current queries.
nextFlag
nextFlag: number The index of the current query anchor point.
ZIMFriendRelationCheckConfig
Check the behavior properties of friend relationships.
Details
Check the behavior properties of friend relationships.
Properties
type
ZIMFriendRelationInfo
Friend relationship information.
Details
Detailed description: Friend relationship information.
Properties
userID
userID: string user ID.
type
ZIMFriendsDeletedResult
Return results of deleting friends.
Details
Return results of deleting friends.
- Use cases: After deleting a friend, the success or failure can be known through this callback.
Related API: [sendFriendApplication], Delete friends in batches.
Properties
errorUserList
ZIMFriendsInfoQueriedResult
Return results of querying friend information in batches.
Details
Return results of querying friend information in batches.
- Use cases: After querying friend information in batches, the success or failure can be known through this callback.
Related API: [queryFriendsInfo], Querying friend information in batches.
Properties
friendInfos
errorUserList
ZIMFriendsRelationCheckedResult
Check the friend relationship result.
Details
The result of sending a friend application.
- Use cases: After checking the friend relationship, the success or failure can be known through this callback.
Related API: [checkFriendsRelation], check the friend relationship.
Properties
relationInfos
errorUserList
errorUserList: ZIMErrorUserInfo[] Check the list of user IDs and reasons for friend relationship failure.
ZIMFriendsSearchConfig
Search local friend configuration.
Details
Search local friend configuration.
Properties
keywords
keywords: string[] Search keyword list.
isAlsoMatchFriendAlias
isAlsoMatchFriendAlias: boolean Whether to match friend aliases.
count
count: number Current total number of searches.
nextFlag
nextFlag: number The starting and ending index of the current search.
ZIMFriendsSearchedResult
Search results returned by local friends.
Details
Search results returned by local friends.
- Use cases: This callback will tell you if the operation to query the list of friend application was successful or not.
Related API: [searchLocalFriends], Search results returned by local friends.
Properties
friendInfos
nextFlag
nextFlag: number The index of the current query anchor point.
ZIMGroup
complete group information for group list.
Details
complete group information for group list.
Properties
baseInfo
notificationStatus
notificationStatus: ZIMGroupMessageNotificationStatus group message notification status.
groupAlias
groupAlias: string the group alias defined by user, which is visible only to that user.
ZIMGroupAdvancedConfig
Group advanced configuration.
Details
Group advanced configuration.
- Required: required.
Properties
groupAttributes
groupAttributes: Record<string, string> Group properties, up to 10 can be configured..
- Required: Optional.
groupNotice
groupNotice: string group notice.
- Required: Optional.
maxMemberCount
maxMemberCount: number The maximum number of group members.
- Use cases: When you need to limit the number of group members.
- Required: Optional.
- Default value: 0.
- Value range: [0, The default maximum number of group members for the business package].
- Caution: Supports version 2.15 and above.
joinMode
joinMode: ZIMGroupJoinMode Verification mode for joining the group.
- Required: Optional.
- Caution: Supports version 2.15 and above.
inviteMode
inviteMode: ZIMGroupInviteMode Verification mode for invite to the group.
- Required: Optional.
- Caution: Supports version 2.15 and above.
beInviteMode
beInviteMode: ZIMGroupBeInviteMode Verification mode for being invited to the group.
- Required: Optional.
- Caution: Supports version 2.15 and above.
ZIMGroupAliasUpdatedResult
Returns the result of the group alias update.
Details
Return result of group alias update operation.
- Use cases: After a group alias update operation is performed, the success or failure can be determined by this callback.
When to
- Trigger: The result of the group alias update operation is returned.
- Related APIs: [updateGroupAlias], the group alias is updated.
Properties
groupID
groupID: string ID of the group.
groupAlias
groupAlias: string Alias of the group.
ZIMGroupApplicationInfo
Group application information.
Properties
applyUser
applyUser: ZIMUserInfo Detail description: The applicant is the applicant when applying to join, the invitee when applying to invite, and the inviter when applying by invitation.
wording
wording: string The wording of group application information.
createTime
createTime: number Group application create time.
updateTime
updateTime: number Group application status update time.
type
state
groupInfo
operatedUser
operatedUser: ZIMGroupMemberSimpleInfo The operator who agrees to join the group application.
ZIMGroupApplicationListQueriedResult
Query the callback of group application list.
Details
Return of group application list query results..
- Use cases: After querying the group application list, the success or failure can be determined by this callback.
- Related APIs: [queryGroupApplicationList], query group application list.
Properties
applicationList
nextFlag
nextFlag: number The next flag.
ZIMGroupApplicationListQueryConfig
Query the group application configuration.
Details
Through this configuration, you can set the total number of queries and the pagination query.
Properties
count
count: number count. It is advised to be no more than 30.
- Required: Yes.
nextFlag
nextFlag: number nextFlag.
- Required: Not required, it is 0 by default for the first time, which means to start the query from the beginning.
ZIMGroupAttributesOperatedResult
Returns the result of a group attribute operation.
Properties
groupID
groupID: string Group ID.
errorKeys
errorKeys: string[] error keys.
ZIMGroupAttributesQueriedResult
The return of query group attribute results.
Details
Returns the result of group attribute query.
- Use cases: This callback is used to determine the success of a custom property query.
- When to call /Trigger: Group attribute query results are returned.
Related API: [queryGroupAttributes], query room attributes.
Properties
groupID
groupID: string Group ID.
groupAttributes
groupAttributes: Record<string, string> Group attributes.
ZIMGroupAttributesUpdateInfo
Group attribute update information.
Details
Group attribute update information.
Properties
action
groupAttributes
groupAttributes: Record<string, string> group properties.
ZIMGroupAvatarUrlUpdatedResult
Returns the result of the group avatar URL update.
Properties
groupID
groupID: string Group ID.
groupAvatarUrl
groupAvatarUrl: string group avatar URL.
ZIMGroupBeInviteModeUpdatedResult
The result of group beinvite verification mode update.
Properties
groupID
groupID: string Group ID.
mode
ZIMGroupConversation
Group session object, extend from ZIMGroupConversation.
Details
Group session object, extend from ZIMGroupConversation.
Properties
mutedExpiredTime
mutedExpiredTime: long long The expiration date of the group gag.
isDisabled
isDisabled: boolean Whether the group session is unavailable.
conversationID
conversationID: string conversationID.
conversationName
conversationName: string conversationName is the same as the groupName/userName value corresponding to the session.
type
unreadMessageCount
unreadMessageCount: number Session unread.
lastMessage
orderKey
orderKey: number OrderKey is used to describe the order of messages in the session. The larger orderKey is, the newer it is.
notificationStatus
notificationStatus: ZIMConversationNotificationStatus session notification status.
conversationAvatarUrl
conversationAvatarUrl: string Detail description: Conversation avatar URL. The peer to peer chat conversation avatar URL is the same as the user avatar URL, and the group chat conversation avatar URL is the same as the group avatar URL.
Use Limit: the maximum number of characters is 500 bytes. There is no limit on special characters.
isPinned
isPinned: boolean Whether the conversation is pinned.
mentionedInfoList
mentionedInfoList: ZIMMessageMentionedInfo[] When reminded in a message or reminded to everyone in a conversation, this array will record the reminders.
- Use cases: For example, you can display the number of reminders in the conversation list based on this array, and also display which user's reminder it is.
conversationAlias
conversationAlias: string After the friend remarks are set through [updateFriendAlias], this parameter is changed for each chat conversation. After setting a group alias by [updateGroupAlias], the corresponding group chat conversation's parameter will be modified synchronously.
- Use cases: After update alias for friends or groups, the corresponding conversation chooses to display the alias over the conversation name when rendering the conversation page.
marks
marks: std::vector\<int> Describes all the existing marks for the conversation.
- Use cases: The business layer can group logic, etc., according to different conversations with different marks.
draft
draft: string Conversation draft, when draft set conversation will carry this parameter.
ZIMGroupCreatedResult
Returns the result of creating a group.
Properties
groupInfo
userList
errorUserList
errorUserList: ZIMErrorUser[] error user list.
ZIMGroupDismissedResult
Returns the result of dismiss a group.
Properties
groupID
groupID: string Group ID.
ZIMGroupEnterInfo
Information about group members when they join the group.
Properties
enterType
enterType: number Group entry type.
enterTime
enterTime: number The timestamp of the server when joining the group.
operatedUser
operatedUser: ZIMGroupMemberSimpleInfo The operator who agrees to the application to join the group or the inviter who invites the application to join the group.
ZIMGroupFullInfo
complete group information.
Details
complete group information.
Properties
baseInfo
groupAttributes
groupAttributes: Record<string, string> group properties.
groupNotice
groupNotice: string Group of announcement.
notificationStatus
notificationStatus: ZIMGroupMessageNotificationStatus group message notification status.
mutedInfo
createTime
createTime: number The timestamp of the server when the group was created.
- Caution: Supports version 2.15 and above.
maxMemberCount
maxMemberCount: number The maximum number of group members.
- Caution: Supports version 2.15 and above.
verifyInfo
verifyInfo: ZIMGroupVerifyInfo Verification mode for joining the group.
- Caution: Supports version 2.15 and above.
groupAlias
groupAlias: string the group alias defined by user, which is visible only to that user.
ZIMGroupInfo
group information.
Details
group information.
Properties
groupID
groupID: string groupID.
Required or not: Mandatory, it will be automatically generated in the background.
Value: Supports only digits, English characters, and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~' and not by '#' at the beginning.
groupName
groupName: string Group name.
- Required: Optional.
Value: A string of up to 50 bytes.
groupAvatarUrl
groupAvatarUrl: string - Required: not required.
Use Limit: the maximum number of characters is 500 bytes. There is no limit on special characters.
ZIMGroupInfoQueriedResult
Returns the result of the group info queried.
Properties
groupInfo
ZIMGroupInviteApplicationAcceptConfig
The behavior property of the accept group invite application setting.
Properties
pushConfig
ZIMGroupInviteApplicationAcceptedResult
The return of the results of the group invite application accept.
Properties
groupID
groupID: string Group ID.
inviterUserID
inviterUserID: string Inviter user ID.
ZIMGroupInviteApplicationRejectConfig
The behavior property of the reject group invite application setting.
Properties
pushConfig
ZIMGroupInviteApplicationRejectedResult
The return of the results of the group invite application reject.
Properties
groupID
groupID: string Group ID.
inviterUserID
inviterUserID: string Inviter user ID.
ZIMGroupInviteApplicationSendConfig
The behavior property of the send group invite application setting.
Properties
wording
wording: string Postscript to the application operation.
pushConfig
ZIMGroupInviteApplicationsSentResult
The return of the results of the group invite application sent.
Properties
groupID
groupID: string Group ID.
errorUserList
ZIMGroupInviteModeUpdatedResult
The result of group invite verification mode update.
Properties
groupID
groupID: string Group ID.
mode
ZIMGroupJoinApplicationAcceptConfig
The behavior property of the accept group join application setting.
Properties
pushConfig
ZIMGroupJoinApplicationAcceptedResult
The return of the results of the group join application accept.
Properties
groupID
groupID: string Group ID.
userID
userID: string Applicant user ID.
ZIMGroupJoinApplicationRejectConfig
The behavior property of the reject group join application setting.
Properties
pushConfig
ZIMGroupJoinApplicationRejectedResult
The return of the results of the group join application reject.
Properties
groupID
groupID: string Group ID.
userID
userID: string Applicant user ID.
ZIMGroupJoinApplicationSendConfig
The behavior property of the send group join application setting.
Properties
wording
wording: string Postscript to the application operation.
pushConfig
ZIMGroupJoinApplicationSentResult
The return of the results of the group join application sent.
Properties
groupID
groupID: string Group ID.
ZIMGroupJoinModeUpdatedResult
The result of group join verification mode update.
Properties
groupID
groupID: string Group ID.
mode
ZIMGroupJoinedResult
Returns the result of Joining a group.
Properties
groupInfo
ZIMGroupLeftResult
Returns the result of leave a group.
Properties
groupID
groupID: string Group ID.
ZIMGroupListQueriedResult
Returns the results of the query group list.
Properties
groupList
ZIMGroupMemberCountQueriedResult
Returns the result of querying the group member count.
Details
Returns the result of querying the group member count.
- Use cases: After querying the group member count, you can use the callback to determine whether the query is successful.
- When to call /Trigger: The result is displayed after the group member count is queried.
Related API:[queryGroupMemberCount], query the group member count.
Properties
groupID
groupID: string Group ID.
count
count: number group member count.
ZIMGroupMemberInfo
Group member information.
Details
Group member information.
Properties
memberNickname
memberNickname: string Group member nickname.
memberRole
memberRole: number group role.
memberAvatarUrl
memberAvatarUrl: string Detailed description: group member avatar URL.
User Limit: the maximum number of characters is 500 bytes. There is no limit on special characters.
muteExpiredTime
muteExpiredTime: number Group member's mute expiration time. When it's 0, it means no mute; when it's -1, it means permanent mute.
groupEnterInfo
groupEnterInfo: ZIMGroupEnterInfo Information about group members when they join the group.
- Caution: Supports version 2.15 and above.
userID
userID: string User ID, a string with a maximum length of 32 bytes or less. It is customized by the developer. Only support numbers, English characters and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.
userName
userName: string User name, defined by you. For version 2.0.0 and onwards, the string has a maximum length of 256 bytes.
- Required: Not required.
- Privacy reminder: Please do not provide sensitive personal information, including but not limited to mobile phone numbers, ID card numbers, passport numbers, and real names.
userAvatarUrl
userAvatarUrl: string The user avatar, which is custom generated by the developer, is not restricted by special characters and has a maximum length of 500 bytes.
- Required: Not required.
- Privacy reminder: Please do not provide sensitive personal information, including but not limited to mobile phone numbers, ID card numbers, passport numbers, and real names.
- Available since: 2.13.0 and above.
userExtendedData
userExtendedData: string Extended field information of the user.
- Caution: This property has a value only for room users.
ZIMGroupMemberInfoQueriedResult
Returns the result of the group member query.
Properties
groupID
groupID: string Group ID.
userInfo
ZIMGroupMemberKickedResult
Returns the result of kicking out a group member.
Properties
groupID
groupID: string Group ID.
kickedUserIDs
kickedUserIDs: string[] user list.
errorUserList
errorUserList: ZIMErrorUser[] List of users who failed to kick.
ZIMGroupMemberListQueriedResult
Returns the result of querying the group member list.
Details
Returns the result of querying the group member list.
- Use cases: After querying the group member list, you can use the callback to determine whether the query is successful.
- When to call /Trigger: The result is displayed after the group member list is queried.
Related API:[queryGroupMemberList], query the group member list.
Properties
groupID
groupID: string Group ID.
userList
nextFlag
nextFlag: number next flag.
ZIMGroupMemberMuteConfig
Group members mute configuration.
Details
Group members mute configuration.
- Required: required.
Properties
duration
duration: number Group members mute duration, the unit is seconds. The value is -1, which means permanent mute. If you need to implement non-permanent mute, the upper limit is 604800 (7 days). If you need to increase it, please contact ZEGO technical support.
- Required: Required.
ZIMGroupMemberMutedListQueriedResult
Returns the result of querying the group muted member list.
Details
Returns the result of querying the group muted member list.
- Use cases: After querying the group muted member list, you can use the callback to determine whether the query is successful.
When to trigger: The result is displayed after the group muted member list is queried.
- Related APIs: [queryGroupMemberMutedList], query the group muted member list.
Properties
groupID
groupID: string group ID
nextFlag
nextFlag: number nextFlag.
userList
ZIMGroupMemberMutedListQueryConfig
Group muted member list query configuration.
Details
Group muted member list query configuration.
Properties
count
count: number count.
- Required: Required.
nextFlag
nextFlag: number nextFlag.
- Required: Not required, it is empty by default for the first time, which means to start the query from the beginning.
ZIMGroupMemberNicknameUpdatedResult
Returns the result of the member nickname update.
Properties
groupID
groupID: string Group ID.
forUserID
forUserID: string user ID.
nickname
nickname: string nickname.
ZIMGroupMemberQueryConfig
group member query configuration.
Details
group member query configuration.
Properties
count
count: number count. Quantity, upper limit is 100, over 100 will be treated as 100.
- Required: Required.
nextFlag
nextFlag: number nextFlag.
- Required: Not required, it is empty by default for the first time, which means to start the query from the beginning.
ZIMGroupMemberRoleUpdatedResult
Returns the result of the member role update.
Properties
groupID
groupID: string Group ID.
forUserID
forUserID: string user ID.
role
role: number role.
ZIMGroupMemberSearchConfig
group member search configuration.
Details
group member search configuration.
Properties
count
count: number count.
- Required: Required.
nextFlag
nextFlag: number The flag for querying, fill in 0 when calling the interface for the first time. When calling the interface again later, fill in the nextFlag returned from the callback to retrieve the remaining data.
- Required: Not required.
keywords
keywords: string[] Search keywords, up to 5 keywords are supported, otherwise an error will be reported. For example: passing in "1" and "2" will make the search results only show group members whose names contain both keywords "1" and "2".
- Required: No
- Caution: Up to 5 keywords can be entered, otherwise an error will be reported.
isAlsoMatchGroupMemberNickname
isAlsoMatchGroupMemberNickname: boolean Whether the search scope includes group member user nickname. Default is false.
- Required: No.
- Default value: false
ZIMGroupMemberSimpleInfo
Group member simple information.
Properties
memberNickname
memberNickname: string Group member nickname.
memberRole
memberRole: number group role.
userID
userID: string User ID, a string with a maximum length of 32 bytes or less. It is customized by the developer. Only support numbers, English characters and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.
userName
userName: string User name, defined by you. For version 2.0.0 and onwards, the string has a maximum length of 256 bytes.
- Required: Not required.
- Privacy reminder: Please do not provide sensitive personal information, including but not limited to mobile phone numbers, ID card numbers, passport numbers, and real names.
userAvatarUrl
userAvatarUrl: string The user avatar, which is custom generated by the developer, is not restricted by special characters and has a maximum length of 500 bytes.
- Required: Not required.
- Privacy reminder: Please do not provide sensitive personal information, including but not limited to mobile phone numbers, ID card numbers, passport numbers, and real names.
- Available since: 2.13.0 and above.
userExtendedData
userExtendedData: string Extended field information of the user.
- Caution: This property has a value only for room users.
ZIMGroupMembersMutedResult
Returns the result of mute group members.
Details
Returns the result of a group mute operation.
- Use cases: After performing a group mute operation, whether it is successful or not can be known through this result.
Related API: [muteGroup], mute group members.
Properties
groupID
groupID: string group ID
isMute
isMute: boolean Group members mute or lift group members mute.
duration
duration: number Duration of group member mute, in seconds.
mutedUserIDs
mutedUserIDs: string[] List of group member IDs successfully modified to mute status.
errorUserList
errorUserList: ZIMErrorUserInfo[] List of group members failed to modify to mute status.
ZIMGroupMembersSearchedResult
Returns the result of search a group members.
Details
Returns the result of a group member search operation.
- Use cases: After performing a group member search operation, whether it is successful or not can be known through this callback.
Related API: [searchLocalGroupMembers], search for group members.
Properties
groupID
groupID: string Group ID.
userList
nextFlag
nextFlag: number Pagination flag, fill in 0 when calling the interface for the first time. Fill in the nextFlag returned from the Promise callback for subsequent interface calls to retrieve the remaining data.
ZIMGroupMessageReceiptMemberListQueriedResult
Callback interface for querying the specific read/unread member list of group receipt messages.
Details
Supported version: 2.5.0 and above.
Detailed description: The callback interface for querying the specific read/unread member list of the group receipt message.
Business scenario: Developers can judge whether the sending is successful through [errorCode] in the callback.
Notification timing: When the developer calls the [queryGroupMessageReceiptReadMemberList] / [queryGroupMessageReceiptUnreadMemberList] interface, this callback will be triggered.
Properties
nextFlag
nextFlag: number Query the flag corresponding to the next page, which is used for the next flag parameter of [ZIMGroupMessageReceiptMemberQueryConfig].
userList
groupID
groupID: string Group ID.
ZIMGroupMessageReceiptMemberQueryConfig
Details
Group message receipt read/unread member query configuration.
Properties
count
count: number - Required: Required.
nextFlag
nextFlag: number Detailed description: The next sign. Initially fill in 0, then get the next next flag from the [ZIMGroupMessageReceiptMemberListQueriedResult] callback.
ZIMGroupMuteConfig
Group mute configuration.
Details
Group mute configuration.
- Required: required.
Properties
mode
duration
duration: number Group mute duration, the unit is seconds. The value is -1, which means permanent mute. If you need to implement non-permanent mute, the upper limit is 604800 (7 days). If you need to increase it, please contact ZEGO technical support.
- Required: Required.
roles
roles: number[] Group role list.
- Required: This field is only meaningful when ZIMGroupMuteMode is set to Custom.
- Caution: When there is a 3 (ordinary user) in the list, other roles must also be present and cannot be 1, 2, or 4. If only muting ordinary users is needed, ZIMGroupMuteMode should be set to Normal.
ZIMGroupMuteInfo
Group mute information.
Details
Group mute information.
Properties
mode
expiredTime
expiredTime: number Group mute expiration time, measured in seconds. When it's 0, there is no mute; when it's -1, it means permanent mute.
roles
roles: number[] Detail description: Role list muted in the group.
ZIMGroupMutedResult
Returns the result of mute group.
Details
Returns the result of a group mute operation.
- Use cases: After performing a group mute operation, whether it is successful or not can be known through this result.
Related API: [muteGroup], mute group.
Properties
groupID
groupID: string Group ID.
isMute
isMute: boolean mute of unmute.
mutedInfo
ZIMGroupNameUpdatedResult
Returns the result of the group name update.
Properties
groupID
groupID: string Group ID.
groupName
groupName: string group name.
ZIMGroupNoticeUpdatedResult
Returns the result of the group notice update.
Properties
groupID
groupID: string Group ID.
groupNotice
groupNotice: string group notice.
ZIMGroupOperatedInfo
The group causes the event to change the operator's information.
Details
The group causes the event to change the operator's information.
Properties
operatedUserInfo
operatedUserInfo: ZIMGroupMemberInfo Group member information.
userID
userID: string The operator's user ID.
userName
userName: string The operator's username.
memberNickname
memberNickname: string The operator's group member nickname.
memberRole
memberRole: number The operator's group member role.
ZIMGroupOwnerTransferredResult
Returns the result of the group owner assignment.
Properties
groupID
groupID: string Group ID.
toUserID
toUserID: string user ID.
ZIMGroupSearchConfig
Group search configuration.
Details
Group search configuration.
Properties
count
count: number count.
- Required: Required.
nextFlag
nextFlag: number The flag used to search groups.
- Required: The flag should be 0 when you search groups for the first time. After that, the flag should be the same as the nextFlag from the search result Promise to get the next page data.
keywords
keywords: string[] Search keywords. For example: passing in "1" and "2" will make the search results only show groups whose group names contain both keywords "1" and "2".
- Required: No
- Caution: Up to 5 keywords can be entered, otherwise an error will be reported.
isAlsoMatchGroupMemberNickname
isAlsoMatchGroupMemberNickname: boolean Whether the search scope includes group member user nicknames. Default is false.
- Required: No.
- Default value: false
isAlsoMatchGroupMemberUserName
isAlsoMatchGroupMemberUserName: boolean Whether the search scope includes group member user names. Default is false.
- Required: No.
- Default value: false
ZIMGroupSearchInfo
Group search info.
Details
Group search info.
Properties
groupInfo
userList
ZIMGroupUsersInvitedResult
The result of the user being invited to the group is returned.
Properties
groupID
groupID: string Group ID.
userList
errorUserList
errorUserList: ZIMErrorUser[] List of users who failed to invite.
ZIMGroupVerifyInfo
Verification mode for joining the group.
Properties
joinMode
inviteMode
beInviteMode
ZIMGroupsSearchedResult
Returns the result of search a group.
Details
Returns the result of a group search operation.
- Use cases: After performing a group search operation, whether it is successful or not can be known through this callback.
Related API: [searchLocalGroups], search for groups.
Properties
groupSearchInfoList
nextFlag
nextFlag: number The next flag.
ZIMImageMessage
Image message object.
Details
Identifies the basic parameters of a message.
- Caution: If the Type parameter of the base class is Image during callback, you can force the base class message object to be of this type.
Properties
thumbnailLocalPath
thumbnailLocalPath: string Detailed description: The thumbnail local path of the image file.
Required or not: The sender does not need to fill in it. After calling [downloadMediaFile] to download, the SDK will generate this value.
thumbnailDownloadUrl
thumbnailDownloadUrl: string Detail description: Thumbnail external download URL of the image file. When developers upload thumbnails to their own servers, the SDK can pass through this field to other users.
Required or not: optional on the sender side, this field will only take effect when fileDownloadUrl is filled in.
largeImageLocalPath
largeImageLocalPath: string Detailed description: The large image local path of the image file.
Required or not: The sender does not need to fill in it. After calling [downloadMediaFile] to download, the SDK will generate this value.
largeImageDownloadUrl
largeImageDownloadUrl: string Detail description: large Image external download URL of the image file. When developers upload large Images to their own servers, the SDK can pass through this field to other users.
Required or not: optional on the sender side, this field will only take effect when fileDownloadUrl is filled in.
originalImageWidth
originalImageWidth: number Original image width.
- Use cases: When the user needs to draw the image UI, the parameter used to determine the width of the original image,the unit is pixel.
originalImageHeight
originalImageHeight: number Original image height.
- Use cases: When the user needs to draw the image UI, the parameter used to determine the height of the original image,the unit is pixel.
largeImageWidth
largeImageWidth: number Large image width. When sending local images, the ZIM service will compress the shortest side of the original image to 720 pixels, with the other side being scaled proportionally. When the shortest side of the original image is less than 720 pixels, no compression is applied.
- Use cases: When the user needs to draw the image UI, the parameter used to determine the width of the large image, the unit is pixel.
largeImageHeight
largeImageHeight: number Large image height. When sending local images, the ZIM service will compress the shortest side of the original image to 720 pixels, with the other side being scaled proportionally. When the shortest side of the original image is less than 720 pixels, no compression is applied.
- Use cases: When the user needs to draw the image UI, the parameter used to determine the height of the large image, the unit is pixel.
thumbnailWidth
thumbnailWidth: number Thumbnail width. When sending local images, the ZIM service will compress the shortest side of the original image to 198 pixels, with proportional scaling applied to the other side. If the shortest side of the original image is smaller than 198 pixels, no compression will be performed.
- Use cases: When the user needs to draw the image UI, the parameter used to determine the width of the thumbnail, the unit is pixel.
thumbnailHeight
thumbnailHeight: number Thumbnail height. When sending local images, the ZIM service will compress the shortest side of the original image to 198 pixels, with proportional scaling applied to the other side. If the shortest side of the original image is smaller than 198 pixels, no compression will be performed.
- Use cases: When the user needs to draw the image UI, the parameter used to determine the height of the thumbnail, the unit is pixel.
fileLocalPath
fileLocalPath: string - Required: If a local file is sent, this parameter must be set by the sender. Otherwise, the message fails to be sent.
fileDownloadUrl
fileDownloadUrl: string Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.
Required or not: If an external URL is sent, this parameter is mandatory on the sender end.
fileUID
fileUID: string Detail description: The unique ID of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
fileName
fileName: string Detail description: The filename of the media file.
Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.
fileSize
fileSize: number Detail description: The size of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
type
messageID
messageID: string The unique ID that identifies this message.
- Use cases: Can be used to index other messages.
- Caution: When the developer actively creates a message, there is no need to modify this parameter. This parameter only has a value during callback.
timestamp
timestamp: number Identifies the sending time of a message
- Use cases: Used to present the sending time of a message, and can be used for message sorting.
- Caution: This is a standard UNIX timestamp, in milliseconds.
senderUserID
senderUserID: string Displays the userID of the sender of this message.
conversationID
conversationID: string Conversation ID. Ids of the same conversation type are unique.
direction
sentStatus
conversationType
conversationType: ZIMConversationType The type of conversation to which the message belongs.
conversationSeq
conversationSeq: number Indicates the sequence number of the message in the conversation.
orderKey
orderKey: number The larger the orderKey, the newer the message, and can be used for ordering messages.
localMessageID
localMessageID: string SDK locally generated MessageID, developers do not need to pay attention to.
isUserInserted
isUserInserted: boolean Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].
Default: false.
receiptStatus
receiptStatus: ZIMMessageReceiptStatus Describe the receipt status of the message
Business scenario: used to determine the status of the current message in the receipt message
extendedData
extendedData: string message extension field
- Use cases: You can add extended fields to the message and send it to the peer
- Required: no
- Caution: the length is 1k, you can contact technical support for configuration
- Available since: 2.6.0 or higher
localExtendedData
localExtendedData: string The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
isBroadcastMessage
isBroadcastMessage: boolean Whether the message is pushed by all employees.
- Required: Internal assignment.
isMentionAll
isMentionAll: boolean Whether to mention everyone. It can be presented as "@Everyone".
- Use cases: For example, it can be used in groups or rooms.
- Required: No.
- Default value: false.
- Recommended value: Set to true if you need to mention everyone.
- Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
mentionedUserIDs
mentionedUserIDs: string[] Whether to mention everyone. It can be presented as "@User".
- Use cases: For example, it can be used in sending messages.
- Required: No.
- Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
messageSeq
messageSeq: number Indicates the sequence number of the message in the conversation.
rootRepliedCount
rootRepliedCount: number The number of reply messages corresponding to the root message of the reply message tree.
repliedInfo
repliedInfo: ZIMMessageRepliedInfo Information about the source message referenced by the reply message.
editorUserID
editorUserID: string The latest editor's userID for this message.
editedTime
editedTime: number The latest editing timestamp for this message.
isGroupTargetedMessage
isGroupTargetedMessage: boolean Identify if this message is group targeted message.
pinnedUserID
pinnedUserID: string The last user who pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
pinnedTime
pinnedTime: number The last timestamp when pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
ZIMImageMessageLiteInfo
Image message lite info object.
Details
Identifies the basic parameters of a image message.
Properties
thumbnailLocalPath
thumbnailLocalPath: string Detailed description: The thumbnail local path of the image file.
Required or not: The sender does not need to fill in it. After calling [downloadMediaFile] to download, the SDK will generate this value.
thumbnailDownloadUrl
thumbnailDownloadUrl: string Detail description: Thumbnail external download URL of the image file. When developers upload thumbnails to their own servers, the SDK can pass through this field to other users.
Required or not: optional on the sender side, this field will only take effect when fileDownloadUrl is filled in.
largeImageLocalPath
largeImageLocalPath: string Detailed description: The large image local path of the image file.
Required or not: The sender does not need to fill in it. After calling [downloadMediaFile] to download, the SDK will generate this value.
largeImageDownloadUrl
largeImageDownloadUrl: string Detail description: large Image external download URL of the image file. When developers upload large Images to their own servers, the SDK can pass through this field to other users.
Required or not: optional on the sender side, this field will only take effect when fileDownloadUrl is filled in.
originalImageWidth
originalImageWidth: number Original image width.
- Use cases: When the user needs to draw the image UI, the parameter used to determine the width of the original image,the unit is pixel.
originalImageHeight
originalImageHeight: number Original image height.
- Use cases: When the user needs to draw the image UI, the parameter used to determine the height of the original image,the unit is pixel.
largeImageWidth
largeImageWidth: number Large image width. When sending local images, the ZIM service will compress the shortest side of the original image to 720 pixels, with the other side being scaled proportionally. When the shortest side of the original image is less than 720 pixels, no compression is applied.
- Use cases: When the user needs to draw the image UI, the parameter used to determine the width of the large image, the unit is pixel.
largeImageHeight
largeImageHeight: number Large image height. When sending local images, the ZIM service will compress the shortest side of the original image to 720 pixels, with the other side being scaled proportionally. When the shortest side of the original image is less than 720 pixels, no compression is applied.
- Use cases: When the user needs to draw the image UI, the parameter used to determine the height of the large image, the unit is pixel.
thumbnailWidth
thumbnailWidth: number Thumbnail width. When sending local images, the ZIM service will compress the shortest side of the original image to 198 pixels, with proportional scaling applied to the other side. If the shortest side of the original image is smaller than 198 pixels, no compression will be performed.
- Use cases: When the user needs to draw the image UI, the parameter used to determine the width of the thumbnail, the unit is pixel.
thumbnailHeight
thumbnailHeight: number Thumbnail height. When sending local images, the ZIM service will compress the shortest side of the original image to 198 pixels, with proportional scaling applied to the other side. If the shortest side of the original image is smaller than 198 pixels, no compression will be performed.
- Use cases: When the user needs to draw the image UI, the parameter used to determine the height of the thumbnail, the unit is pixel.
fileLocalPath
fileLocalPath: string - Required: If a local file is sent, this parameter must be set by the sender. Otherwise, the message fails to be sent.
fileDownloadUrl
fileDownloadUrl: string Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.
Required or not: If an external URL is sent, this parameter is mandatory on the sender end.
fileName
fileName: string Detail description: The filename of the media file.
Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.
fileSize
fileSize: number Detail description: The size of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
type
ZIMLogConfig
Log configuration
Details
Configure the storage path of log files and the maximum log file size.
Properties
logPath
logPath: string The storage path of the log files. Refer to the official website document for the default path.
logSize
logSize: number The maximum log file size (Bytes). The default maximum size is 5MB (5 * 1024 * 1024 Bytes)
ZIMLoginConfig
Configuration of login-related parameters.
Details
Login-related parameters.
- Use cases: Used to set different parameters during login.
Properties
userName
userName: string User name.
- Use cases: Used in the scenario where user nickname is modified during login, leave it blank if no change is needed.
- Required: No.
token
token: string Token carried during login.
- Use cases: Only pass this parameter in the scenario where token is used for authentication.
- Required: No.
isOfflineLogin
isOfflineLogin: boolean Whether it is offline login.
- Use cases: Set this parameter to true when performing offline login.
- Required: No.
- Default value: false.
customStatus
customStatus: string User-defined status, with a default maximum of 64 bytes and a default expiration time of 1 day. After expiration, it will be reset to an empty string. When logging in, if this field is an empty string (default is an empty string), the current user's custom status will not be modified.
ZIMMediaDownloadConfig
Configuration for downloading media files.
Properties
messageInfoIndex
messageInfoIndex: number Detailed description: The index of the array where a file in the download multiple message is located.
- Required: Required when downloading a multiple message file.
ZIMMediaDownloadedResult
Callback for the result of downloading the file for the media message.
Details
Supported Versions: 2.1.0 and above.
Detail description: Callback for the result of downloading the file for the media message.
Business scenario: The developer can use the [errorCode] in the callback to determine whether the insertion is successful.
Notification timing: This callback is triggered when the developer calls the [downloadMediaFile] interface.
Related interfaces: Downloading the file for the media message through [downloadMediaFile], and the success will be notified through this callback.
Properties
message
ZIMMediaMessage
Base class for media message objects.
Details
Detail description: Identifies a media message.
This base class is the basis of all media messages and contains the properties required by media messages.
Properties
fileLocalPath
fileLocalPath: string - Required: If a local file is sent, this parameter must be set by the sender. Otherwise, the message fails to be sent.
fileDownloadUrl
fileDownloadUrl: string Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.
Required or not: If an external URL is sent, this parameter is mandatory on the sender end.
fileUID
fileUID: string Detail description: The unique ID of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
fileName
fileName: string Detail description: The filename of the media file.
Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.
fileSize
fileSize: number Detail description: The size of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
type
messageID
messageID: string The unique ID that identifies this message.
- Use cases: Can be used to index other messages.
- Caution: When the developer actively creates a message, there is no need to modify this parameter. This parameter only has a value during callback.
timestamp
timestamp: number Identifies the sending time of a message
- Use cases: Used to present the sending time of a message, and can be used for message sorting.
- Caution: This is a standard UNIX timestamp, in milliseconds.
senderUserID
senderUserID: string Displays the userID of the sender of this message.
conversationID
conversationID: string Conversation ID. Ids of the same conversation type are unique.
direction
sentStatus
conversationType
conversationType: ZIMConversationType The type of conversation to which the message belongs.
conversationSeq
conversationSeq: number Indicates the sequence number of the message in the conversation.
orderKey
orderKey: number The larger the orderKey, the newer the message, and can be used for ordering messages.
localMessageID
localMessageID: string SDK locally generated MessageID, developers do not need to pay attention to.
isUserInserted
isUserInserted: boolean Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].
Default: false.
receiptStatus
receiptStatus: ZIMMessageReceiptStatus Describe the receipt status of the message
Business scenario: used to determine the status of the current message in the receipt message
extendedData
extendedData: string message extension field
- Use cases: You can add extended fields to the message and send it to the peer
- Required: no
- Caution: the length is 1k, you can contact technical support for configuration
- Available since: 2.6.0 or higher
localExtendedData
localExtendedData: string The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
isBroadcastMessage
isBroadcastMessage: boolean Whether the message is pushed by all employees.
- Required: Internal assignment.
isMentionAll
isMentionAll: boolean Whether to mention everyone. It can be presented as "@Everyone".
- Use cases: For example, it can be used in groups or rooms.
- Required: No.
- Default value: false.
- Recommended value: Set to true if you need to mention everyone.
- Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
mentionedUserIDs
mentionedUserIDs: string[] Whether to mention everyone. It can be presented as "@User".
- Use cases: For example, it can be used in sending messages.
- Required: No.
- Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
messageSeq
messageSeq: number Indicates the sequence number of the message in the conversation.
rootRepliedCount
rootRepliedCount: number The number of reply messages corresponding to the root message of the reply message tree.
repliedInfo
repliedInfo: ZIMMessageRepliedInfo Information about the source message referenced by the reply message.
editorUserID
editorUserID: string The latest editor's userID for this message.
editedTime
editedTime: number The latest editing timestamp for this message.
isGroupTargetedMessage
isGroupTargetedMessage: boolean Identify if this message is group targeted message.
pinnedUserID
pinnedUserID: string The last user who pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
pinnedTime
pinnedTime: number The last timestamp when pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
ZIMMediaMessageLiteInfo
Base class for media message lite info objects.
Details
Detail description: Identifies a media message lite info.
This base class is the basis of all media messages lite info and contains the properties required by media messages lite info.
Properties
fileLocalPath
fileLocalPath: string - Required: If a local file is sent, this parameter must be set by the sender. Otherwise, the message fails to be sent.
fileDownloadUrl
fileDownloadUrl: string Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.
Required or not: If an external URL is sent, this parameter is mandatory on the sender end.
fileName
fileName: string Detail description: The filename of the media file.
Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.
fileSize
fileSize: number Detail description: The size of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
type
ZIMMediaMessageSendNotification
The notification callback when the media message is sent, you can get the relevant information before the message object is sent through this notification
Details
Detailed description: Through this notification, developers can obtain relevant information before the message object is sent, such as localMessageID, etc.
Business scenario: When developers need to record and cache relevant information before sending a message, they can obtain it by listening to the notification.
If no monitoring is required, it can be passed null.
Methods
onMessageAttached
onMessageAttached(message: ZIMMediaMessage): voidParameters
| Name | Type | Description |
|---|---|---|
| message | ZIMMediaMessage | The currently sent message object. |
Details
Supported version: 2.4.0 and above.
The incoming message object is given a localMessgeID and returned.
Service scenario: Before a message is successfully sent, it can correspond to its localMessageID to implement loading before sending.
Notification time: Triggered after the message is sent and before the message is successfully sent.
ZIMMediaMessageSentResult
Callback of the result of sending the media message.
- Related APIs: This callback is triggered when the developer calls the [sendMediaMessage] interfaces.
- Available since: 2.2.0 or above.
Properties
message
message: ZIMMediaMessage The sent message object, from which parameters such as messageID can be obtained.
ZIMMessage
Base class of message object
Details
Identifies the basic parameters of a message.
- Caution: Some of the parameters, such as Message ID, only have values during the callback. Developers do not need to assign values to these parameters when they actively create this object for sending messages.
Properties
type
messageID
messageID: string The unique ID that identifies this message.
- Use cases: Can be used to index other messages.
- Caution: When the developer actively creates a message, there is no need to modify this parameter. This parameter only has a value during callback.
timestamp
timestamp: number Identifies the sending time of a message
- Use cases: Used to present the sending time of a message, and can be used for message sorting.
- Caution: This is a standard UNIX timestamp, in milliseconds.
senderUserID
senderUserID: string Displays the userID of the sender of this message.
conversationID
conversationID: string Conversation ID. Ids of the same conversation type are unique.
direction
sentStatus
conversationType
conversationType: ZIMConversationType The type of conversation to which the message belongs.
conversationSeq
conversationSeq: number Indicates the sequence number of the message in the conversation.
orderKey
orderKey: number The larger the orderKey, the newer the message, and can be used for ordering messages.
localMessageID
localMessageID: string SDK locally generated MessageID, developers do not need to pay attention to.
isUserInserted
isUserInserted: boolean Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].
Default: false.
receiptStatus
receiptStatus: ZIMMessageReceiptStatus Describe the receipt status of the message
Business scenario: used to determine the status of the current message in the receipt message
extendedData
extendedData: string message extension field
- Use cases: You can add extended fields to the message and send it to the peer
- Required: no
- Caution: the length is 1k, you can contact technical support for configuration
- Available since: 2.6.0 or higher
localExtendedData
localExtendedData: string The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
isBroadcastMessage
isBroadcastMessage: boolean Whether the message is pushed by all employees.
- Required: Internal assignment.
isMentionAll
isMentionAll: boolean Whether to mention everyone. It can be presented as "@Everyone".
- Use cases: For example, it can be used in groups or rooms.
- Required: No.
- Default value: false.
- Recommended value: Set to true if you need to mention everyone.
- Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
mentionedUserIDs
mentionedUserIDs: string[] Whether to mention everyone. It can be presented as "@User".
- Use cases: For example, it can be used in sending messages.
- Required: No.
- Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
messageSeq
messageSeq: number Indicates the sequence number of the message in the conversation.
rootRepliedCount
rootRepliedCount: number The number of reply messages corresponding to the root message of the reply message tree.
repliedInfo
repliedInfo: ZIMMessageRepliedInfo Information about the source message referenced by the reply message.
editorUserID
editorUserID: string The latest editor's userID for this message.
editedTime
editedTime: number The latest editing timestamp for this message.
isGroupTargetedMessage
isGroupTargetedMessage: boolean Identify if this message is group targeted message.
pinnedUserID
pinnedUserID: string The last user who pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
pinnedTime
pinnedTime: number The last timestamp when pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
ZIMMessageDeleteConfig
Details
Delete configurations related to messages.
Properties
isAlsoDeleteServerMessage
isAlsoDeleteServerMessage: boolean Whether to remove flags for server messages.
- Required: not required.
- Default value: false.
ZIMMessageDeletedResult
A callback to delete a message.
Details
Supported versions: 2.0.0 and above.
Detail description: After the message is deleted, the result of message deletion is returned through this callback.
Business scenario: The developer can judge whether the deletion is successful through the [errorCode] in the callback.
Notification timing: Triggered after calling the delete message interface [deleteMessage].
Related interface: [deleteMessage].
Properties
conversationID
conversationID: string Conversation ID.
conversationType
ZIMMessageEditConfig
Details
(Empty Class) Configurations related to editing messages.
ZIMMessageEditedResult
Callback of the result of editing the message.
- Related APIs: This callback is triggered when the developer calls the [editMessage] interfaces.
- Available since: 2.20.0 or above.
Properties
message
message: ZIMMessage The edited message object, from which parameters such as editedTime and editorUserID can be obtained.
ZIMMessageExportConfig
Details
Export the configuration of the message. The Config is currently a reserved parameter.
ZIMMessageImportConfig
Details
Import the configuration of the message. The Config is currently a reserved parameter.
ZIMMessageInsertedResult
Callback of the result of inserting the message.
Details
Supported Versions: 2.4.0 and above.
Detail description: A callback for the result of inserting a local message.
Business scenario: The developer can use the [errorCode] in the callback to determine whether the insertion is successful.
Notification timing: This callback is triggered when the developer calls the [insertMessageToLocalDB] interface.
Related interfaces: Insert local messages through [insertMessageToLocalDB], and the success or failure will be notified through this callback.
Properties
message
ZIMMessageLiteInfo
Base class of message lite info object.
Details
Identifies the basic parameters of a message.
Properties
type
ZIMMessageLocalExtendedDataUpdatedResult
Callback for updating message local extension fields.
- Use cases: Developers can determine whether the operation is successful through the [errorCode] in this callback.
Notification timing: This callback is triggered when developers call the [updateMessageLocalExtendedData] interface.
Properties
message
ZIMMessageMentionedInfo
message mention information.
Details
message mention information.
Properties
messageID
messageID: number Message ID, used to match the notification information to which message it belongs to
Required or not: Developers do not need to fill in.'‘’
fromUserID
fromUserID: string From which user.
- Required: Developers do not need to fill in."
type
type: ZIMMessageMentionedType Type of notification, used to distinguish between reminding oneself and reminding everyone.
- Required: Developers do not need to fill in.
messageSeq
messageSeq: number message seq.
ZIMMessagePinStatusChangeInfo
Notification of the message pinned status changed.
Details
When a message in a conversation is successfully pinned or unpinned and a notification is raised, this structure can be used to obtain the operated message and its current pinned status.
Properties
pinStatus
message
ZIMMessagePinnedResult
Callback of the result of the message pinned or unpinned.
- Related APIs: This callback is triggered when the developer calls the [pinMessage] interfaces.
- Available since: 2.25.0 or above.
ZIMMessageQueriedResult
The developer uses this callback to get a list of queried messages, which can be used to display historical messages.
Details
Callback result of query message list.
- Use cases: Through this callback, developers can obtain the list of queried messages and display historical messages.
- When to call /Trigger: After calling queryHistoryMessage, the list of queried messages is notified through this callback.
- Related APIs: Use [queryPeerMessage] to query historical messages. The queried message list is notified through this callback.
- Available since: 2.0.0 or later.
Properties
messageList
conversationID
conversationID: string ConversationID.
conversationType
ZIMMessageQueryConfig
Example Query message configuration.
Details
Example Query the configurations of messages.
Properties
nextMessage
nextMessage: ZIMMessage Query the anchor point of the message.
- Required: This parameter is not required for the first query but is required for subsequent paging queries.
count
count: number Number of query messages.
- Required: Yes.
reverse
reverse: boolean Indicates whether the query is in reverse order.
- Required: not required.
- Default value: false.
ZIMMessageReaction
message reaction infos
Details
message reaction infos.
Properties
conversationID
conversationID: string conversationID.
conversationType
messageID
messageID: number Detail description: reaction message ID.
reactionType
reactionType: string Type of reaction, defined by you, with a maximum length of 32 bytes.
isSelfIncluded
isSelfIncluded: boolean The reaciton users if included myself.
totalCount
totalCount: number The reaction users number.
userList
ZIMMessageReactionAddedResult
Callback of the result of adding message reaction.
Details
After the developer adding message reaction, execute the callback of the result.
- When to call: This callback is triggered when a developer invokes the [addMessageReaction] interface.
- Caution: Revoke message through [addMessageReaction]. Success or failure will be notified through this callback.
- Available since: 2.10.0 or above.
Properties
reaction
ZIMMessageReactionDeletedResult
Callback of the result of deleting message reaction.
Details
After the developer adding message reaction, execute the callback of the result.
- When to call: This callback is triggered when a developer invokes the [deleteMessageReaction] interface.
- Caution: Revoke message through [deleteMessageReaction]. Success or failure will be notified through this callback.
- Available since: 2.10.0 or above.
Properties
reaction
ZIMMessageReactionUserInfo
reaction user information.
Details
Detail description: A class describing reaction user.
Properties
userID
userID: string user ID
ZIMMessageReactionUserListQueriedResult
Callback of the result of query message reaction user list.
Details
After the developer querying message reaction userList, execute the callback of the result.
- When to call: This callback is triggered when a developer invokes the [queryMessageReactionUserList] interface.
- Caution: Revoke message through [queryMessageReactionUserList]. Success or failure to querying will be notified through this callback.
- Available since: 2.10.0 or above.
Properties
message
userList
reactionType
reactionType: string Types of reaction.
nextFlag
nextFlag: number Query anchor, used for the next page to be passed to [ZIMMessageReactionUserQueryConfig] for querying.
totalCount
totalCount: number The total number of users who reaction.
ZIMMessageReactionUserQueryConfig
Configuration for querying reaction user list
Details
When querying reaction member, you need to configure this object.
Properties
nextFlag
nextFlag: number The flag of the paging query. For the first query, set this field to an empty string. If the "nextFlag" field of the [ZIMMessageReactionUserListQueriedCallback] callback is not an empty string, it needs to be set here to continue the query on the next page.
- Required: Not required.
count
count: number How many members are retrieved in one query, 100 at most. Exceeding 100 will result in an error.
- Caution: To obtain members in pages to reduce overhead, it is recommended to obtain within 20 members at a time. If the value is 0, the SDK will query 100 members by default.
- Required: Required.
reactionType
reactionType: string reaction type, defined by you.
ZIMMessageReceiptInfo
receipt information.
Details
Detailed description: receipt information.
Properties
status
messageID
messageID: string Message ID.
Business scenario: Developers can match the loaded message list according to this ID.
Is it required: No, SDK fills in.
conversationID
conversationID: string Session ID.
Business scenario: Receipt information used to indicate which session this belongs to.
Is it required: No, SDK fills in.
conversationType
conversationType: ZIMConversationType Session type.
Business scenario: Indicates the type of the session.
Is it required: If no, the SDK is filled.
readMemberCount
readMemberCount: number Detailed description: Indicates the number of people who have read the receipt.
Business scenario: When used to query receipt information, it can display how many people have read the message.
Is it required: no.
Default: 0.
This value indicates how many people have read the message, it is only applicable to the message has been read; if the message is not sent by yourself, the value is 0.
unreadMemberCount
unreadMemberCount: number Detailed description: Indicates the number of unread people of the receipt.
Business scenario: When used to query receipt information, it can display how many people have unread the message.
Is it required: no.
Default: 0.
This value indicates how many people have not read the message, and it is only applicable to the message that has been read; if the message is not sent by yourself, the value is 0.
isSelfOperated
isSelfOperated: boolean In a multi-device login scenario, after device A sets the message receipt as read, other online multi-devices use it to distinguish whether the message receipt set by itself has been read.
readTime
readTime: number Server-side timestamp when the message receipt was read.
- Default value: 0.
- Caution: For the sender, this value is the timestamp when all session members read the message. For the recipient, this value is the timestamp when the message receipt was set.
ZIMMessageReceiptsInfoQueriedResult
Callback interface for query receipt message read.
Details
Supported version: 2.5.0 and above.
Detailed description: Callback interface for querying receipt message information.
Business scenario: Developers can judge whether the sending is successful through [errorCode] in the callback.
Notification timing: When the developer calls the [queryMessageReceiptsInfo] interface, this callback will be triggered.
Relevant interface: through [queryMessageReceiptsInfo], whether the result of querying the receipt information is successful or not will be notified through this callback.
Properties
infos
errorMessageIDs
errorMessageIDs: string[] Query the wrong message ID of the message receipt information.
ZIMMessageReceiptsReadSentResult
Callback interface for setting the read receipt message.
Details
Supported version: 2.5.0 and above.
Detailed description: Set the callback interface for the read receipt message.
Business scenario: Developers can judge whether the setting is successful through [errorCode] in the callback.
Notification timing: When the developer calls the [sendMessageReceiptsRead] interface, this callback will be triggered.
Relevant interface: The success or failure of the message read result set by [sendMessageReceiptsRead] will be notified through this callback.
Properties
conversationID
conversationID: string Conversation ID.
conversationType
errorMessageIDs
errorMessageIDs: string[] Set the message ID corresponding to the message receipt failure.
ZIMMessageRepliedInfo
The reply message refers to the information of the source message.
Properties
state
sentTime
sentTime: number The send timestamp of the source message (in UTC).
senderUserID
senderUserID: string The sender user ID of the source message.
messageSeq
messageSeq: number The seq of the source message.
messageInfo
messageID
messageID: string The ID of the source message.
ZIMMessageRepliedListQueriedResult
The callback for querying the reply message list result.
Properties
rootRepliedInfo
messageList
nextFlag
nextFlag: number Query anchor, used for the next page to be passed to [ZIMMessageRepliedListQueryConfig] for querying.
ZIMMessageRepliedListQueryConfig
Configuration for querying reply message list.
Properties
nextFlag
nextFlag: number The flag of paginated query. When querying for the first time, set this field to 0. If the "nextFlag" field of the [queryMessageRepliedList] callback is not 0, it means that the query has not ended yet. You need to set it here to continue querying the next page.
count
count: number The number of queries per query. The upper limit is 100. Exceeding 100 will result in an error.
- Required: Required.
ZIMMessageRevokeConfig
Details
Revoke configurations related to messages.
Properties
revokeExtendedData
revokeExtendedData: string revoking additional messages.
- Required: Not required.
pushConfig
pushConfig: ZIMPushConfig Configures the offline push function, If Android or iOS platform is integrated, it is strongly recommended to configure this.
- Required: Not required.
ZIMMessageRevokedResult
Callback of the result of revoking message.
Details
After the developer revoking message, execute the callback of the result.
- When to call: This callback is triggered when a developer invokes the [revokeMessage] interface.
- Caution: Revoke message through [revokeMessage]. Success or failure to renew tokens will be notified through this callback.
- Available since: 2.5.0 or above.
Properties
message
ZIMMessageRootRepliedCountInfo
Information about the number of replies in the reply message tree.
Properties
conversationID
conversationID: string Conversation ID.
conversationType
messageID
messageID: string root message id.
count
count: number The number of replies for the reply message tree.
ZIMMessageRootRepliedInfo
Reply to the root message of the message tree.
Properties
state
sentTime
sentTime: number The send timestamp of the root message.
senderUserID
senderUserID: string The sender user ID of the root message.
repliedCount
repliedCount: number The number of replies for the reply message tree.
message
ZIMMessageSearchConfig
Message search configuration.
Details
Message search configuration.
Properties
nextMessage
nextMessage: ZIMMessage Paging fetch flag, which means fetching messages before or after nextMessage, with "before" or "after" determined by the order value. On the first search, nextMessage is null. On subsequent searches, nextMessage needs to pass in the last message in the message list queried last time.
count
count: number count It is recommended to keep the number of items less than 20 to reduce performance overhead.
- Required: Required.
order
order: ZIMMessageOrder When the "order" is "DESCENDING" during message search, it means querying messages with sending time earlier than nextMessage. If it's the first message query (i.e. nextMessage is null), then query from the last message stored locally forward. When "order" is "ASCENDING", it means querying messages with sending time later than nextMessage. If it's the first message query (i.e. nextMessage is null), then query from the first message stored locally backward. The default is "DESCENDING".
keywords
keywords: string[] Search keywords, up to 5 keywords are supported, otherwise an error will be reported. For example: passing in "1" and "2" will make the search results only show messages that contain both keywords "1" and "2".
messageTypes
messageTypes: ZIMMessageType[] Message types, can be used to specify message types. Support passing in multiple types.
subMessageTypes
subMessageTypes: number[] The subtypes of custom messages have a value range of [0,200]. Developers can use this range to search for specific custom types.
senderUserIDs
senderUserIDs: string[] The user ID of the message sender, supporting up to 5 IDs. For example, if "zego2023" is passed in, the search results will only display all the messages sent by the user "zego2023" in that conversation.
startTime
startTime: number The starting point of the search, in milliseconds, with a default value of 0. The format is UTC timestamp.
endTime
endTime: number The ending point of the search, which must be greater than the startTime, in milliseconds. The default value is 0 and the format is UTC timestamp.
ZIMMessageSendConfig
Details
Configurations related to sending messages.
Properties
pushConfig
pushConfig: ZIMPushConfig Configures the offline push function, If Android or iOS platform is integrated, it is strongly recommended to configure this.
- Required: Not mandatory.
priority
hasReceipt
hasReceipt: boolean - Required: not required.
- Default value: false.
isNotifyMentionedUsers
isNotifyMentionedUsers: boolean - Required: not required.
- Default value: true.
isRetrySend
isRetrySend: boolean Whether to resend the failed message.
- Required: No.
disableUnreadMessageCount
disableUnreadMessageCount: boolean - Required: No.
- Default value: false.
ZIMMessageSendNotification
The notification callback when the message is sent, you can get the relevant information before the message object is sent through this notification
Details
Detailed description: Through this notification, developers can obtain relevant information before the message object is sent, such as localMessageID, etc.
Business scenario: When developers need to record and cache relevant information before sending a message, they can obtain it by listening to the notification.
If no monitoring is required, it can be passed null.
Methods
onMediaUploadingProgress
onMediaUploadingProgress(message: ZIMMediaMessage, currentFileSize: number, totalFileSize: number): voidParameters
| Name | Type | Description |
|---|---|---|
| message | ZIMMediaMessage | The message object for the current file upload. |
| currentFileSize | number | The current progress, that is, the real-time size of the current file upload. |
| totalFileSize | number | Total progress, which is the total size of the current file. |
Details
Supported versions: 2.1.0 and above.
Detail description: The progress callback for sending media messages.
Business scenario: The developer can obtain the sending progress of the media message through this callback.
Notification timing: When the developer calls the [sendMediaMessage] interface, the callback will be triggered, and will be triggered multiple times during the sending process.
Related interface: Through [sendMediaMessage], the sending progress will be notified through this callback.
onMessageAttached
onMessageAttached(message: ZIMMessage): voidParameters
| Name | Type | Description |
|---|---|---|
| message | ZIMMessage | The currently sent message object. |
Details
Supported version: 2.4.0 and above.
The incoming message object is given a localMessgeID and returned.
Service scenario: Before a message is successfully sent, it can correspond to its localMessageID to implement loading before sending.
Notification time: Triggered after the message is sent and before the message is successfully sent.
onMultipleMediaUploadingProgress
onMultipleMediaUploadingProgress(message: ZIMMultipleMessage, currentFileSize: number, totalFileSize: number, messageInfoIndex: number, currentIndexFileSize: number, totalIndexFileSize: number): voidParameters
| Name | Type | Description |
|---|---|---|
| message | ZIMMultipleMessage | The currently sent message object. |
| currentFileSize | number | The current total uploaded size. |
| totalFileSize | number | The total size of files to be uploaded. |
| messageInfoIndex | number | The index of the array where the currently uploaded file is located. |
| currentIndexFileSize | number | The uploaded size of the currently uploaded file. |
| totalIndexFileSize | number | The total size of the files currently being uploaded. |
Details
Supported versions: 2.19.0 and above.
Detail description: The progress callback for sending multiple messages.
Business scenario: Developers can use this callback to obtain the upload progress of the media files in the multiple message.
Notification timing: When the developer calls the [sendMessage] interface, the callback will be triggered, and will be triggered multiple times during the sending process.
Related interface: Through [sendMessage], the sending progress will be notified through this callback.
ZIMMessageSentResult
Callback of the result of sending the message.
- Related APIs: This callback is triggered when the developer calls the [sendPeerMessage] and [sendRoomMessage] interfaces.
- Available since: 1.1.0 or above.
Properties
message
message: ZIMMessage The sent message object, from which parameters such as messageID can be obtained.
ZIMMessageSentStatusChangeInfo
Notice of Room Message Status Change.
Details
Notice of Room Message Status Change.
Properties
message
status
reason
reason: string This field stores the reason why a message was rejected by ZEGOCLOUD In-app Chat due to interception by the server-side callback on message not sent yer. If you have enabled the ZEGOCLOUD In-app Chat content moderation service and require this field to capture failure reasons caused by failed content moderation, contact ZEGOCLOUD Technical Support for configuration.
ZIMMessagesGlobalSearchedResult
Return of local message search results.
Details
Detailed description: Return of search results for local messages.
- Use cases: After performing a local message search operation, the success or failure can be determined through this callback.
Related API: [searchLocalMessages], search for local messages.
Properties
messageList
nextMessage
nextMessage: ZIMMessage Pagination retrieval flag, message anchor for searching the next page.
ZIMMessagesSearchedResult
Return of local message search results.
Details
Detailed description: Return of search results for local messages.
- Use cases: After performing a local message search operation, the success or failure can be determined through this callback.
Related API: [searchLocalMessages], search for local messages.
Properties
messageList
conversationID
conversationID: string ConversationID.
conversationType
nextMessage
nextMessage: ZIMMessage Pagination retrieval flag, message anchor for searching the next page.
ZIMMultipleMessage
Multiple message object.
Details
Detailed description: Identifies a multiple message.
Only supports the multiple of text, image, file, audio, video, and custom messages, and the number of array does not exceed 20.
Properties
messageInfoList
messageInfoList: ZIMMessageLiteInfo[] It can contain text, image, file, audio, video, and custom messages. The array length does not exceed 20.
- Use cases: It can be used to send text and image multiple messages.
- Recommended value: The total number of items does not exceed 20, the maximum number of image is 10, and the maximum number of file, audio, video and custom message is 1 each. The size and format restrictions of image, file, audio, and video are the same as those of the corresponding rich media messages.
type
messageID
messageID: string The unique ID that identifies this message.
- Use cases: Can be used to index other messages.
- Caution: When the developer actively creates a message, there is no need to modify this parameter. This parameter only has a value during callback.
timestamp
timestamp: number Identifies the sending time of a message
- Use cases: Used to present the sending time of a message, and can be used for message sorting.
- Caution: This is a standard UNIX timestamp, in milliseconds.
senderUserID
senderUserID: string Displays the userID of the sender of this message.
conversationID
conversationID: string Conversation ID. Ids of the same conversation type are unique.
direction
sentStatus
conversationType
conversationType: ZIMConversationType The type of conversation to which the message belongs.
conversationSeq
conversationSeq: number Indicates the sequence number of the message in the conversation.
orderKey
orderKey: number The larger the orderKey, the newer the message, and can be used for ordering messages.
localMessageID
localMessageID: string SDK locally generated MessageID, developers do not need to pay attention to.
isUserInserted
isUserInserted: boolean Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].
Default: false.
receiptStatus
receiptStatus: ZIMMessageReceiptStatus Describe the receipt status of the message
Business scenario: used to determine the status of the current message in the receipt message
extendedData
extendedData: string message extension field
- Use cases: You can add extended fields to the message and send it to the peer
- Required: no
- Caution: the length is 1k, you can contact technical support for configuration
- Available since: 2.6.0 or higher
localExtendedData
localExtendedData: string The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
isBroadcastMessage
isBroadcastMessage: boolean Whether the message is pushed by all employees.
- Required: Internal assignment.
isMentionAll
isMentionAll: boolean Whether to mention everyone. It can be presented as "@Everyone".
- Use cases: For example, it can be used in groups or rooms.
- Required: No.
- Default value: false.
- Recommended value: Set to true if you need to mention everyone.
- Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
mentionedUserIDs
mentionedUserIDs: string[] Whether to mention everyone. It can be presented as "@User".
- Use cases: For example, it can be used in sending messages.
- Required: No.
- Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
messageSeq
messageSeq: number Indicates the sequence number of the message in the conversation.
rootRepliedCount
rootRepliedCount: number The number of reply messages corresponding to the root message of the reply message tree.
repliedInfo
repliedInfo: ZIMMessageRepliedInfo Information about the source message referenced by the reply message.
editorUserID
editorUserID: string The latest editor's userID for this message.
editedTime
editedTime: number The latest editing timestamp for this message.
isGroupTargetedMessage
isGroupTargetedMessage: boolean Identify if this message is group targeted message.
pinnedUserID
pinnedUserID: string The last user who pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
pinnedTime
pinnedTime: number The last timestamp when pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
ZIMMultipleMessageLiteInfo
Multiple message lite info object.
Details
Identifies the basic parameters of a multiple message.
Properties
messageInfoList
messageInfoList: ZIMMessageLiteInfo[] Detail description: A list of elements that compose the message.
type
ZIMOfflinePushPrivateMessageTemplate
Offline push private message template.
Details
According to [OPUSH DMS template check ability to access instructions] (https://open.oppomobile.com/documentation/page/info?id=12391), OPPO in new message classification on the basis of the new push DMS templates, After you have configured the private message template in the OPPO console, if you need to apply the corresponding template during push notifications, you can assign a value to the privateMessageTemplate in ZIMPushConfig.
Properties
templateID
templateID: string The ID of the private message template pushed by OPPO must be carried when sending the corresponding private message template. If the category of OPPO in the resourceID is set to be classified as Content and Marketing, this field is invalid. Details please see [OPUSH DMS template check ability to access instructions] (https://open.oppomobile.com/documentation/page/info?id=12391
titleParameters
titleParameters: string json string, OPPO push title template filling parameters. For example, the private message template ID title template is: Welcome to , Welcome you. The content of this parameter is :" {"city":" Beijing}".
contentParameters
contentParameters: string json string, OPPO push content template filling parameter. Example: The content template corresponding to the private message template ID is: Welcome to . The content of this parameter is :" {"userName":" Tom ", "city":" Shenzhen City "}.
ZIMPinnedMessageListQueriedResult
The developer uses this callback to get a list of queried pinned messages, which can be used to display pinned messages.
- Related APIs: The [queryPinnedMessageList] interface is used to query the list of pinned messages. The queried message list is notified through this callback.
Properties
messageList
ZIMPushConfig
Description
push configuration.Details
Details: Configuration before sending offline push.
Properties
title
title: string Used to set the push title.
- Required: Not required.
content
content: string Used to set offline push content.
- Required: Not required.
payload
payload: string This parameter is used to set the pass-through field of offline push.
- Required: Not required.
resourcesID
resourcesID: string A string defined by you, no more than 32 characters in length, used to map advanced configurations for offline push from multiple manufacturers, abstracting the push configurations of various manufacturers into a single push strategy that you define yourself. For detailed introduction and configuration steps, please refer to ResourcesID introduction.
- Required: Not required.
enableBadge
enableBadge: boolean Push whether to carry corner information switch.
badgeIncrement
badgeIncrement: number The incremental index number carried by the push.
voIPConfig
voIPConfig: ZIMVoIPConfig If you use Flutter, RN ZPNs, offline push receiving device has iOS and uses VoIP push type, you can customize some VoIP options with this parameter.
privateMessageTemplate
privateMessageTemplate: ZIMOfflinePushPrivateMessageTemplate If you use OPPO push notifications, you can apply the OPPO Private message template through this structure; otherwise, you can ignore it and it will be left blank by default.
ZIMRevokeMessage
Base class for revoke message objects.
Details
Detail description: Identifies a revoke message.
This base class is the basis of all revoke messages and contains the properties required by revoke messages.
Properties
revokeType
revokeStatus
revokeTimestamp
revokeTimestamp: number Detail description: revoke timestamp.
operatedUserID
operatedUserID: string Detail description: operated user ID.
revokeExtendedData
revokeExtendedData: string Detail description: revoke extended data.
originalMessageType
originalTextMessageContent
originalTextMessageContent: string original text message content
type
messageID
messageID: string The unique ID that identifies this message.
- Use cases: Can be used to index other messages.
- Caution: When the developer actively creates a message, there is no need to modify this parameter. This parameter only has a value during callback.
timestamp
timestamp: number Identifies the sending time of a message
- Use cases: Used to present the sending time of a message, and can be used for message sorting.
- Caution: This is a standard UNIX timestamp, in milliseconds.
senderUserID
senderUserID: string Displays the userID of the sender of this message.
conversationID
conversationID: string Conversation ID. Ids of the same conversation type are unique.
direction
sentStatus
conversationType
conversationType: ZIMConversationType The type of conversation to which the message belongs.
conversationSeq
conversationSeq: number Indicates the sequence number of the message in the conversation.
orderKey
orderKey: number The larger the orderKey, the newer the message, and can be used for ordering messages.
localMessageID
localMessageID: string SDK locally generated MessageID, developers do not need to pay attention to.
isUserInserted
isUserInserted: boolean Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].
Default: false.
receiptStatus
receiptStatus: ZIMMessageReceiptStatus Describe the receipt status of the message
Business scenario: used to determine the status of the current message in the receipt message
extendedData
extendedData: string message extension field
- Use cases: You can add extended fields to the message and send it to the peer
- Required: no
- Caution: the length is 1k, you can contact technical support for configuration
- Available since: 2.6.0 or higher
localExtendedData
localExtendedData: string The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
isBroadcastMessage
isBroadcastMessage: boolean Whether the message is pushed by all employees.
- Required: Internal assignment.
isMentionAll
isMentionAll: boolean Whether to mention everyone. It can be presented as "@Everyone".
- Use cases: For example, it can be used in groups or rooms.
- Required: No.
- Default value: false.
- Recommended value: Set to true if you need to mention everyone.
- Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
mentionedUserIDs
mentionedUserIDs: string[] Whether to mention everyone. It can be presented as "@User".
- Use cases: For example, it can be used in sending messages.
- Required: No.
- Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
messageSeq
messageSeq: number Indicates the sequence number of the message in the conversation.
rootRepliedCount
rootRepliedCount: number The number of reply messages corresponding to the root message of the reply message tree.
repliedInfo
repliedInfo: ZIMMessageRepliedInfo Information about the source message referenced by the reply message.
editorUserID
editorUserID: string The latest editor's userID for this message.
editedTime
editedTime: number The latest editing timestamp for this message.
isGroupTargetedMessage
isGroupTargetedMessage: boolean Identify if this message is group targeted message.
pinnedUserID
pinnedUserID: string The last user who pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
pinnedTime
pinnedTime: number The last timestamp when pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
ZIMRevokeMessageLiteInfo
Base class for revoke message lite info objects.
Properties
type
ZIMRoomAdvancedConfig
Room advanced config.
Details
Room‘s advanced config.
Properties
roomAttributes
roomAttributes: Record<string, string> Room attributes of a room.
roomDestroyDelayTime
roomDestroyDelayTime: number Room destruction time delayed, the unit is seconds. The maximum room destroy delay time is 3 hours.
- Use cases: If the number of rooms is 0, set the room time to ensure that the room exists during this period.
- Required: Not mandatory.
ZIMRoomAttributesBatchOperatedResult
The return of the result of the room attribute combination operation.
Properties
roomID
roomID: string Room ID.
ZIMRoomAttributesBatchOperationConfig
The behavior attribute set by the room attribute.
Details
The behavior attribute set by the room attribute.
Properties
isDeleteAfterOwnerLeft
isDeleteAfterOwnerLeft: boolean Room attributes are automatically deleted after the owner leaves the room.
- Required: Not required.
isForce
isForce: boolean Whether the operation is mandatory, that is, the property of the room whose owner is another user can be modified.
- Required: Not required.
isUpdateOwner
isUpdateOwner: boolean Whether to update the owner of the room attribute involved.
- Required: Not required.
ZIMRoomAttributesDeleteConfig
The behavior attribute set by the room attribute.
Details
The behavior attribute set by the room attribute.
Properties
isForce
isForce: boolean Whether the operation is mandatory, that is, the property of the room whose owner is another user can be deleted.
- Required: Not required.
ZIMRoomAttributesOperatedResult
The return of the operation result of the room attribute.
Properties
errorKeys
errorKeys: string[] Keys for failed operation.
roomID
roomID: string Room ID.
ZIMRoomAttributesQueriedResult
Return of room attribute query results.
Properties
roomAttributes
roomAttributes: Record<string, string> Room attributes in the room.
roomID
roomID: string Room ID.
ZIMRoomAttributesSetConfig
The behavior attribute set by the room attribute.
Details
The behavior attribute set by the room attribute.
Properties
isDeleteAfterOwnerLeft
isDeleteAfterOwnerLeft: boolean Room attributes are automatically deleted after the owner leaves the room.
- Required: Not required.
isForce
isForce: boolean Whether the operation is mandatory, that is, the property of the room whose owner is another user can be modified.
- Required: Not required.
isUpdateOwner
isUpdateOwner: boolean Whether to update the owner of the room attribute involved.
- Required: Not required.
ZIMRoomAttributesUpdateInfo
Notice of Room Attribute Change.
Details
Notice of Room Attribute Change.
Properties
action
action: ZIMRoomAttributesUpdateAction Behavioral information of room attribute change notification.
roomAttributes
roomAttributes: Record<string, string> Room attributes.
ZIMRoomCreatedResult
Create the result object of the room.
Details
Identify the result of creating a room.
Properties
roomInfo
ZIMRoomEnteredResult
Enter the result object of the room.
Details
Identify the result of enter a room.
Properties
roomInfo
ZIMRoomFullInfo
The room details object.
Details
Identifies the basic parameters of a message.
- Caution: Identifies the detailed information of a room.
Properties
baseInfo
ZIMRoomInfo
Room information object.
Details
Identifies a unique room.
Properties
roomID
roomID: string Room ID. a string with a maximum length of 128 bytes. It is customized by the developer and supports only digits, English characters, , and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', ''.
roomName
roomName: string Room name, It is customized by the developer .a string with a maximum length of 64 bytes or less
ZIMRoomJoinedResult
Joined the result object of the room.
Details
Identify the result of join a room.
Properties
roomInfo
ZIMRoomLeftResult
Callback of the result of leaving the room.
Properties
roomID
roomID: string Room ID.
ZIMRoomMemberAttributesInfo
Room user attribute information.
Details
Detail description: A class describing room user attributes, including UserID and its corresponding attributes.
Properties
userID
userID: string Detail description: User ID.
attributes
attributes: Record<string, string> Detailed description: room user attributes.
ZIMRoomMemberAttributesListQueriedResult
Returns the query result of the user attribute list in the room.
Details
Supported version: 2.4.0.
Detail description: Returns the result of paging query of all user attribute lists in the room.
Business scenario: After querying room user attributes, the success or failure and query results can be known through this callback.
Notification timing: The result will be returned after the room user attribute query is completed.
Related interface: [queryRoomMemberAttributesList], query room user attributes.
Properties
roomID
roomID: string Room ID.
infos
nextFlag
nextFlag: string The anchor of the next paging query. If it is empty, it means that the query has been completed.
ZIMRoomMemberAttributesOperatedInfo
Room user attribute operation information.
Details
Detail description: room user attribute operation information, including attributes of successful operation and keys of failure.
Properties
attributesInfo
attributesInfo: ZIMRoomMemberAttributesInfo Detailed description: room user attribute information.
errorKeys
errorKeys: string[] Detail description: The key of the room user attribute operation failure.
ZIMRoomMemberAttributesQueryConfig
Room user attribute query configuration.
Details
Detailed description: room user attribute query configuration.
Properties
nextFlag
nextFlag: string Detail description: Query anchor for room user properties.
Required or not: not required, it is empty by default for the first time, which means to start the query from the beginning.
count
count: number - Required: Required.
ZIMRoomMemberAttributesSetConfig
Room user property settings configuration.
Details
Detail description: room user attribute setting configuration, including configurable whether to retain user attributes after the user leaves, etc.
Business scenarios: When setting room user attributes, developers can choose to use them according to their actual application scenarios.
Properties
isDeleteAfterOwnerLeft
isDeleteAfterOwnerLeft: boolean - Required: not required.
Default: true.
ZIMRoomMemberAttributesUpdateInfo
Room user attribute update information.
Details
Detailed description: Room user attribute update information.
Properties
attributesInfo
attributesInfo: ZIMRoomMemberAttributesInfo Detailed description: room user attributes.
ZIMRoomMemberInfo
Room user information.
Details
Detail description: A class describing room user.
Properties
userID
userID: string User ID, a string with a maximum length of 32 bytes or less. It is customized by the developer. Only support numbers, English characters and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.
userName
userName: string User name, defined by you. For version 2.0.0 and onwards, the string has a maximum length of 256 bytes.
- Required: Not required.
- Privacy reminder: Please do not provide sensitive personal information, including but not limited to mobile phone numbers, ID card numbers, passport numbers, and real names.
userAvatarUrl
userAvatarUrl: string The user avatar, which is custom generated by the developer, is not restricted by special characters and has a maximum length of 500 bytes.
- Required: Not required.
- Privacy reminder: Please do not provide sensitive personal information, including but not limited to mobile phone numbers, ID card numbers, passport numbers, and real names.
- Available since: 2.13.0 and above.
userExtendedData
userExtendedData: string Extended field information of the user.
- Caution: This property has a value only for room users.
ZIMRoomMemberQueriedResult
Callback of the result of querying the room members list.
Details
Callback of the result of querying the room members list.
Properties
memberList
nextFlag
nextFlag: string The flag of the paging query. For the first query, set this field to an empty string. If the "nextFlag" field of the callback is not an empty string, it needs to be set here to continue the query on the next page.
roomID
roomID: string Room ID.
ZIMRoomMemberQueryConfig
Configuration for querying room member.
Details
When querying member, you need to configure this object.
Properties
nextFlag
nextFlag: string The flag of the paging query. For the first query, set this field to an empty string. If the "nextFlag" field of the callback is not an empty string, it needs to be set here to continue the query on the next page.
- Required: Not required.
count
count: number How many messages are retrieved in one query.
- Caution: To obtain messages in pages to reduce overhead, it is recommended to obtain within 100 messages at a time. If the value is 0, the SDK will query 100 room member by default.
- Required: Required.
ZIMRoomMembersAttributesOperatedResult
The return of the operation result of the room attribute.
Details
Supported version: 2.4.0.
Detail description: Returns the result of the room user attribute operation.
Business scenario: After the custom attribute operation is performed, the success or failure can be known through this callback.
Notification timing: The result is returned after the room user attribute operation is completed.
Related interface: [setRoomMembersAttributes], add or modify room user attributes.
Properties
roomID
roomID: string Room ID.
infos
infos: ZIMRoomMemberAttributesOperatedInfo[] The attributes information of the room member after the operation.
errorUserList
errorUserList: string[] List of UserIDs with errors.
ZIMRoomMembersAttributesQueriedResult
Returns the results of batch query of room user attributes.
Details
Supported version: 2.4.0.
Detailed description: According to the UserID list, batch query results of room user attributes are returned.
Business scenario: After querying room user attributes, the success or failure and query results can be known through this callback.
Notification timing: The result will be returned after the room user attribute query is completed.
Related interface: [queryRoomMembersAttributes], query room user attributes.
Properties
roomID
roomID: string Room ID.
infos
ZIMRoomMembersQueriedResult
Callback for the result of querying the specified member of the room.
Details
After querying room user information, the query result is returned through this callback.
- Use cases: The logic after querying room user information can be done in this callback.
- When to call /Trigger: Triggered after querying room user information.
- Available since: 2.8.0 and above.
Properties
memberList
errorUserList
roomID
roomID: string Room ID.
ZIMRoomOnlineMemberCountQueriedResult
Callback of the result of querying the online members count in the room.
Details
Callback of the result of querying the online members count in the room.
- Related APIs: You can check the online number of people in the room through [queryRoomOnlineMemberCount].
- Available since: 1.1.0 or above.
Properties
count
count: number The number of online members of the room.
roomID
roomID: string Room ID.
ZIMRoomOperatedInfo
Room operation information.
Details
Detailed description: Room operation information.
Properties
userID
userID: string Detail description: UserID of the operator.
ZIMRoomSwitchedResult
Callback of the result of switched rooms.
Details
Callback of the result of switched rooms.
Properties
roomInfo
ZIMSelfUserInfo
Carry user information and rules of the current user.
Details
Carry user information and rules of the current user.
Properties
userRule
userRule: ZIMUserRule Rules for the current user, setting information.
userFullInfo
ZIMSelfUserInfoQueriedResult
Callback result of querying personal user information and rules.
Properties
selfUserInfo
ZIMSelfUserRule
User's own rule class.
Properties
offlinePushRule
ZIMSendingMessageCancelConfig
Details
(Empty Class) Configurations related to cancel sending messages.
ZIMSubscribedUserStatusListQueriedResult
QuerySubscribedUserStatusList query for the current user subscription list operation results callback.
Details
QuerySubscribedUserStatusList query for the current user subscription list operation results callback.
Properties
userStatusSubscriptionList
userStatusSubscriptionList: ZIMUserStatusSubscription[] Subscription information for users in the subscription list.
ZIMSubscribedUserStatusQueryConfig
QuerySubscribedUserStatusList query subscription list interface configuration items.
Details
QuerySubscribedUserStatusList query subscription list interface configuration items.
Properties
userIDs
userIDs: string[] Pass this value if you need to check whether the specified user is in the subscription list of the current user, otherwise all users in the subscription list will be returned.
ZIMTextMessage
Normal text message object.
Details
Identifies the basic parameters of a message.
- Caution: If the Type parameter of the base class is Text during callback, you can force the base class message object to be of this type.
Properties
message
message: string The content of the text message.
type
messageID
messageID: string The unique ID that identifies this message.
- Use cases: Can be used to index other messages.
- Caution: When the developer actively creates a message, there is no need to modify this parameter. This parameter only has a value during callback.
timestamp
timestamp: number Identifies the sending time of a message
- Use cases: Used to present the sending time of a message, and can be used for message sorting.
- Caution: This is a standard UNIX timestamp, in milliseconds.
senderUserID
senderUserID: string Displays the userID of the sender of this message.
conversationID
conversationID: string Conversation ID. Ids of the same conversation type are unique.
direction
sentStatus
conversationType
conversationType: ZIMConversationType The type of conversation to which the message belongs.
conversationSeq
conversationSeq: number Indicates the sequence number of the message in the conversation.
orderKey
orderKey: number The larger the orderKey, the newer the message, and can be used for ordering messages.
localMessageID
localMessageID: string SDK locally generated MessageID, developers do not need to pay attention to.
isUserInserted
isUserInserted: boolean Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].
Default: false.
receiptStatus
receiptStatus: ZIMMessageReceiptStatus Describe the receipt status of the message
Business scenario: used to determine the status of the current message in the receipt message
extendedData
extendedData: string message extension field
- Use cases: You can add extended fields to the message and send it to the peer
- Required: no
- Caution: the length is 1k, you can contact technical support for configuration
- Available since: 2.6.0 or higher
localExtendedData
localExtendedData: string The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
isBroadcastMessage
isBroadcastMessage: boolean Whether the message is pushed by all employees.
- Required: Internal assignment.
isMentionAll
isMentionAll: boolean Whether to mention everyone. It can be presented as "@Everyone".
- Use cases: For example, it can be used in groups or rooms.
- Required: No.
- Default value: false.
- Recommended value: Set to true if you need to mention everyone.
- Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
mentionedUserIDs
mentionedUserIDs: string[] Whether to mention everyone. It can be presented as "@User".
- Use cases: For example, it can be used in sending messages.
- Required: No.
- Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
messageSeq
messageSeq: number Indicates the sequence number of the message in the conversation.
rootRepliedCount
rootRepliedCount: number The number of reply messages corresponding to the root message of the reply message tree.
repliedInfo
repliedInfo: ZIMMessageRepliedInfo Information about the source message referenced by the reply message.
editorUserID
editorUserID: string The latest editor's userID for this message.
editedTime
editedTime: number The latest editing timestamp for this message.
isGroupTargetedMessage
isGroupTargetedMessage: boolean Identify if this message is group targeted message.
pinnedUserID
pinnedUserID: string The last user who pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
pinnedTime
pinnedTime: number The last timestamp when pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
ZIMTextMessageLiteInfo
Normal text message lite info object.
Details
Identifies the basic parameters of a message lite info.
- Caution: If the Type parameter of the base class is Text during callback, you can force the base class message lite info object to be of this type.
Properties
message
message: string The content of the text message.
type
ZIMTipsMessage
Tips message object.
Details
Identifies a tips info message.
- Caution: If the Type parameter of the base class is Tips during callback, you can force the base class message object to be of this type.
Properties
event
operatedUser
operatedUser: ZIMUserInfo The initiator of the action corresponding to the tips message.
targetUserList
targetUserList: ZIMUserInfo[] The target user list for the operation corresponding to the tips message.
changeInfo
changeInfo: ZIMTipsMessageChangeInfo Additional information for the operation corresponding to the tips message.
type
messageID
messageID: string The unique ID that identifies this message.
- Use cases: Can be used to index other messages.
- Caution: When the developer actively creates a message, there is no need to modify this parameter. This parameter only has a value during callback.
timestamp
timestamp: number Identifies the sending time of a message
- Use cases: Used to present the sending time of a message, and can be used for message sorting.
- Caution: This is a standard UNIX timestamp, in milliseconds.
senderUserID
senderUserID: string Displays the userID of the sender of this message.
conversationID
conversationID: string Conversation ID. Ids of the same conversation type are unique.
direction
sentStatus
conversationType
conversationType: ZIMConversationType The type of conversation to which the message belongs.
conversationSeq
conversationSeq: number Indicates the sequence number of the message in the conversation.
orderKey
orderKey: number The larger the orderKey, the newer the message, and can be used for ordering messages.
localMessageID
localMessageID: string SDK locally generated MessageID, developers do not need to pay attention to.
isUserInserted
isUserInserted: boolean Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].
Default: false.
receiptStatus
receiptStatus: ZIMMessageReceiptStatus Describe the receipt status of the message
Business scenario: used to determine the status of the current message in the receipt message
extendedData
extendedData: string message extension field
- Use cases: You can add extended fields to the message and send it to the peer
- Required: no
- Caution: the length is 1k, you can contact technical support for configuration
- Available since: 2.6.0 or higher
localExtendedData
localExtendedData: string The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
isBroadcastMessage
isBroadcastMessage: boolean Whether the message is pushed by all employees.
- Required: Internal assignment.
isMentionAll
isMentionAll: boolean Whether to mention everyone. It can be presented as "@Everyone".
- Use cases: For example, it can be used in groups or rooms.
- Required: No.
- Default value: false.
- Recommended value: Set to true if you need to mention everyone.
- Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
mentionedUserIDs
mentionedUserIDs: string[] Whether to mention everyone. It can be presented as "@User".
- Use cases: For example, it can be used in sending messages.
- Required: No.
- Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
messageSeq
messageSeq: number Indicates the sequence number of the message in the conversation.
rootRepliedCount
rootRepliedCount: number The number of reply messages corresponding to the root message of the reply message tree.
repliedInfo
repliedInfo: ZIMMessageRepliedInfo Information about the source message referenced by the reply message.
editorUserID
editorUserID: string The latest editor's userID for this message.
editedTime
editedTime: number The latest editing timestamp for this message.
isGroupTargetedMessage
isGroupTargetedMessage: boolean Identify if this message is group targeted message.
pinnedUserID
pinnedUserID: string The last user who pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
pinnedTime
pinnedTime: number The last timestamp when pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
ZIMTipsMessageChangeInfo
Tips message additional information.
Details
Tips message additional information.
Properties
type
ZIMTipsMessageGroupChangeInfo
Tips Additional information about change events related to the message group.
Details
Tips Additional information about change events related to the message group.
Properties
groupDataFlag
groupDataFlag: number If there are multiple changes in the group name, group avatar, and group announcement, you need to know which ones have changed based on the value of this field. Among them, 0b0001 is the group name, 0b0010 is the group notice, and 0b0100 is the group avatar.
groupName
groupName: string If the group name is changed, the changed value will be displayed here.
groupNotice
groupNotice: string If the group notice is changed, the changed value will be displayed here.
groupAvatarUrl
groupAvatarUrl: string If the group avatar url is changed, the changed value will be displayed here.
groupMutedInfo
groupMutedInfo: ZIMGroupMuteInfo If the group mute info is changed, the changed value will be displayed here.
type
ZIMTipsMessageGroupMemberChangeInfo
Tips Additional information about change events related to the message group member.
Details
Tips Additional information about change events related to the message group member.
Properties
memberRole
memberRole: number If a group member's role changes, the changed role will be displayed here.
muteExpiredTime
muteExpiredTime: number If the group member's muting expired time changes, the new muting expired time will be displayed here.
groupNewOwner
groupNewOwner: ZIMGroupMemberSimpleInfo Displays information about the new group owner when the group owner leaves the group or is kicked from the group by the server.
- Use cases: Used for UI display when the group owner leaves the group or is kicked from the group by the server.
type
ZIMTipsMessagePinStatusChangeInfo
Tips Additional information about change events related to the message pinned or unpined.
Details
Tips Additional information about change events related to the message pinned or unpined.
Properties
isPinned
isPinned: boolean Describes whether the current operation is a pin operation or an unpin operation.
type
ZIMTokenRenewedResult
Callback of the result of renewing the token.
Details
After the developer updates the Token, execute the callback of the result.
- When to call: This callback is triggered when a developer invokes the [renewToken] interface.
- Caution: Renew tokens through [renewToken]. Success or failure to renew tokens will be notified through this callback.
- Available since: 2.0.0 or above.
Properties
token
token: string The renewed token.
ZIMUserAvatarUrlUpdatedResult
Callback to update userAvatarUrl.
Properties
userAvatarUrl
userAvatarUrl: string updated user avatar URL.
ZIMUserCustomStatusUpdatedResult
The asynchronous results for custom status update.
Details
The asynchronous results for custom status update.
Properties
customStatus
customStatus: string custom status.
ZIMUserExtendedDataUpdatedResult
Update the userExtendedData callback.
Details
Supported version: 2.2.0 and above.
Detailed description: Callback after developer queries user information.
Notification timing: This callback is triggered when a developer invokes the [queryUsersInfo] interface.
Related interface: Run the queryUsersInfo command to query information.
Properties
extendedData
extendedData: string updated user extended data.
ZIMUserFullInfo
User full information object.
Details
Identifies a unique user.
- Caution: that the userID must be unique under the same appID, otherwise mutual kicks out will occur. It is strongly recommended that userID corresponds to the user ID of the business APP, that is, a userID and a real user are fixed and unique, and should not be passed to the SDK in a random userID. Because the unique and fixed userID allows ZEGO technicians to quickly locate online problems.
Properties
baseInfo
userAvatarUrl
userAvatarUrl: string - Required: not required.
Use restrictions: The value is a maximum of 500 bytes and contains no special characters.
extendedData
extendedData: string - Required: not required.
Privacy Protection Statement: Do not pass in sensitive information involving personal privacy, including but not limited to mobile phone numbers, ID numbers, passport numbers, real names, etc.
ZIMUserInfo
User information object.
Details
Identifies a unique user.
- Caution: that the userID must be unique under the same appID, otherwise mutual kicks out will occur. It is strongly recommended that userID corresponds to the user ID of the business APP, that is, a userID and a real user are fixed and unique, and should not be passed to the SDK in a random userID. Because the unique and fixed userID allows ZEGO technicians to quickly locate online problems.
Properties
userID
userID: string User ID, a string with a maximum length of 32 bytes or less. It is customized by the developer. Only support numbers, English characters and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.
userName
userName: string User name, defined by you. For version 2.0.0 and onwards, the string has a maximum length of 256 bytes.
- Required: Not required.
- Privacy reminder: Please do not provide sensitive personal information, including but not limited to mobile phone numbers, ID card numbers, passport numbers, and real names.
userAvatarUrl
userAvatarUrl: string The user avatar, which is custom generated by the developer, is not restricted by special characters and has a maximum length of 500 bytes.
- Required: Not required.
- Privacy reminder: Please do not provide sensitive personal information, including but not limited to mobile phone numbers, ID card numbers, passport numbers, and real names.
- Available since: 2.13.0 and above.
userExtendedData
userExtendedData: string Extended field information of the user.
- Caution: This property has a value only for room users.
ZIMUserNameUpdatedResult
Update the userName callback.
Details
Supported version: 2.2.0 and above.
Detailed description: Callback after developer queries user information.
Notification timing: This callback is triggered when a developer invokes the [queryUsersInfo] interface.
Related interface: Run the queryUsersInfo command to query information.
Properties
userName
userName: string updated user name.
ZIMUserOfflinePushRule
Data class of the user's offline push rule.
Details
Data class of the user's offline push rule.
Properties
onlinePlatforms
onlinePlatforms: number[] With the data in the class member variables notToReceiveOfflinePushPlatforms collocation is used. OnlinePlatforms specified platform, online notToReceiveOfflinePushPlatforms specified platform will not receive offline push.
- Value range: Please enter the enumeration value corresponding to the platform in the ZIMPlatformType enumeration.
notToReceiveOfflinePushPlatforms
notToReceiveOfflinePushPlatforms: number[] With the data in the class member variables onlinePlatforms collocation is used. OnlinePlatforms specified platform, online notToReceiveOfflinePushPlatforms specified platform will not receive offline push.
- Value range: Please enter the enumeration value corresponding to the platform in the ZIMPlatformType enumeration.
ZIMUserOfflinePushRuleUpdatedResult
Update the result callback of the user offline push rule.
Properties
offlinePushRule
ZIMUserStatus
User status data
Details
Contains data about the user's online status.
Properties
userID
userID: string A unique identifier for a single user.
onlineStatus
onlineStatus: ZIMUserOnlineStatus Enumeration that represents the current online status of the user.
onlinePlatforms
onlinePlatforms: List\<Number> The list of online platforms of the current user can be used to display the online platforms of the user, such as iPhone online and PC online. Please refer to ZIMPlatform for the meanings of the numbers.
lastUpdateTime
lastUpdateTime: number Timestamp when user onlineStatus or customStatus was last changed, whichever is the greater.
lastOnlineStatusUpdateTime
lastOnlineStatusUpdateTime: number The timestamp of the last change of the user onlineStatus, which can be used to show that the user was offline/logged in before xxx minutes.
lastCustomStatusUpdateTime
lastCustomStatusUpdateTime: number The timestamp when User customStatus was last changed, which can be used to show when the custom status was last changed.
customStatus
customStatus: string User-defined status. The default maximum value is 64 bytes. The default expiration time is 1 day. At login, if the field is an empty string (which is the default), the current user's custom state is not modified.
ZIMUserStatusSubscribeConfig
subscribeUsersStatus Configuration items of the online status interface for subscribing users in batches.
Details
subscribeUsersStatus Configuration items of the online status interface for subscribing users in batches.
Properties
subscriptionDuration
subscriptionDuration: number Used to set the duration of this subscription.
- Use cases: This field is required.
- Value range: ：1 to 43200 (30 days), and the unit is minute.
- Caution: After the subscription is expired, the subscribed user will be deleted from the subscription list, and the status changes of the user will not be synchronized to the subscriber.
ZIMUserStatusSubscription
User status subscription information. Contains the user's online status, a list of online platforms, subscription expiration time stamps, and more.
Details
User status subscription information. Contains the user's online status, a list of online platforms, subscription expiration time stamps, and more.
- Available since: 2.18.0
Properties
userStatus
subscribeExpiredTime
subscribeExpiredTime: number The timestamp when the user's subscription expired.
ZIMUsersInfoQueriedResult
Query the userInfo callback.
Details
Supported version: 2.0.0 and above.
Detailed description: Callback after developer queries user information.
Notification timing: This callback is triggered when a developer invokes the [queryUsersInfo] interface.
Related interface: Run the queryUsersInfo command to query information.
Properties
userList
errorUserList
ZIMUsersInfoQueryConfig
User information query configuration.
Details
Detailed description: User information query configuration, you can choose to query from the local or from the server. Query the unlimited frequency constraints from the local, and query the limited frequency constraints from the server. You can only query the detailed configuration of 10 users within 10 s.
Properties
isQueryFromServer
isQueryFromServer: boolean - Required: not required.
Default: false.
ZIMUsersStatusQueriedResult
Result callback of the queryUsersStatus interface for batch querying user status.
Details
Result callback of the queryUsersStatus interface for batch querying user status.
Properties
userStatusList
errorUserList
ZIMUsersStatusSubscribedResult
The result of a callback to the user status of other users in a batch subscription.
Details
The result of a callback to the user status of other users in a batch subscription.
Properties
errorUserList
ZIMUsersStatusUnsubscribedResult
Result callback for batch unsubscribing subscribed users.
Details
Result callback for batch unsubscribing subscribed users.
Properties
errorUserList
ZIMVideoMessage
Video message object.
Properties
videoDuration
videoDuration: number - Required: Required by the sender, if not filled, the video message will fail to be sent when sending local video messages.
videoFirstFrameLocalPath
videoFirstFrameLocalPath: string Detailed description: The video first frame local path of the video file.
Required or not: The sender does not need to fill in it. After calling [downloadMediaFile] to download, the SDK will generate this value.
videoFirstFrameDownloadUrl
videoFirstFrameDownloadUrl: string Detail description: Video first frame external download URL of the video file. When developers upload thumbnails to their own servers, the SDK can pass through this field to other users.
Required or not: optional on the sender side, this field will only take effect when fileDownloadUrl is filled in.
videoFirstFrameWidth
videoFirstFrameWidth: number Detailed description: The width of the first frame of the video.
Business scenario: When the user needs to draw a picture UI, the parameter used to determine the width of the first frame of the video, the unit is pixel.
videoFirstFrameHeight
videoFirstFrameHeight: number Detailed description: The height of the first frame of the video.
Business scenario: When the user needs to draw a picture UI, the parameter used to determine the height of the first frame of the video, the unit is pixel.
fileLocalPath
fileLocalPath: string - Required: If a local file is sent, this parameter must be set by the sender. Otherwise, the message fails to be sent.
fileDownloadUrl
fileDownloadUrl: string Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.
Required or not: If an external URL is sent, this parameter is mandatory on the sender end.
fileUID
fileUID: string Detail description: The unique ID of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
fileName
fileName: string Detail description: The filename of the media file.
Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.
fileSize
fileSize: number Detail description: The size of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
type
messageID
messageID: string The unique ID that identifies this message.
- Use cases: Can be used to index other messages.
- Caution: When the developer actively creates a message, there is no need to modify this parameter. This parameter only has a value during callback.
timestamp
timestamp: number Identifies the sending time of a message
- Use cases: Used to present the sending time of a message, and can be used for message sorting.
- Caution: This is a standard UNIX timestamp, in milliseconds.
senderUserID
senderUserID: string Displays the userID of the sender of this message.
conversationID
conversationID: string Conversation ID. Ids of the same conversation type are unique.
direction
sentStatus
conversationType
conversationType: ZIMConversationType The type of conversation to which the message belongs.
conversationSeq
conversationSeq: number Indicates the sequence number of the message in the conversation.
orderKey
orderKey: number The larger the orderKey, the newer the message, and can be used for ordering messages.
localMessageID
localMessageID: string SDK locally generated MessageID, developers do not need to pay attention to.
isUserInserted
isUserInserted: boolean Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].
Default: false.
receiptStatus
receiptStatus: ZIMMessageReceiptStatus Describe the receipt status of the message
Business scenario: used to determine the status of the current message in the receipt message
extendedData
extendedData: string message extension field
- Use cases: You can add extended fields to the message and send it to the peer
- Required: no
- Caution: the length is 1k, you can contact technical support for configuration
- Available since: 2.6.0 or higher
localExtendedData
localExtendedData: string The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.
isBroadcastMessage
isBroadcastMessage: boolean Whether the message is pushed by all employees.
- Required: Internal assignment.
isMentionAll
isMentionAll: boolean Whether to mention everyone. It can be presented as "@Everyone".
- Use cases: For example, it can be used in groups or rooms.
- Required: No.
- Default value: false.
- Recommended value: Set to true if you need to mention everyone.
- Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
mentionedUserIDs
mentionedUserIDs: string[] Whether to mention everyone. It can be presented as "@User".
- Use cases: For example, it can be used in sending messages.
- Required: No.
- Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves
- Available since: 2.14.0 or above
messageSeq
messageSeq: number Indicates the sequence number of the message in the conversation.
rootRepliedCount
rootRepliedCount: number The number of reply messages corresponding to the root message of the reply message tree.
repliedInfo
repliedInfo: ZIMMessageRepliedInfo Information about the source message referenced by the reply message.
editorUserID
editorUserID: string The latest editor's userID for this message.
editedTime
editedTime: number The latest editing timestamp for this message.
isGroupTargetedMessage
isGroupTargetedMessage: boolean Identify if this message is group targeted message.
pinnedUserID
pinnedUserID: string The last user who pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
pinnedTime
pinnedTime: number The last timestamp when pinned this message.
- Use cases: This parameter is only assigned in [queryPinnedMessageList] or [onMessagePinStatusChanged].
ZIMVideoMessageLiteInfo
Video message lite info object.
Details
Identifies a video message.
Usage restrictions: Only supports video files with video encoding formats of H264 and H265. After the message is sent successfully, the width and height information of the first frame of the video can be obtained.
Properties
videoDuration
videoDuration: number - Required: Required by the sender, if not filled, the video message will fail to be sent when sending local video messages.
videoFirstFrameLocalPath
videoFirstFrameLocalPath: string Detailed description: The video first frame local path of the video file.
Required or not: The sender does not need to fill in it. After calling [downloadMediaFile] to download, the SDK will generate this value.
videoFirstFrameDownloadUrl
videoFirstFrameDownloadUrl: string Detail description: Video first frame external download URL of the video file. When developers upload thumbnails to their own servers, the SDK can pass through this field to other users.
Required or not: optional on the sender side, this field will only take effect when fileDownloadUrl is filled in.
videoFirstFrameWidth
videoFirstFrameWidth: number Detailed description: The width of the first frame of the video.
Business scenario: When the user needs to draw a picture UI, the parameter used to determine the width of the first frame of the video, the unit is pixel.
videoFirstFrameHeight
videoFirstFrameHeight: number Detailed description: The height of the first frame of the video.
Business scenario: When the user needs to draw a picture UI, the parameter used to determine the height of the first frame of the video, the unit is pixel.
fileLocalPath
fileLocalPath: string - Required: If a local file is sent, this parameter must be set by the sender. Otherwise, the message fails to be sent.
fileDownloadUrl
fileDownloadUrl: string Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.
Required or not: If an external URL is sent, this parameter is mandatory on the sender end.
fileName
fileName: string Detail description: The filename of the media file.
Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.
fileSize
fileSize: number Detail description: The size of the media file.
Required or not: The sender does not need to fill in, this value is generated by the SDK.
type
ZIMVoIPConfig
Provides information about the iOS VoIP offline push.
Details
Provides information about the iOS VoIP offline push.
Properties
iOSVoIPHandleType
iOSVoIPHandleType: ZIMCXHandleType The type of contact information for the VoIP caller, by default, is generic.
iOSVoIPHandleValue
iOSVoIPHandleValue: string The contact information of the VoIP caller. It is related to iOSVoIPHandleType. When iOSVoIPHandleType is PhoneNumber, the Value is a sequence of digits; when iOSVoIPHandleType is EmailAddress, the Value is an email address; when the contact information is of other types, the Value typically follows some domain-specific format, such as a username, numeric ID, or URL.
iOSVoIPHasVideo
iOSVoIPHasVideo: boolean Video call or not. The default value is audio
ZPNsConfig
ZPNs push configuration class.
Details
ZPNs push configuration class.
- Use cases: Add the required configuration items pushed by each vendor and a Boolean value for whether to enable them.
Properties
enableHWPush
enableHWPush: boolean Whether to enable Huawei Boolean push.
enableMiPush
enableMiPush: boolean Whether to enable the Boolean value pushed by Xiaomi.
enableVivoPush
enableVivoPush: boolean Whether to enable the Boolean value pushed by vivo.
miAppID
miAppID: string Xiaomi pushes the required AppID.
miAppKey
miAppKey: string Xiaomi pushes the required AppKey.
oppoAppID
oppoAppID: string oppo pushes the required AppID.
oppoAppSecret
oppoAppSecret: string Oppo pushes the required AppSecret.
oppoAppKey
oppoAppKey: string oppo pushes the required AppKey.
vivoAppID
vivoAppID: string Vivo pushes the desired AppID.
vivoAppKey
vivoAppKey: string vivo pushes the required AppKey.
hwAppID
hwAppID: string Huawei pushes the required AppID.
enableFCMPush
enableFCMPush: boolean whether to enable Google Push Boolean
enableOppoPush
enableOppoPush: boolean Whether to enable the Boolean value pushed by oppo.
enableHwBadge
enableHwBadge: boolean Set this parameter to true when the device is a Huawei device and the receiver needs to enable the corner marking function.
- Use cases: Please fill in before the registerPush call and pass ZPNs through the setPushConfig interface.
- Required: This is not required.
- Default value: The default is false.
apptype
private apptype: number Used to specify the number of offline push configurations for the current project corresponding to the ZEGO console, default to the first set.
- Use cases: If you need to use the same App ID on different bundle IDs/packages.
- Required: No.
- Default value: 1.
- Recommended value: It should be consistent with the 'App type' configured in the ZEGOCLOUD Console for the offline push certificate associated with the current bundle ID/package name.
ZPNsIOSNotificationArrivedConfig
You can specify whether to display iOS push pop-ups, sounds, and corner markers when registering for offline push.
Details
You can specify whether to display iOS push pop-ups, sounds, and corner markers when registering for offline push.
Properties
isPresentBadge
isPresentBadge: boolean Whether to modify the corner label when iOS receives push in the foreground.
isPresentSound
isPresentSound: boolean Whether there is a ring tone when iOS is pushed in the foreground.
isPresentAlert
isPresentAlert: boolean Whether there is a notification pop-up window when iOS receives push in the foreground.
ZPNsLocalMessage
Describes the message class for adding local notifications.
Properties
title
title: string Notification title.
content
content: string Notification content.
payload
payload: string Notification payload.
channelID
channelID: string Notification channel ID.
iOSSound
iOSSound: string The name of the iOS platform sound file.
androidSound
androidSound: string The name of the Android platform sound file.
ZPNsMessage
ZPNs message class.
Details
ZPNs message class.
- Use cases: Use the object of this data class to get the details of the push message.
Properties
title
title: string Message title, or notification title if it is a notification message.
content
content: string Message content: indicates the notification content of the message if the message is passed through. Indicates the body of the transparent message if the message is passed through.
- Caution: oppo all key values add up to a maximum of 500 characters (note: each value is currently within 50 characters, later adjusted).
pushSourceType
extras
extras: Record<string, any> Each platform passes the source object, need to determine the type conversion.
ZPNsNotificationChannel
A class describing a notification channel.
Properties
channelID
channelID: string Channel ID.
channelName
channelName: string Channel name.
androidSound
androidSound: string The name of the Android platform sound file.
ZPNsRegisterConfig
ZPNs register push configuration class.
Details
ZPNs register push configuration class.
Properties
androidEnvironment
iOSEnvironment
iOSEnvironment: ZPNsEnvironment The certificate environment selected during packaging.
enableIOSVoIP
enableIOSVoIP: boolean Is VoIP enabled on iOS.
iOSNotificationArrivedConfig
iOSNotificationArrivedConfig: ZPNsIOSNotificationArrivedConfig Set whether to display alert, badge, or sound when regular alert notifications arrive in the foreground.
ZPNsRegisterMessage
Describes the message class that vendors push token information.
Details
Describes the message class that vendors push token information.
- Use cases: When onRegister is triggered, an object of this data class is returned, carrying a message class about vendor push token information.
Properties
errorCode
errorCode: number ZPNs Error code.
pushID
pushID: string ZPNs Push ID generated.