Class HaloProxy
HaloProxy
Class Declared in packages/sdk/client/src/halo/halo-proxy.ts:40
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<CancellableInvitation[]>
opened
Type: boolean
Methods
[custom]()
Returns: string
Arguments: none
createIdentity(profile, deviceProfile)
Create Identity. Then initializes profile with given display name.
Returns: Promise<Identity>
Arguments:
profile
: ProfileDocument
deviceProfile
: undefined | DeviceProfileDocument
join(invitation, [deviceProfile])
Initiates accepting invitation.
Returns: AuthenticatingInvitation
Arguments:
invitation
: string | Invitation
deviceProfile
: DeviceProfileDocument
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
share([options])
Initiates device invitation.
Returns: CancellableInvitation
Arguments:
options
: Partial<Invitation>
toJSON()
Returns: object
Arguments: none
updateProfile(profile)
Returns: Promise<Identity>
Arguments:
profile
: ProfileDocument
writeCredentials(credentials)
Write credentials to halo profile.
Returns: Promise<void>
Arguments:
credentials
: Credential[]