CustomMessage class

A class that represents custom message. Use metadata to store anything you want.

Inheritance

• Object
• Message
• CustomMessage

Annotations

• @immutable

Constructors

CustomMessage({required User author, int? createdAt, required String id, Map<String, dynamic>? metadata, String? roomId, Status? status, int? updatedAt})

Creates a custom message.

const

CustomMessage.fromJson(Map<String, dynamic> json)

Creates a custom message from a map (decoded JSON).

CustomMessage.fromPartial({required User author, int? createdAt, required String id, required PartialCustom partialCustom, String? roomId, Status? status, int? updatedAt})

Creates a full custom message from a partial one.

Properties

author → User

User who sent this message

final, inherited

createdAt → int?

Created message timestamp, in ms

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String

Unique ID of the message

final, inherited

metadata → Map<String, dynamic>?

Additional custom metadata or attributes related to the message

final, inherited

props → List<Object?>

Equatable props

no setter

roomId → String?

ID of the room where this message is sent

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status → Status?

Message Status

final, inherited

stringify → bool?

If set to true, the toString method will be overridden to output this instance's props.

no setter, inherited

type → MessageType

MessageType

final, inherited

updatedAt → int?

Updated message timestamp, in ms

final, inherited

Methods

copyWith({Map<String, dynamic>? metadata, PreviewData? previewData, Status? status, String? text, int? updatedAt}) → Message

Creates a copy of the custom message with an updated data. metadata with null value will nullify existing metadata, otherwise both metadatas will be merged into one Map, where keys from a passed metadata will overwite keys from the previous one. previewData is ignored for this message type. status with null value will be overwritten by the previous status. text is ignored for this message type. updatedAt with null value will nullify existing value.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Converts a custom message to the map representation, encodable to JSON.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited