Envelope class abstract interface

Interface for message envelopes (headers) that contain routing/metadata for messages.

Envelopes wrap core message content with essential delivery information, including sender/receiver identifiers, timestamp, and metadata for message routing. Implements Mapper for serialization to/from structured formats (Map/JSON).

Serialized format (Map/JSON):

{
  "sender": "moki@xxx",    // Sender's unique ID
  "receiver": "hulk@yyy",  // Receiver's unique ID
  "time": 123.45,          // Message timestamp (Unix timestamp in seconds)
  "group": "group@zzz",    // Optional group ID (marks this as a group message)
  "type": "text"           // Optional message type
}

Implemented types

• Map<String, dynamic>

Properties

entries → Iterable<MapEntry<String, dynamic>>

The map entries of this Map.

no setter, inherited

group ↔ ID?

Optional group identifier for group messages.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

isEmpty → bool

Whether there is no key/value pair in the map.

no setter, inherited

isNotEmpty → bool

Whether there is at least one key/value pair in the map.

no setter, inherited

keys → Iterable<String>

The keys of this Map.

no setter, inherited

length → int

The number of key/value pairs in the map.

no setter, inherited

receiver → ID

Unique identifier of the message receiver.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sender → ID

Unique identifier of the message sender.

no setter

time → DateTime?

Timestamp when the message was created/sent.

no setter

type ↔ String?

Message content type identifier (for routing encrypted content).

getter/setter pair

values → Iterable

The values of this Map.

no setter, inherited

Methods

addAll(Map<String, dynamic> other) → void

Adds all key/value pairs of other to this map.

inherited

addEntries(Iterable<MapEntry<String, dynamic>> newEntries) → void

Adds all key/value pairs of newEntries to this map.

inherited

cast<RK, RV>() → Map<RK, RV>

Provides a view of this map as having RK keys and RV instances, if necessary.

inherited

clear() → void

Removes all entries from the map.

inherited

containsKey(Object? key) → bool

Whether this map contains the given key.

inherited

containsValue(Object? value) → bool

Whether this map contains the given value.

inherited

copyMap([bool deepCopy = false]) → Map

Creates a copy of the internal map.

inherited

forEach(void action(String key, dynamic value)) → void

Applies action to each key/value pair of the map.

inherited

getBool(String key, [bool? defaultValue]) → bool?

inherited

getDateTime(String key, [DateTime? defaultValue]) → DateTime?

inherited

getDouble(String key, [double? defaultValue]) → double?

inherited

getInt(String key, [int? defaultValue]) → int?

inherited

getString(String key, [String? defaultValue]) → String?

Gets a string value for the given key.

inherited

map<K2, V2>(MapEntry<K2, V2> convert(String key, dynamic value)) → Map<K2, V2>

Returns a new map where all entries of this map are transformed by the given convert function.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

putIfAbsent(String key, dynamic ifAbsent()) → dynamic

Look up the value of key, or add a new entry if it isn't there.

inherited

remove(Object? key) → dynamic

Removes key and its associated value, if present, from the map.

inherited

removeWhere(bool test(String key, dynamic value)) → void

Removes all entries of this map that satisfy the given test.

inherited

setDateTime(String key, DateTime? time) → void

inherited

setMap(String key, Mapper? mapper) → void

inherited

setString(String key, Stringer? stringer) → void

inherited

toMap() → Map

Returns the internal map as a Map.

inherited

toString() → String

A string representation of this object.

inherited

update(String key, dynamic update(dynamic value), {dynamic ifAbsent()?}) → dynamic

Updates the value for the provided key.

inherited

updateAll(dynamic update(String key, dynamic value)) → void

Updates all values.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

operator [](Object? key) → dynamic

The value for the given key, or null if key is not in the map.

inherited

operator []=(String key, dynamic value) → void

Associates the key with the given value.

inherited

Static Methods

create({required ID sender, required ID receiver, DateTime? time}) → Envelope

getFactory() → EnvelopeFactory?

parse(Object? env) → Envelope?

setFactory(EnvelopeFactory factory) → void