Type Alias XOInvitation

An invitation shared among participants in the XO stack.

{
  "invitationIdentifier": "...",
  "templateIdentifier": "...",
  "actionIdentifier": "...",
  ...
  "commits": [
    {
      "commitIdentifier": "...",
      ...
    },
    {
      "commitIdentifier": "...",
      ...
    }
  ],
  "result": {
    "transactions": { },
    "data": { }
  }
}  ← this type

type XOInvitation = {
    actionIdentifier: XOTemplateActionIdentifier;
    commits: XOInvitationCommit[];
    createdAtTimestamp: XOInvitationTimestamp;
    invitationIdentifier: XOInvitationIdentifier;
    result?: XOInvitationResult;
    templateIdentifier: XOTemplateIdentifier;
}

Index

Properties

actionIdentifier commits createdAtTimestamp invitationIdentifier result? templateIdentifier

Properties

actionIdentifier

actionIdentifier: XOTemplateActionIdentifier

The action identifier.

commits

commits: XOInvitationCommit[]

The commits in the invitation.

createdAtTimestamp

createdAtTimestamp: XOInvitationTimestamp

The timestamp when the invitation was created.

invitationIdentifier

invitationIdentifier: XOInvitationIdentifier

The invitation identifier for the invitation.

`Optional`result

result?: XOInvitationResult

Result of the invitation process

templateIdentifier

templateIdentifier: XOTemplateIdentifier

The template identifier.