Skip to main content

Class HaloProxy

About 1 min

Class HaloProxy

Declared in packages/sdk/client/src/halo/halo-proxy.ts:40open in new window

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

Constructors

constructor(_serviceProvider)open in new window

Returns: HaloProxy

Arguments:

_serviceProvider: ClientServicesProvider

Properties

contactsopen in new window

Type: MulticastObservable<Contact[]>

deviceopen in new window

Type: undefined | Device

devicesopen in new window

Type: MulticastObservable<Device[]>

identityopen in new window

Type: MulticastObservable<"null" | Identity>

User identity info.

invitationsopen in new window

Type: MulticastObservable<CancellableInvitation[]>

openedopen in new window

Type: boolean

Methods

[custom]()open in new window

Returns: string

Arguments: none

createIdentity(profile, deviceProfile)open in new window

Create Identity. Then initializes profile with given display name.

Returns: Promise<Identity>

Arguments:

profile: ProfileDocument

deviceProfile: undefined | DeviceProfileDocument

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

Initiates accepting invitation.

Returns: AuthenticatingInvitation

Arguments:

invitation: string | Invitation

deviceProfile: DeviceProfileDocument

presentCredentials(options)open in new window

Present Credentials.

Returns: Promise<Presentation>

Arguments:

options: object

queryCredentials(options)open in new window

Get Halo credentials for the current user.

Returns: ObservableProvider<object, Credential[]>

Arguments:

options: object

recoverIdentity(recoveryKey)open in new window

Returns: Promise<Identity>

Arguments:

recoveryKey: Uint8Array

share([options])open in new window

Initiates device invitation.

Returns: CancellableInvitation

Arguments:

options: Partial<Invitation>

toJSON()open in new window

Returns: object

Arguments: none

updateProfile(profile)open in new window

Returns: Promise<Identity>

Arguments:

profile: ProfileDocument

writeCredentials(credentials)open in new window

Write credentials to halo profile.

Returns: Promise<void>

Arguments:

credentials: Credential[]