InteractiveMessage class

Represents a interactive message within the chat.

This class extends BaseMessage and adds additional properties specifically related to an interactive message, such as the interactiveData, interactions etc.

Android Reference: com.cometchat.chat.models.InteractiveMessage

Inheritance

• Object
• AppEntity
• BaseMessage
• InteractiveMessage

Implementers

• CardMessage
• CustomInteractiveMessage
• FormMessage
• SchedulerMessage

Constructors

InteractiveMessage({required Map<String, dynamic> interactiveData, List<Interaction>? interactions, InteractionGoal? interactionGoal, List<String>? tags, int? id, String muid = "", User? sender, AppEntity? receiver, required String receiverUid, required String type, required String receiverType, DateTime? sentAt, DateTime? deliveredAt, DateTime? readAt, Map<String, dynamic>? metadata, DateTime? readByMeAt, DateTime? deliveredToMeAt, DateTime? deletedAt, DateTime? editedAt, String? deletedBy, String? editedBy, DateTime? updatedAt, String? conversationId, int? parentMessageId, int? replyCount, bool allowSenderInteraction = false, int? unreadRepliesCount, BaseMessage? quotedMessage, int? quotedMessageId})

Constructs a new InteractiveMessage instance.

InteractiveMessage.fromMap(dynamic map, {AppEntity? receiver})

Creates a new InteractiveMessage instance from a map.

factory

Properties

allowSenderInteraction ↔ bool

Whether the sender can interact with their own message.

getter/setter pair

category ↔ String

The category of message (message, action, call, custom, etc.). Android: String category (reference type, can be null)

getter/setter pair, inherited

conversationId ↔ String?

The conversation ID this message belongs to. Android: String conversationId (reference type, can be null)

getter/setter pair, inherited

deletedAt ↔ DateTime?

Timestamp when the message was deleted. Android: long deletedAt (primitive, 0 = not set)

getter/setter pair, inherited

deletedBy ↔ String?

UID of the user who deleted the message. Android: String deletedBy (reference type, can be null)

getter/setter pair, inherited

deliveredAt ↔ DateTime?

Timestamp when the message was delivered. Android: long deliveredAt (primitive, 0 = not set)

getter/setter pair, inherited

deliveredToMeAt ↔ DateTime?

Timestamp when the message was delivered to the logged-in user. Android: long deliveredToMeAt (primitive, 0 = not set)

getter/setter pair, inherited

editedAt ↔ DateTime?

Timestamp when the message was edited. Android: long editedAt (primitive, 0 = not set)

getter/setter pair, inherited

editedBy ↔ String?

UID of the user who edited the message. Android: String editedBy (reference type, can be null)

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hasMentionedMe ↔ bool

Whether the logged-in user is mentioned in this message. Android: boolean hasMentionedMe (primitive, defaults to false) Note: In Android, this is computed by checking if logged-in user UID is in the mentions map. Flutter computes this the same way in the mapper.

getter/setter pair, inherited

id ↔ int

Unique identifier for the message. Android: long id (primitive, defaults to 0)

getter/setter pair, inherited

interactionGoal ↔ InteractionGoal?

Goal configuration for tracking interaction completion.

getter/setter pair

interactions ↔ List<Interaction>?

List of user interactions with this message.

getter/setter pair

interactiveData ↔ Map<String, dynamic>

Interactive data containing form/card elements.

getter/setter pair

mentionedUsers ↔ List<User>

List of users mentioned in this message. Android: List<User> mentionedUser (initialized to empty ArrayList)

getter/setter pair, inherited

metadata ↔ Map<String, dynamic>?

Custom metadata attached to the message. Android: JSONObject metadata (reference type, can be null)

getter/setter pair, inherited

muid ↔ String

Developer-set unique identifier. Android: String muid (reference type, can be null)

getter/setter pair, inherited

parentMessageId ↔ int

Parent message ID for threaded messages. Android: long parentMessageId (primitive, defaults to 0)

getter/setter pair, inherited

pinnedAt ↔ DateTime?

When this message was pinned to its conversation (pin & save). null = not pinned. Present-only-when-set on the wire — absence means "not pinned", never an error.

getter/setter pair, inherited

pinnedBy ↔ String?

UID of the member who pinned this message, or the app_system sentinel when the pin was placed by an admin surface (API key / dashboard). null whenever pinnedAt is null.

getter/setter pair, inherited

quotedMessage ↔ BaseMessage?

The quoted message (for reply messages). Android: BaseMessage quotedMessage (reference type, can be null)

getter/setter pair, inherited

quotedMessageId ↔ int

The ID of the quoted message. Android: long quotedMessageId (primitive, defaults to 0)

getter/setter pair, inherited

rawMessage ↔ Map<String, dynamic>?

The raw JSON message for passthrough of unmapped fields. Android: JSONObject rawMessage (reference type, can be null)

getter/setter pair, inherited

reactions ↔ List<ReactionCount>

List of reactions on this message. Android: List<ReactionCount> reactions (initialized to empty ArrayList)

getter/setter pair, inherited

readAt ↔ DateTime?

Timestamp when the message was read. Android: long readAt (primitive, 0 = not set)

getter/setter pair, inherited

readByMeAt ↔ DateTime?

Timestamp when the message was read by the logged-in user. Android: long readByMeAt (primitive, 0 = not set)

getter/setter pair, inherited

receiver ↔ AppEntity?

The receiver of the message (User or Group). Android: AppEntity receiver (reference type, can be null)

getter/setter pair, inherited

receiverType ↔ String

The type of receiver (user or group). Android: String receiverType (required in constructor)

getter/setter pair, inherited

receiverUid ↔ String

The UID of the receiver. Android: String receiverUid (required in constructor)

getter/setter pair, inherited

replyCount ↔ int

Number of replies to this message. Android: int replyCount (primitive, defaults to 0)

getter/setter pair, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

savedAt ↔ DateTime?

When the logged-in user saved (bookmarked) this message. Per-viewer: two users see different values for the same message. null = not saved by me.

getter/setter pair, inherited

sender ↔ User?

The sender of the message. Android: User sender (reference type, can be null)

getter/setter pair, inherited

sentAt ↔ DateTime?

Timestamp when the message was sent. Android: long sentAt (primitive, 0 = not set)

getter/setter pair, inherited

tags ↔ List<String>?

Tags associated with this message.

getter/setter pair

threadSubscribed ↔ bool

Whether the logged-in user is subscribed to this message's thread (thread subscription — reply-notification follow state).

getter/setter pair, inherited

type ↔ String

The type of message (text, image, video, etc.). Android: String type (required in constructor)

getter/setter pair, inherited

unreadRepliesCount ↔ int

Number of unread replies to this message. Android: int unreadRepliesCount (primitive, defaults to 0)

getter/setter pair, inherited

updatedAt ↔ DateTime?

Timestamp when the message was last updated. Android: long updatedAt (primitive, 0 = not set)

getter/setter pair, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Generates a map representing the InteractiveMessage.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited