Struct

Description: The storage path of the log files. Refer to the official website document for the default path.

Description: Error infomation description.

Description

Description

The storage path of the log files. Refer to the official website document for the default path.

The maximum log file size (Bytes). The default maximum size is 5MB (5 * 1024 * 1024 Bytes)

Description: Log level, only used on the web platform. Required: Not required. Default value: 0.

The storage path of the cache files. Refer to the official website document for the default path.

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 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.

Description: 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.

User avatar URL

User extended data. This field is currently only available in room related interfaces.

User Type. This field is used to identify which subclass the current entity belongs to.

Description: User basic information.

With the data in the class member variables notToReceiveOfflinePushPlatforms collocation is used. OnlinePlatforms specified platform, online notToReceiveOfflinePushPlatforms specified platform will not receive offline push.

With the data in the class member variables onlinePlatforms collocation is used. OnlinePlatforms specified platform, online notToReceiveOfflinePushPlatforms specified platform will not receive offline push.

The user's current rule information.

A unique identifier for a single user.

Enumeration that represents the current online status of the user.

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.

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.

Expired timestamp of the custom status.

Timestamp when user onlineStatus or customStatus was last changed, whichever is the greater.

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.

The timestamp when User customStatus was last changed, which can be used to show when the custom status was last changed.

The online status of the user.

The timestamp when the user's subscription expired.

Personal information of the current user.

Rules for the current user, setting information.

The online status of the user.

Subscription duration, in minutes.

List of user IDs to query.

Duration of user custom status.

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 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.

Description Reason for the query failure.

Description: 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.

Description: Token carried during login.Use cases: Only pass this parameter in the scenario where token is used for authentication.Required: No.

Description: Whether it is offline login.Use cases: Set this parameter to true when performing offline login.Required: No.Default value: false.

Description: Custom status.Use cases: Only pass this parameter when you need to customize the user status during login.Required: No.

Description: Expired duration of the custom status.

Detail description: Whether to query user details 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.Required: not required.Default: false.

Description: The private message template ID is currently only applicable to OPPO manufacturers. Please fill in the template ID preset in the OPPO Open Platform console.

Description: To replace the content of the preset title field in the template, a json string needs to be filled in, such as "{"user_name":" Li Hua "}".

Description: To replace the content of the preset fields in the template, a json string needs to be filled in, such as "{"city":" Shenzhen "}".

Description: The type of contact information for the VoIP caller, by default, is generic.

Description: 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.

Description: Video call or not. The default value is audio

Description: Used to set the push title.Required: Not required.

Description: Used to set offline push content.Required: Not required.

Description: This parameter is used to set the pass-through field of offline push.Required: Not required.

Description: Offline push advanced configuration for mapping console Settings, with the maximum of 32 characters and defined by yourself.Required: Not required.

Description: Used to set the thread ID of offline push.Required: Not required.

Description: Push whether to carry corner information switch.

Description: The incremental index number carried by the push.

Description: 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.

Description: If you use OPPO Push, you can carry the push template through this field.

Description: When this value is greater than 0, the same user is allowed to react multiple times with the same reaction type, and the counts from those reactions will be accumulated.

Description: user ID

Description: Type of reaction, defined by you, with a maximum length of 32 bytes.

Description: conversationID.

Description: conversation type.

Detail description: reaction message ID.

Detail description: message sequence.

Description: The reaction users number.

Description: The reaciton users if included myself.

Description: Reaction user info list.

Detailed description: The sum count of reaction.

Description: Type of reaction, defined by you, with a maximum length of 32 bytes.

Detailed description: The sum count of reaction.

Description: user ID

Description: A list of summary information for the current user’s reactions under this message.

user ID.

Type of reaction, defined by you, with a maximum length of 32 bytes.

reaction change action.

Description: The sum count for the current reaction type.

Description: Message type.

Description: Text message content.

Description: Custom message content.

Description: Custom message search content.

Description: Custom message sub-type.

Description: Combine message title.

Description: Combine message summary.

Description: Media file size.

Description: Media file name.

Description: Media file local path.

Description: Media file download address.

Description: Original image width.

Description: Original image height.

Description: Large image width.

Description: Large image height.

Description: Large image local path.

Description: Large image download address.

Description: Thumbnail image width.

Description: Thumbnail image height.

Description: Thumbnail image local path.

Description: Thumbnail image download address.

Description: Audio duration.

Description: Video duration.

Description: Video first frame width.

Description: Video first frame height.

Description: Video first frame local path.

Description: Video first frame download address.

Description: Message list.

Description: Message replied state.

Description: Replied message lite information.

Description: Sender user ID of the replied message.

Description: Sent time of the replied message.

Description: ID of the replied message.

Description: Sequence number of the replied message.

Identifies the type of this message.

Description: 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.

Description: SDK locally generated MessageID, developers do not need to pay attention to.

Description: The sequence number of the message.

Description：Displays the userID of the sender of this message.

Description: Conversation ID. Ids of the same conversation type are unique.

Description: The type of conversation to which the message belongs.

Description: Used to describe whether a message is sent or received.

Description: Describes the sending status of a message.

Description: Identifies the sending time of a messageUse 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.

Description

Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].Default: false.

Detailed Description: Describe the receipt status of the messageBusiness scenario: used to determine the status of the current message in the receipt message

Description: message extension field Use cases: You can add extended fields to the message and send it to the peer Required: no Caution

Description: 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.

Description: Message statement list, which can carry data strongly related to users such as emoji expressions and voting information.

Description: Whether the message is pushed by all employees. Required: Internal assignment.

Description: 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

Description: 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

Description: Message reply information.

Description: Root replied count.

Whether the message was sent by the server.

The internal callback ID of the message.

Description: The userID of the message editor.

Description: The time of message editing.

Indicates whether the message is a group-targeted message.

Description: The userID of the message pinner.

Description: The time of message pinning.

Description: The timestamp at which the message will be destroyed.

Detail description: The local path of the media message. Required: If a local file is sent, this parameter must be set by the sender. Otherwise, the message fails to be sent.

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.

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.

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.

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.

The content of the text message.

The content of the text message.

Description: The search content of the message.

Description: 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.

The content of the custom message.

Description: The content of the barrage message.

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.

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.

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.

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.

Detailed description: The width of the original image.

Detailed description: The height of the original image.

Detailed description: The width of the large image.

Detailed description: The height of the large image.

Detailed description: The width of the thumbnail.

Detailed description: The height of the thumbnail.

Detail description: The duration of the audio file. Required: Required by the sender, if not filled, the audio message will fail to be sent When sending local audio messages.

Detail description: The duration of the video file. Required: Required by the sender, if not filled, the video message will fail to be sent when sending local video messages.

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.

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.

Detailed description: The width of the first frame of the video.

Detailed description: The height of the first frame of the video.

Detail description: revoke type.

Detail description: revoke timestamp.

Detail description: operated user ID.

Description: original message type

Detail description: original text message content, if the message to be revoked is not a text message, this field is empty.

Detail description: revoke extended data.

Detail description: revoke status.

Detail description: Combine message title.

Detail description: The summary of combine message.

Detail description: Combine ID, internal used

List of child messages

Detail description: Tips event type.

Detail description: Operated user information.

Detail description: Target user list.

Detail description: Change information.

Detail description: List of content in the multiple message.

Detail description: List of failed index in the multiple message.

Description: Message replied state.

Description: Root message.

Description: Sender user ID of the root message.

Description: Sent time of the root message.

Description: Root replied count.

Description: Message ID.

Description: Conversation ID.

Description: Conversation type.

Description: Root replied count.

Description: Message ID, used to match the notification information to which message it belongs toRequired or not: Developers do not need to fill in.

Description: Message sequence number, used to match the notification information to which message it belongs toRequired or not: Developers do not need to fill in.

Description: From which user. Required: Developers do not need to fill in.

Details Description: Type of notification, used to distinguish between reminding oneself and reminding everyone. Required: Developers do not need to fill in.

Description: The ID of conversation.

Description: The type of conversation.

Description: Whether it is an offline message.

Description: Configures the offline push function, If Android or iOS platform is integrated, it is strongly recommended to configure this. Required: Not mandatory.

Enumeration value used to set message priority. Required: Must mandatory.

Detailed description: When sending a message, whether the message has a receipt.Business scenario: use when you need to bring a receipt for a message.Required: not required.Default value: false.

Whether to send push notifications to mentioned users.

Whether to resend the failed message.

When sending messages that would otherwise affect the other party's unread count, should they no longer be counted as unread by the other party? Whether required: Not required. Default value: false.

Whether to allow some sub-messages to fail to send when sending a multiple message. Whether required: Not required. Default value: false.

Description: Query the anchor point of the message. Required: This parameter is not required for the first query but is required for subsequent paging queries.

Description: Number of query messages. Required: not required.

Description: Indicates whether the query is in reverse order. Required: not required. Default value: false.

Description: Sets the mode for querying historical messages. Since the SDK can determine whether local data is complete and therefore return historical messages more quickly, it is recommended to use the default value in most cases. Required: No.

Description: Configures the offline push function, If Android or iOS platform is integrated, it is strongly recommended to configure this. Required: Not required.

Description: revoking additional messages. Required: Not required.

Description: Whether to remove flags for server messages. Required: not required. Default value: false.

Description: Conversation ID.

Description: Conversation type.

[onMessageDeleted] Indicates the cause of being triggered.

List of deleted messages. Valid when [ZIMMessageDeleteType] is [ZIMMessageDeleteTypeMessageListDeleted].

Detail description: After the message falls into the local DB, the notification will be called back before the message is sent to the server. Business scenario: This interface can be used when the developer needs to obtain the relevant information in the message in advance before sending the message. Required: not required. If no monitoring is required, it can be passed empty. Default: empty.

Description: Media file upload progress.

Description: Multiple media file upload progress.

Detail description: After the message falls into the local DB, the notification will be called back before the message is sent to the server. Business scenario: This interface can be used when the developer needs to obtain the relevant information in the message in advance before sending the message. Required: not required. If no monitoring is required, it can be passed [null]. Default: [null].

Callback for media upload progress.

Detail description: receipt status.

Detailed Description: Message ID. Business scenario: Developers can match the loaded message list according to this ID. Is it required: No, SDK fills in.

Session ID.

Session type.

Description: Number of read members.

Description: Number of unread members.

Description: Number of delivered members.

Description: Whether it is self-operated by multi-terminal.

Description: All the recipients have read the timestamp of that moment.

Description: 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.

Description: How many members are retrieved in one query, 100 at most.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.

Description: reaction type, defined by you.

message sent status.

ZIMMessage.

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.

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 It is recommended to keep the number of items less than 20 to reduce performance overhead.

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

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

Message types, can be used to specify message types. Support passing in multiple types.

The subtypes of custom messages have a value range of [0,200]. Developers can use this range to search for specific custom types.

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.

The starting point of the search, in milliseconds, with a default value of 0. The format is UTC timestamp.

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.

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.

The number of queries per query. The upper limit is 100. Exceeding 100 will result in an error.

Detailed description: The index of the array where a file in the download multiple message is located.

When the number of pinned messages exceeds the limit, replacing older pinned messages in the pinned list during the next pin operation is not allowed. The default value is [false].

Tips message additional information type.

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.

If the group name is changed, the changed value will be displayed here.

If the group notice is changed, the changed value will be displayed here.

If the group avatar url is changed, the changed value will be displayed here.

If the group mute info is changed, the changed value will be displayed here.

If a group member's role changes, the changed role will be displayed here.

If the group member's muting expired time changes, the new muting expired time will be displayed here.

Detailed description: tips message generated when the original group owner leaves the group and causes a change in the group owner. This field is true and indicates a newly created group owner.

Describes whether the current operation is a pin operation or an unpin operation.

Message pin status

The message object whose pin status changed.

Expiration stamp of cache cleanup.

Example Query the expiration timestamp of the cache.

Total file size in bytes (B).

Description: The message object containing updated reaction information, which can be used to directly replace the old data held by the developer.

Description: A list of user reaction operation changes under the current message.

Conversation ID.

Conversation type.

conversationName is the same as the groupName/userName value corresponding to the session.

Conversation avatar URL. The peer-to-peer conversation avatar URL is the same as the user avatar URL, and the group conversation avatar URL is the same as the group avatar URL.

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.

Conversation notification status.

Unread message count of the conversation.

The last message in the conversation.

OrderKey is used to describe the order of messages in the session. The larger orderKey is, the newer it is.

Whether the conversation is pinned.

Description: The timestamp of conversation pinned.

When reminded in a message or reminded to everyone in a conversation, this array will record the reminders.

Conversation draft, when draft set conversation will carry this parameter.

Describes all the existing marks for the conversation.

Conversation read message sequence number.

Whether the conversation is unavailable.

The expiration timestamp of the self-mute for this conversation.

The timed message self-destruction duration for the conversation.

Conversation ID. For single chat, the conversation ID is the other user ID. For group chat, the conversation ID is the group ID.

Conversation type

Whether the group session is unavailable.

The expiration date of the group gag.

Session that needs to be queried.

The number of sessions to query.

Conversation type list

Conversation mark list

Whether to query only unread conversations

Conversation pinned filter

Conversation type list

Conversation mark list

Whether to delete server conversations at the same time

Number of sessions that were deleted.

Conversation change action

Changed conversation

Conversation search mode.

Pagination token, fill in 0 initially, and then fill in the nextFlag returned from the callback to retrieve data for the next page.

The number of messages that can be retrieved in one search. It is recommended to be less than 20 to reduce performance overhead.

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.

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.

Message types, can be used to specify message types. Support passing in multiple types.

The subtypes of custom messages have a value range of [0,200]. Developers can use this range to search for specific custom types.

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.

The starting point of the search, in milliseconds, with a default value of 0. The format is UTC timestamp.

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.

The conversation ID of the local message to be search.

conversation type.

Conversation object.

Total message count.

Search results of messages.

Room ID. a string with a maximum length of 128 bytes. It is customized by the developer and supports only digits, English characters, , and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', ''.

Room name, It is customized by the developer .a string with a maximum length of 64 bytes or less.

Room base information

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.

How many messages are retrieved in one query.

Room attributes of a room.

Room destruction time delayed, the unit is seconds. The maximum room destroy delay time is 3 hours.

Whether the operation is mandatory, that is, the property of the room whose owner is another user can be modified.

Room attributes are automatically deleted after the owner leaves the room.

Whether to update the owner of the room attribute involved.

Whether the operation is mandatory, that is, the property of the room whose owner is another user can be modified.

Room attributes are automatically deleted after the owner leaves the room.

Whether to update the owner of the room attribute involved.

Whether the operation is mandatory, that is, the property of the room whose owner is another user can be deleted.

Behavioral information of room attribute change notification.

Room attributes.

Detail description: User ID.

Detailed description: room user attributes.

Detailed description: room user attribute information.

Detail description: The key of the room user attribute operation failure.

Detailed description: room user attributes.

Default: true.

Detail description: Query anchor for room user properties.

count.

Detail description: UserID of the operator.

groupID.

Group name.

Use Limit: the maximum number of characters is 500 bytes. There is no limit on special characters.

Group mute mode.

Group mute expiration time, measured in seconds. When it's 0, there is no mute; when it's -1, it means permanent mute.

Detail description: Role list muted in the group.

Verification mode for joining the group.

Verification mode for invite to the group.

Verification mode for being invited to the group.

basic group information.

Group of announcement.

group properties.

the group alias defined by user, which is visible only to that user.

group message notification status.

Group mute info.

The timestamp of the server when the group was created.

The maximum number of group members.

Verification mode for joining the group.

basic group information.

the group alias defined by user, which is visible only to that user.

group message notification status.

Group member nickname.

group role.

The timestamp of the server when joining the group.

Group entry type.

Group entry type.

Group member nickname.

group role.

Group member's mute expiration time. When it's 0, it means no mute; when it's -1, it means permanent mute.

Information about group members when they join the group.

The operator's user ID.

The operator's username.

The operator's group member nickname.

The operator's group member role.

nextFlag.

count. Quantity, upper limit is 100, over 100 will be treated as 100.

group notice.

Group properties, up to 10 can be configured..

The maximum number of group members.