Class HaloProxy

_{Declared in packages/sdk/client/dist/types/src/packlets/proxies/halo-proxy.d.ts:24}

TODO(burdon): Public API (move comments here).

Constructors

constructor(_serviceProvider)

Returns: HaloProxy

Arguments:

_serviceProvider: ClientServicesProvider

Properties

contacts

Type: MulticastObservable<Contact[]>

device

Type: undefined | Device

devices

Type: MulticastObservable<Device[]>

identity

Type: MulticastObservable<"null" | Identity>

User identity info.

invitations

Type: MulticastObservable<CancellableInvitationObservable[]>

opened

Type: boolean

Methods

[custom]()

Returns: string

Arguments: none

acceptInvitation(invitation)

Initiates accepting invitation.

Returns: AuthenticatingInvitationObservable

Arguments:

invitation: Invitation

createIdentity([profile])

Create Identity. Then initializes profile with given display name.

Returns: Promise<Identity>

Arguments:

profile: object

createInvitation([options])

Initiates device invitation.

Returns: CancellableInvitationObservable

Arguments:

options: Partial<Invitation>

presentCredentials(options)

Present Credentials.

Returns: Promise<Presentation>

Arguments:

options: object

queryCredentials([options])

Get Halo credentials for the current user.

Returns: ObservableProvider<object, Credential[]>

Arguments:

options: object

recoverIdentity(recoveryKey)

Returns: Promise<Identity>

Arguments:

recoveryKey: Uint8Array

removeInvitation(id)

Removes device invitation.

Returns: void

Arguments:

id: string

toJSON()

Returns: object

Arguments: none

writeCredentials(credentials)

Write credentials to halo profile.

Returns: Promise<void>

Arguments:

credentials: Credential[]