Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AllocatePartyRequest

Example:

{
    partyIdHint: 'alice',
    displayName: 'Alice'
}

Hierarchy

  • AllocatePartyRequest

Index

Properties

Optional displayName

displayName: undefined | string

Human readable name of the party to be added to the participant.

It doesn't have to be unique.

Optional

Optional partyIdHint

partyIdHint: undefined | string

A hint to the backing participant what party id to allocate.

It can be ignored.

Must be a valid party identifier.

Optional

Generated using TypeDoc