Struct

The content of barrage message.

Identifies the type of this message.

The unique ID that identifies this message.

Identifies the sending time of a message

The length of the message. If the message type is text, it should be the length of the string.

Displays the userID of the sender of this message.

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

Used to describe whether a message is sent or received.

Describes the sending status of a message.

The type of conversation to which the message belongs.

Indicates the sequence number of the message in the conversation.

The larger the orderKey, the newer the message, and can be used for ordering messages.

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

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

Default: false.

Describe the receipt status of the message

Business scenario: used to determine the status of the current message in the receipt message

message extension field

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.

Whether the message is pushed by all employees.

Whether to mention everyone. It can be presented as "@Everyone".

Whether to mention everyone. It can be presented as "@User".

Indicates the sequence number of the message in the conversation.

The number of reply messages corresponding to the root message of the reply message tree.

Information about the source message referenced by the reply message.

The latest editor's userID for this message.

The latest editing timestamp for this message.

Identify if this message is group targeted message.

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

The calling party of the current call.

End the call operator.

The pass-through field that comes with invoking the end of the call.

The mode of the call invitation.

Time stamp of the end of the call, in milliseconds. The format is UTC time stamp.

Call invitation type.

Timestamp of the time when the call invitation was created.

Time stamp of the person join the call invitation.

The pass-through field that comes with invoking the end of the call.

List of user information in the current call invitation.

Timestamp of the time when the call invitation was created.

Time stamp of the person accepting the call invitation.

The time stamp for me to exit the call.

List of call members whose status changes.

Error user list.

The content of the custom message.

Identifies the type of this message.

The unique ID that identifies this message.

Identifies the sending time of a message

The length of the message. If the message type is text, it should be the length of the string.

Displays the userID of the sender of this message.

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

Used to describe whether a message is sent or received.

Describes the sending status of a message.

The type of conversation to which the message belongs.

Indicates the sequence number of the message in the conversation.

The larger the orderKey, the newer the message, and can be used for ordering messages.

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

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

Default: false.

Describe the receipt status of the message

Business scenario: used to determine the status of the current message in the receipt message

message extension field

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.

Whether the message is pushed by all employees.

Whether to mention everyone. It can be presented as "@Everyone".

Whether to mention everyone. It can be presented as "@User".

Indicates the sequence number of the message in the conversation.

The number of reply messages corresponding to the root message of the reply message tree.

Information about the source message referenced by the reply message.

The latest editor's userID for this message.

The latest editing timestamp for this message.

Identify if this message is group targeted message.

conversationID.

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

conversation type.

Session unread.

last message.

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

session notification status.

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.

Whether the conversation is pinned.

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

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.

Describes all the existing marks for the conversation.

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

The timestamp at the top of the session

Conversation read message sequence number.

session events.

Session specific information.

Whether to delete the conversation on the server

Session that needs to be queried.

The number of sessions to query.

Number of sessions that were deleted.

The text content of the message.

The subtype of the message, which is used by customers to customize the usage of different custom messages.

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.

Identifies the type of this message.

The unique ID that identifies this message.

Identifies the sending time of a message

The length of the message. If the message type is text, it should be the length of the string.

Displays the userID of the sender of this message.

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

Used to describe whether a message is sent or received.

Describes the sending status of a message.

The type of conversation to which the message belongs.

Indicates the sequence number of the message in the conversation.

The larger the orderKey, the newer the message, and can be used for ordering messages.

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

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

Default: false.

Describe the receipt status of the message

Business scenario: used to determine the status of the current message in the receipt message

message extension field

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.

Whether the message is pushed by all employees.

Whether to mention everyone. It can be presented as "@Everyone".

Whether to mention everyone. It can be presented as "@User".

Indicates the sequence number of the message in the conversation.

The number of reply messages corresponding to the root message of the reply message tree.

Information about the source message referenced by the reply message.

The latest editor's userID for this message.

The latest editing timestamp for this message.

Identify if this message is group targeted message.

The text content of the message.

The subtype of the message, which is used by customers to customize the usage of different custom messages.

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.

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

Error infomation description.

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.

Total file size in bytes (B).

Detail description: If you are the applicant, here is the respondent information; if you are the respondent, here is the applicant information;

The wording of friend application information.

Friend add time.

Friend application status update time.

Friend application type.

Friend application state.

Detail description: UserID of the operator.

The alias of friend.

Friend attributes. Up to 5 can be set. The key of the attribute can only be selected from k0 to k4.

Friend add time.

User name, defined by you. For version 2.0.0 and onwards, the string has a maximum length of 256 bytes.

The user avatar, which is custom generated by the developer, is not restricted by special characters and has a maximum length of 500 bytes.

Extended field information of the user.

user ID.

Friend relationship type.

Detail description: The applicant is the applicant when applying to join, the invitee when applying to invite, and the inviter when applying by invitation.

The wording of group application information.

Group application create time.

Group application status update time.

Group application type.

Group application state.

Group information for applying to join the group.

The operator who agrees to join the group application.

The expiration date of the group gag.

Whether the group session is unavailable.

conversationID.

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

conversation type.

Session unread.

last message.

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

session notification status.

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.

Whether the conversation is pinned.

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

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.

Describes all the existing marks for the conversation.

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

The timestamp at the top of the session

Conversation read message sequence number.

Offline push configuration.

Offline push configuration.

Postscript to the application operation.

Offline push configuration.

Offline push configuration.

Offline push configuration.

Postscript to the application operation.

Offline push configuration.

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)

Identifies the type of this message.

The unique ID that identifies this message.

Identifies the sending time of a message

The length of the message. If the message type is text, it should be the length of the string.

Displays the userID of the sender of this message.

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

Used to describe whether a message is sent or received.

Describes the sending status of a message.

The type of conversation to which the message belongs.

Indicates the sequence number of the message in the conversation.

The larger the orderKey, the newer the message, and can be used for ordering messages.

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

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

Default: false.

Describe the receipt status of the message

Business scenario: used to determine the status of the current message in the receipt message

message extension field

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.

Whether the message is pushed by all employees.

Whether to mention everyone. It can be presented as "@Everyone".

Whether to mention everyone. It can be presented as "@User".

Indicates the sequence number of the message in the conversation.

The number of reply messages corresponding to the root message of the reply message tree.

Information about the source message referenced by the reply message.

The latest editor's userID for this message.

The latest editing timestamp for this message.

Identify if this message is group targeted message.

Conversation ID.

Conversation type.

List of deleted messages.

Whether to delete all current messages in the conversation.

[onMessageDeleted] Indicates the cause of being triggered.

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.

conversationID.

conversation type.

Detail description: reaction message ID.

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

The reaciton users if included myself.

The reaction users number.

Reaction user info list.

The sum count of reaction.

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

The sum count of reaction.

user ID.

reaction change action.

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

The sum count of reaction.

user ID

Repeated reaction list.

user ID

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.

How many members are retrieved in one query, 100 at most. Exceeding 100 will result in an error.

reaction type, defined by you.

the list of changed reactions.

change info list.

Detail description: receipt status.

Message ID.

Business scenario: Developers can match the loaded message list according to this ID.

Is it required: No, SDK fills in.

Session ID.

Business scenario: Receipt information used to indicate which session this belongs to.

Is it required: No, SDK fills in.

Session type.

Business scenario: Indicates the type of the session.

Is it required: If no, the SDK is filled.

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.

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.

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.

Server-side timestamp when the message receipt was read.

the source message status.

The send timestamp of the source message (in UTC).

The sender user ID of the source message.

The seq of the source message.

The source message lite info object.

The ID of the source message.

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.

Conversation ID.

Conversation type.

root message id.

The number of replies for the reply message tree.

Root message status.

The send timestamp of the root message.

The sender user ID of the root message.

The number of replies for the reply message tree.

The root message object.

The base object of the room.

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

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.

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.

Detailed description: room user attributes.

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

User name, defined by you. For version 2.0.0 and onwards, the string has a maximum length of 256 bytes.

The user avatar, which is custom generated by the developer, is not restricted by special characters and has a maximum length of 500 bytes.

Extended field information of the user.

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.

Detail description: UserID of the operator.

Rules for the current user, setting information.

Personal information of the current user.

The user's current rule information.

The content of the text message.

Identifies the type of this message.

The unique ID that identifies this message.

Identifies the sending time of a message

The length of the message. If the message type is text, it should be the length of the string.

Displays the userID of the sender of this message.

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

Used to describe whether a message is sent or received.

Describes the sending status of a message.

The type of conversation to which the message belongs.

Indicates the sequence number of the message in the conversation.

The larger the orderKey, the newer the message, and can be used for ordering messages.

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

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

Default: false.

Describe the receipt status of the message

Business scenario: used to determine the status of the current message in the receipt message

message extension field

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.

Whether the message is pushed by all employees.

Whether to mention everyone. It can be presented as "@Everyone".

Whether to mention everyone. It can be presented as "@User".

Indicates the sequence number of the message in the conversation.

The number of reply messages corresponding to the root message of the reply message tree.

Information about the source message referenced by the reply message.

The latest editor's userID for this message.

The latest editing timestamp for this message.

Identify if this message is group targeted message.

The content of the text message.

User basic information.

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

User name, defined by you. For version 2.0.0 and onwards, the string has a maximum length of 256 bytes.

The user avatar, which is custom generated by the developer, is not restricted by special characters and has a maximum length of 500 bytes.

Extended field information of the user.

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.

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.

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

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.

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

Business scenario: When the user needs to draw a picture UI, the parameters used to determine the width and height of the first frame of the video.

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.

Identifies the type of this message.

The unique ID that identifies this message.

Identifies the sending time of a message

The length of the message. If the message type is text, it should be the length of the string.

Displays the userID of the sender of this message.

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

Used to describe whether a message is sent or received.

Describes the sending status of a message.

The type of conversation to which the message belongs.

Indicates the sequence number of the message in the conversation.

The larger the orderKey, the newer the message, and can be used for ordering messages.

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

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

Default: false.

Describe the receipt status of the message

Business scenario: used to determine the status of the current message in the receipt message

message extension field

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.

Whether the message is pushed by all employees.

Whether to mention everyone. It can be presented as "@Everyone".

Whether to mention everyone. It can be presented as "@User".

Indicates the sequence number of the message in the conversation.

The number of reply messages corresponding to the root message of the reply message tree.

Information about the source message referenced by the reply message.

The latest editor's userID for this message.

The latest editing timestamp for this message.

Identify if this message is group targeted message.

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.

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

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.

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 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 type of contact information for the VoIP caller, by default, is generic.

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.

Video call or not. The default value is audio