Skip to main content

Class InvitationsProxy

Less than 1 minute

Class InvitationsProxy

Declared in packages/sdk/client/src/invitations/invitations-proxy.ts:48open in new window

Constructors

constructor(_invitationsService, _identityService, _getInvitationContext)open in new window

Returns: InvitationsProxy

Arguments:

_invitationsService: InvitationsService

_identityService: undefined | IdentityService

_getInvitationContext: function

Properties

acceptedopen in new window

Type: MulticastObservable<AuthenticatingInvitation[]>

createdopen in new window

Type: MulticastObservable<CancellableInvitation[]>

isOpenopen in new window

Type: boolean

savedopen in new window

Type: MulticastObservable<Invitation[]>

@test-only

Methods

close()open in new window

Returns: Promise<void>

Arguments: none

getInvitationOptions()open in new window

Returns: Invitation

Arguments: none

join(invitation, [deviceProfile])open in new window

Returns: AuthenticatingInvitation

Arguments:

invitation: string | Invitation

deviceProfile: DeviceProfileDocument

open()open in new window

Returns: Promise<void>

Arguments: none

share([options])open in new window

Returns: CancellableInvitation

Arguments:

options: Partial<Invitation>