Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InvitationService

Hierarchy

  • Service<InvitationApi>
    • InvitationService

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected environment

environment: Environment

Protected keystoreAPIFactory

keystoreAPIFactory: KeystoreAPIFactory

Protected logger

logger: IFullLogger

Protected vaultAPIFactory

vaultAPIFactory: VaultAPIFactory

Methods

accept

  • Create a Connection from an Invitation token.

    Parameters

    • credentials: IVaultToken & IKeystoreToken & IKEK & IDEK
    • name: string
    • invitationToken: string

      From an existing Invitation request. Throws an exception if it does not exist.

    • Optional keypairId: string

      Use this public key in the new Connection. This is a Keystore Keypair.id (not external_id). Throws an error if the key pair does not exist.

    Returns Promise<Connection>

create

  • create(credentials: IVaultToken & IKeystoreToken & IDEK & IKEK, connectionName: string, keypairId?: string, delegationIntent?: { delegateRole: string; delegationToken: string }): Promise<Invitation>

  • Create an invitation token for a Connection (exchanging public keys to share Items).

    Parameters

    • credentials: IVaultToken & IKeystoreToken & IDEK & IKEK
    • connectionName: string

      Used in the new Connection, only visible to the creating user.

    • Optional keypairId: string

      Use this public key in the new Connection. This is a Keystore Keypair.id (not external_id). Throws an error if the key pair does not exist.

    • Optional delegationIntent: { delegateRole: string; delegationToken: string }
      • delegateRole: string
      • delegationToken: string

    Returns Promise<Invitation>

getAPI

setLogger

  • setLogger(logger: Logger): void

Generated using TypeDoc