Class InvitationsProxy

Implements

Invitations

Index

Constructors

Accessors

accepted created isOpen saved

Methods

close getInvitationOptions join open share

Constructors

constructor

new InvitationsProxy(
    _invitationsService: InvitationsService,
    _identityService: undefined | IdentityService,
    _getInvitationContext: () => Partial<Invitation> & Pick<Invitation, "kind">,
): InvitationsProxy
Parameters
- _invitationsService: InvitationsService
- _identityService: undefined | IdentityService
- _getInvitationContext: () => Partial<Invitation> & Pick<Invitation, "kind">
Returns InvitationsProxy
- Defined in packages/sdk/client/dist/types/src/invitations/invitations-proxy.d.ts:19

Accessors

accepted

get accepted(): MulticastObservable<AuthenticatingInvitationObservable[]>
Returns MulticastObservable<AuthenticatingInvitationObservable[]>
Implementation of Invitations.accepted
- Defined in packages/sdk/client/dist/types/src/invitations/invitations-proxy.d.ts:21

created

get created(): MulticastObservable<CancellableInvitationObservable[]>
Returns MulticastObservable<CancellableInvitationObservable[]>
Implementation of Invitations.created
- Defined in packages/sdk/client/dist/types/src/invitations/invitations-proxy.d.ts:20

isOpen

get isOpen(): boolean
Returns boolean
- Defined in packages/sdk/client/dist/types/src/invitations/invitations-proxy.d.ts:26

saved

get saved(): MulticastObservable<Invitation[]>
@test-only

Returns MulticastObservable<Invitation[]>
- Defined in packages/sdk/client/dist/types/src/invitations/invitations-proxy.d.ts:25

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in packages/sdk/client/dist/types/src/invitations/invitations-proxy.d.ts:28

getInvitationOptions

getInvitationOptions(): Invitation
Returns Invitation
- Defined in packages/sdk/client/dist/types/src/invitations/invitations-proxy.d.ts:29

join

join(
invitation: string | Invitation,
deviceProfile?: DeviceProfileDocument,
): AuthenticatingInvitationObservable
Parameters
- invitation: string | Invitation
- OptionaldeviceProfile: DeviceProfileDocument
Returns AuthenticatingInvitationObservable
Implementation of Invitations.join
- Defined in packages/sdk/client/dist/types/src/invitations/invitations-proxy.d.ts:31

open

open(): Promise<void>
Returns Promise<void>
- Defined in packages/sdk/client/dist/types/src/invitations/invitations-proxy.d.ts:27

share(options?: Partial<Invitation>): CancellableInvitationObservable
Parameters
- Optionaloptions: Partial<Invitation>
Returns CancellableInvitationObservable
Implementation of Invitations.share
- Defined in packages/sdk/client/dist/types/src/invitations/invitations-proxy.d.ts:30