@dxos/client
    Preparing search index...

    Interface Halo

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

    interface Halo {
        get contacts(): MulticastObservable<Contact[]>;
        get credentials(): MulticastObservable<Credential[]>;
        get device(): undefined | Device;
        get devices(): MulticastObservable<Device[]>;
        get identity(): MulticastObservable<null | Identity>;
        get invitations(): MulticastObservable<CancellableInvitationObservable[]>;
        createIdentity(
            options?: ProfileDocument,
            deviceProfile?: DeviceProfileDocument,
        ): Promise<Identity>;
        join(
            invitation: Invitation,
            deviceProfile?: DeviceProfileDocument,
        ): AuthenticatingInvitationObservable;
        presentCredentials(
            options: { ids: PublicKey[]; nonce?: Uint8Array<ArrayBufferLike> },
        ): Promise<Presentation>;
        queryCredentials(
            options?: { ids?: PublicKey[]; type?: string },
        ): Credential[];
        recoverIdentity(args: { recoveryCode: string }): Promise<Identity>;
        share(options?: Partial<Invitation>): CancellableInvitationObservable;
        updateProfile(profile: ProfileDocument): Promise<Identity>;
        writeCredentials(credentials: Credential[]): Promise<void>;
    }
    Index

    Accessors

    • get contacts(): MulticastObservable<Contact[]>

      Returns MulticastObservable<Contact[]>

    • get credentials(): MulticastObservable<Credential[]>

      Returns MulticastObservable<Credential[]>

    • get device(): undefined | Device

      Returns undefined | Device

    • get devices(): MulticastObservable<Device[]>

      Returns MulticastObservable<Device[]>

    • get identity(): MulticastObservable<null | Identity>

      Returns MulticastObservable<null | Identity>

    Methods

    • Parameters

      • Optionaloptions: ProfileDocument
      • OptionaldeviceProfile: DeviceProfileDocument

      Returns Promise<Identity>

    • Parameters

      • options: { ids: PublicKey[]; nonce?: Uint8Array<ArrayBufferLike> }

      Returns Promise<Presentation>

    • Parameters

      • Optionaloptions: { ids?: PublicKey[]; type?: string }

      Returns Credential[]

    • Parameters

      • args: { recoveryCode: string }

      Returns Promise<Identity>

    • Parameters

      • profile: ProfileDocument

      Returns Promise<Identity>

    • Parameters

      Returns Promise<void>