TransportableFile class abstract interface

Portable Network File (PNF) - transportable file with metadata and encryption support.

Extends TransportableResource to represent files with additional metadata (filename, URL, encryption key) for network transmission.

Supported formats (extends TransportableResource): 2. Data URI format: "data:image/png;base64,{BASE64_ENCODE}" 3. Structured JSON object (with metadata and encryption):

{
  "data"     : "...",         // Base64-encoded file content
  "filename" : "avatar.png",
  "URL"      : "http://...",  // CDN download URL (alternative to inline data)
  "key"      : {              // Symmetric encryption key (for encrypted content)
    "algorithm" : "AES",      // Encryption algorithm (e.g., "AES", "DES")
    "data"      : "{BASE64_ENCODE}"
  }
}

Implemented types

• Mapper
• TransportableResource

Implementers

• PortableNetworkFile

Available extensions

• MapTypeCastExtension

Properties

data ↔ TransportableData?

Binary file data (encoded as TransportableData).

getter/setter pair

entries → Iterable<MapEntry>

The map entries of this Map.

no setter, inherited

filename ↔ String?

Original filename of the file (e.g., "avatar.png").

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

The keys of this Map.

no setter, inherited

length → int

The number of key/value pairs in the map.

no setter, inherited

password ↔ DecryptKey?

Decryption key for encrypted file content from CDN.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

url ↔ Uri?

Remote URL to download the file (typically from CDN).

getter/setter pair

values → Iterable

The values of this Map.

no setter, inherited

Methods

addAll(Map other) → void

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

inherited

addEntries(Iterable<MapEntry> newEntries) → void

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

inherited

asMap() → Map<K, V>

Available on Map<K, V>, provided by the MapTypeCastExtension extension

asMapping() → Map<K, V>

Available on Map<K, V>, provided by the MapTypeCastExtension extension

asMutableMapping() → Map<K, V>

Available on Map<K, V>, provided by the MapTypeCastExtension extension

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

Copy inner map.

inherited

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

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

inherited

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

inherited

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

inherited

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

inherited

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

inherited

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

Get string value for key, if value is None, return the default value.

inherited

map<K2, V2>(MapEntry<K2, V2> convert(dynamic 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(dynamic 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(dynamic key, dynamic value)) → void

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

inherited

serialize() → Object

Serializes the PNF to a transportable format.

override

setDateTime(dynamic key, DateTime? time) → void

inherited

setMap(dynamic key, Mapper? mapper) → void

inherited

setString(dynamic key, Stringer? stringer) → void

inherited

toMap() → MutableMapping

Converts the PNF to a structured Map (format 3).

override

toString() → String

Returns string representation of the PNF.

override

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

Updates the value for the provided key.

inherited

updateAll(dynamic update(dynamic 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 []=(dynamic key, dynamic value) → void

Associates the key with the given value.

inherited

Static Methods

create(TransportableData? data, String? filename, Uri? url, DecryptKey? password) → TransportableFile

createFromData(TransportableData data, String? filename) → TransportableFile

Create from file data

createFromURL(Uri url, DecryptKey? password) → TransportableFile

Create from remote URL

getFactory() → TransportableFileFactory?

parse(Object? pnf) → TransportableFile?

setFactory(TransportableFileFactory factory) → void