Interface InvitationCreateRequest

Export

InvitationCreateRequest

Hierarchy

  • InvitationCreateRequest

Properties

accept? alias? attachments? goal? goal_code? handshake_protocols? mediation_id? metadata? my_label? protocol_version? use_did? use_did_method? use_public_did?

Properties

Optional accept

accept?: string[]

List of mime type in order of preference that should be use in responding to the message

Memberof

InvitationCreateRequest

Optional alias

alias?: string

Alias for connection

Memberof

InvitationCreateRequest

Optional attachments

attachments?: AttachmentDef[]

Optional invitation attachments

Memberof

InvitationCreateRequest

Optional goal

goal?: string

A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message

Memberof

InvitationCreateRequest

Optional goal_code

goal_code?: string

A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message

Memberof

InvitationCreateRequest

Optional handshake_protocols

handshake_protocols?: string[]

Memberof

InvitationCreateRequest

Optional mediation_id

mediation_id?: string

Identifier for active mediation record to be used

Memberof

InvitationCreateRequest

Optional metadata

metadata?: {
    [key: string]: object;
}

Optional metadata to attach to the connection created with the invitation

Type declaration

  • [key: string]: object

Memberof

InvitationCreateRequest

Optional my_label

my_label?: string

Label for connection invitation

Memberof

InvitationCreateRequest

Optional protocol_version

protocol_version?: string

OOB protocol version

Memberof

InvitationCreateRequest

Optional use_did

use_did?: string

DID to use in invitation

Memberof

InvitationCreateRequest

Optional use_did_method

use_did_method?: InvitationCreateRequestUseDidMethodEnum

DID method to use in invitation

Memberof

InvitationCreateRequest

Optional use_public_did

use_public_did?: boolean

Whether to use public DID in invitation

Memberof

InvitationCreateRequest

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc