tbDEX SDK Documentation/tbdex.sdk.protocol.models/MessageMetadata

MessageMetadata

class MessageMetadata(val from: String, val to: String, val kind: MessageKind, val id: String, val exchangeId: String, val externalId: String? = null, val createdAt: OffsetDateTime, val protocol: String) : Metadata

A data class representing the metadata present on every Message

Constructors

MessageMetadata

constructor(from: String, to: String, kind: MessageKind, id: String, exchangeId: String, externalId: String? = null, createdAt: OffsetDateTime, protocol: String)

Properties

createdAt

val createdAt: OffsetDateTime

ISO 8601 timestamp

exchangeId

val exchangeId: String

ID for an "exchange" of messages between Alice <-> PFI. Set by the first message in an exchange

externalId

val externalId: String? = null

Arbitrary ID for the caller to associate with the message. Different messages in the same exchange can have different IDs

from

val from: String

The sender's DID

val id: String

The message's ID

kind

val kind: MessageKind

e.g. rfq, quote etc. This defines the data property's type

protocol

val protocol: String

Version of the protocol in use (x.x format). The protocol version must remain consistent across messages in a given exchange. Messages sharing the same exchangeId MUST also have the same protocol version. Protocol versions are tracked under https://github.com/TBD54566975/tbdex

val to: String

the recipient's DID