Skip to main content

OutOfBandInvitation

@hyperledger/identus-sdk v8.1.3


@hyperledger/identus-sdk / plugins/internal/didcomm / OutOfBandInvitation

Class: OutOfBandInvitation

Defined in: packages/lib/sdk/src/plugins/internal/didcomm/protocols/invitation/OutOfBandInvitation.ts:12

Constructors​

Constructor​

new OutOfBandInvitation(body: OutOfBandInvitationBody, from: string, id?: string, attachments?: AttachmentDescriptor[], expiration?: number | null): OutOfBandInvitation

Defined in: packages/lib/sdk/src/plugins/internal/didcomm/protocols/invitation/OutOfBandInvitation.ts:17

Parameters​

ParameterTypeDefault value
bodyOutOfBandInvitationBodyundefined
fromstringundefined
idstring...
attachmentsAttachmentDescriptor[][]
expirationnumber | nullnull

Returns​

OutOfBandInvitation

Properties​

PropertyModifierTypeDefault valueDefined in
attachmentspublicAttachmentDescriptor[][]packages/lib/sdk/src/plugins/internal/didcomm/protocols/invitation/OutOfBandInvitation.ts:21
bodypublicOutOfBandInvitationBodyundefinedpackages/lib/sdk/src/plugins/internal/didcomm/protocols/invitation/OutOfBandInvitation.ts:18
expirationpublicnumber | nullnullpackages/lib/sdk/src/plugins/internal/didcomm/protocols/invitation/OutOfBandInvitation.ts:22
frompublicstringundefinedpackages/lib/sdk/src/plugins/internal/didcomm/protocols/invitation/OutOfBandInvitation.ts:19
idpublicstringundefinedpackages/lib/sdk/src/plugins/internal/didcomm/protocols/invitation/OutOfBandInvitation.ts:20
piuripublic"https://didcomm.org/out-of-band/2.0/invitation"ProtocolIds.OOBInvitationpackages/lib/sdk/src/plugins/internal/didcomm/protocols/invitation/OutOfBandInvitation.ts:15
typepublic"https://didcomm.org/out-of-band/2.0/invitation"ProtocolIds.OOBInvitationpackages/lib/sdk/src/plugins/internal/didcomm/protocols/invitation/OutOfBandInvitation.ts:13

Accessors​

isExpired​

Get Signature​

get isExpired(): boolean

Defined in: packages/lib/sdk/src/plugins/internal/didcomm/protocols/invitation/OutOfBandInvitation.ts:25

Returns​

boolean

Methods​

parsePrismOnboardingInvitationFromJson()​

static parsePrismOnboardingInvitationFromJson(json: string): PrismOnboardingInvitation

Defined in: packages/lib/sdk/src/plugins/internal/didcomm/protocols/invitation/OutOfBandInvitation.ts:39

Parameters​

ParameterTypeDescription
jsonstring-

Returns​

PrismOnboardingInvitation

Deprecated​