Skip to main content

Class InvitationsProxy

Less than 1 minute

Class InvitationsProxy

Declared in packages/sdk/client/dist/types/src/invitations/invitations-proxy.d.ts:5

Constructors

constructor(_invitationsService, _identityService, _getInvitationContext)

Returns: InvitationsProxy

Arguments:

_invitationsService: InvitationsService

_identityService: undefined | IdentityService

_getInvitationContext: function

Properties

accepted

Type: MulticastObservable<AuthenticatingInvitation[]>

created

Type: MulticastObservable<CancellableInvitation[]>

isOpen

Type: boolean

saved

Type: MulticastObservable<Invitation[]>

@test-only

Methods

close()

Returns: Promise<void>

Arguments: none

getInvitationOptions()

Returns: Invitation

Arguments: none

join(invitation, [deviceProfile])

Returns: AuthenticatingInvitation

Arguments:

invitation: string | Invitation

deviceProfile: DeviceProfileDocument

open()

Returns: Promise<void>

Arguments: none

share([options])

Returns: CancellableInvitation

Arguments:

options: Partial<Invitation>