Envelope

interface Envelope
Content copied to clipboard

Types

Companion
Link copied to clipboard
common
object Companion
Content copied to clipboard

Properties

data
Link copied to clipboard
common
abstract val data: Binary?
Content copied to clipboard
meta
Link copied to clipboard
common
abstract val meta: Meta
Content copied to clipboard

Inheritors

SimpleEnvelope
Link copied to clipboard
ProxyEnvelope
Link copied to clipboard
EnvelopeBuilder
Link copied to clipboard

Extensions

contentEquals
Link copied to clipboard
common
fun Envelope.contentEquals(other: Envelope): Boolean
Content copied to clipboard
dataEquals
Link copied to clipboard
common
fun Envelope.dataEquals(other: Envelope): Boolean
Content copied to clipboard
dataID
Link copied to clipboard
common
val Envelope.dataID: String?
Content copied to clipboard

An optional unique identifier that is used for data comparison. Data without identifier could not be compared to another data.

dataType
Link copied to clipboard
common
val Envelope.dataType: String?
Content copied to clipboard

The type of data encoding

description
Link copied to clipboard
common
val Envelope.description: String?
Content copied to clipboard

Textual user friendly description

metaEquals
Link copied to clipboard
common
fun Envelope.metaEquals(other: Envelope): Boolean
Content copied to clipboard
parts
Link copied to clipboard
common
fun Envelope.parts(): EnvelopeParts
Content copied to clipboard
type
Link copied to clipboard
common
val Envelope.type: String?
Content copied to clipboard

The purpose of the envelope

withMetaLayers
Link copied to clipboard
common
fun Envelope.withMetaLayers(vararg layers: Meta): Envelope
Content copied to clipboard

Add few meta layers to existing envelope (on top of existing meta)