Document class abstract interface

Interface for entity profile documents (extends TAI with structured data).

Documents are specialized TAI implementations for standardized entity profiles (e.g., user visas, group bulletins) with consistent serialization format. Implements TAI for signature validation and Mapper for structured serialization.

Serialized format (Map/JSON):

{
  "did"       : "{EntityID}",      // Unique identifier of the entity (ID string)
  "type"      : "visa",            // "bulletin", ...
  "data"      : "{JSON}",          // data = json_encode(info)
  "signature" : "{BASE64_ENCODE}"  // signature = sign(data, SK);
}
Implemented types
Implementers

Properties

entries → Iterable<MapEntry<String, dynamic>>
The map entries of this Map.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isEmpty → bool
Whether there is no key/value pair in the map.
no setterinherited
isNotEmpty → bool
Whether there is at least one key/value pair in the map.
no setterinherited
isValid → bool
Validates the integrity of this TAI data.
no setterinherited
keys → Iterable<String>
The keys of this Map.
no setterinherited
length → int
The number of key/value pairs in the map.
no setterinherited
properties → Map?
Gets all properties stored in this TAI.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
time → DateTime?
Signature time from properties (data)
no setter
values → Iterable
The values of this Map.
no setterinherited

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<String, dynamic>
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
getProperty(String name) → dynamic
Retrieves a specific property value by name.
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
setProperty(String name, Object? value) → void
Updates or adds a property (resets signature).
inherited
setString(String key, Stringer? stringer) → void
inherited
sign(SignKey sKey) → Uint8List?
Signs the TAI data with the entity's private key.
inherited
toMap() → MutableMapping
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
verify(VerifyKey metaKey) → bool
Verifies the TAI signature against the entity's public key.
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

convert(Iterable array) → List<Document>
create(String type, {String? data, TransportableData? signature}) → Document
  • Create from stored info
  • Create new empty document
    • getFactory(String type) → DocumentFactory?
    parse(Object? doc) → Document?
    revert(Iterable<Document> documents) → List<MutableMapping>
    setFactory(String type, DocumentFactory factory) → void