aries / net.globalid.aries.decorators.attachment / AttachmentDescriptor

AttachmentDescriptor

@JsonClass(true) data class AttachmentDescriptor

Attachment descriptors can be used to exchange arbitrary data with DIDComm messages. Note that an attachment decorator uses the "~attach" key and its value is a list of descriptors. But protocols can also use descriptors as values for other keys, e.g. "presentations~attach".

Constructors

<init>

Attachment descriptors can be used to exchange arbitrary data with DIDComm messages. Note that an attachment decorator uses the "~attach" key and its value is a list of descriptors. But protocols can also use descriptors as values for other keys, e.g. "presentations~attach".

AttachmentDescriptor(id: String?, description: String? = null, fileName: String? = null, mimeType: String? = null, lastModifiedTime: String? = null, byteCount: Long? = null, data: AttachmentDescriptorData)

Properties

byteCount

is relevant if attachment data is included by reference (needs to be fetched)

val byteCount: Long?

data

is a JSON object, check AttachmentDecoratorData.

val data: AttachmentDescriptorData

description

is a human-readable description of the content.

val description: String?

fileName

is a hint for the name of the file if the attachment is written to a file. If mimeType is null, the extension of the fileName can be used to infer the type.

val fileName: String?

id

uniquely identifies attached content WITHIN the scope of a given message.

val id: String?

lastModifiedTime

is a hint about when the attachment data was last modified.

val lastModifiedTime: String?

mimeType

is the mime type of the attached content. Optional but recommended

val mimeType: String?