ZIMCombineMessage class

Base class for combine message objects.

Detail description: Identifies a combine message. Note: This base class is the basis of all combine messages and contains the properties required by combine messages. Available since: 2.14.0 and above.

Inheritance

Constructors

ZIMCombineMessage({required String title, required String summary, String combineID = '', required List<ZIMMessage> messageList})
ZIMCombineMessage.fromMap(Map map)

Properties

cbInnerID ↔ String
getter/setter pairinherited
combineID ↔ String
Detail description: Combine ID, internal used
getter/setter pair
conversationID ↔ String
Description: Conversation ID. Ids of the same conversation type are unique.
getter/setter pairinherited
conversationSeq ↔ int
Description: Indicates the sequence number of the message in the conversation.
getter/setter pairinherited
conversationType ↔ ZIMConversationType
Description: The type of conversation to which the message belongs.
getter/setter pairinherited
direction ↔ ZIMMessageDirection
Description: Used to describe whether a message is sent or received.
getter/setter pairinherited
editedTime ↔ int
Description: The time of message editing.
getter/setter pairinherited
editorUserID ↔ String
Description: The userID of the message editor.
getter/setter pairinherited
extendedData ↔ String
Description: 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
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
isBroadcastMessage ↔ bool
Description: Whether the message is pushed by all employees. Required: Internal assignment.
getter/setter pairinherited
isGroupTargetedMessage ↔ bool
Indicates whether the message is a group-targeted message.
getter/setter pairinherited
isMentionAll ↔ bool
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
getter/setter pairinherited
isServerMessage ↔ bool
getter/setter pairinherited
isUserInserted ↔ bool
Detail description: Describes whether the message is a message inserted by the developer through insertMessageToLocalDB.Default: false.
getter/setter pairinherited
localExtendedData ↔ String
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.
getter/setter pairinherited
localMessageID ↔ dynamic
Description: SDK locally generated MessageID, developers do not need to pay attention to.
getter/setter pairinherited
mentionedUserIDs ↔ List<String>
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
getter/setter pairinherited
messageID ↔ dynamic
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.
getter/setter pairinherited
messageList ↔ List<ZIMMessage>
List of child messages
getter/setter pair
messageSeq ↔ int
Description: The sequence number of the message.
getter/setter pairinherited
orderKey ↔ int
Description:The larger the orderKey, the newer the message, and can be used for ordering messages.
getter/setter pairinherited
pinnedTime ↔ int
Description: The time of message pinning.
getter/setter pairinherited
pinnedUserID ↔ String
Description: The userID of the message pinner.
getter/setter pairinherited
reactions ↔ List<ZIMMessageReaction>
Description: Message statement list, which can carry data strongly related to users such as emoji expressions and voting information.
getter/setter pairinherited
receiptStatus ↔ ZIMMessageReceiptStatus
Detailed Description: Describe the receipt status of the messageBusiness scenario: used to determine the status of the current message in the receipt message
getter/setter pairinherited
repliedInfo ↔ ZIMMessageRepliedInfo?
Description: Message reply information.
getter/setter pairinherited
rootRepliedCount ↔ int
Description: Root replied count.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
senderUserID ↔ String
Description：Displays the userID of the sender of this message.
getter/setter pairinherited
sentStatus ↔ ZIMMessageSentStatus
Description: Describes the sending status of a message.
getter/setter pairinherited
summary ↔ String
Detail description: The summary of combine message.
getter/setter pair
timestamp ↔ int
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.
getter/setter pairinherited
title ↔ String
Detail description: Combine message title.
getter/setter pair
type ↔ ZIMMessageType
Identifies the type of this message.
getter/setter pairinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited