@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 inbox(): HaloInbox;
        get invitations(): MulticastObservable<CancellableInvitationObservable[]>;
        createIdentity(
            options?: ProfileDocument,
            deviceProfile?: DeviceProfileDocument,
        ): Promise<Identity>;
        deleteIdentity(): Promise<void>;
        join(
            invitation: Invitation,
            deviceProfile?: DeviceProfileDocument,
        ): AuthenticatingInvitationObservable;
        migrateIdentityRoot(): Promise<string>;
        presentCredentials(
            options: { ids: PublicKey[]; nonce?: Uint8Array<ArrayBufferLike> },
        ): Promise<Presentation>;
        queryCredentials(
            options?: { ids?: PublicKey[]; type?: string },
        ): Credential[];
        recoverIdentity(args: RecoverIdentityArgs): Promise<Identity>;
        share(options?: Partial<Invitation>): CancellableInvitationObservable;
        updateProfile(profile: ProfileDocument): Promise<Identity>;
        writeCredentials(credentials: Credential[]): Promise<void>;
    }
    Index

    Accessors

    contacts credentials device devices identity inbox invitations

    Methods

    createIdentity deleteIdentity join migrateIdentityRoot presentCredentials queryCredentials recoverIdentity share updateProfile writeCredentials

    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>

    • get inbox(): HaloInbox

      Returns HaloInbox

    Methods

    • Parameters

      • Optionaloptions: ProfileDocument
      • OptionaldeviceProfile: DeviceProfileDocument

      Returns Promise<Identity>

    • Closes and deletes every space and the identity itself, then wipes the storage they left behind (automerge documents, hypercore feeds, the feed store, the index tables and the keyring). The client stays open, so createIdentity may be called straight afterwards.

      Returns Promise<void>

    • Has EDGE move the identity's credentials off its HALO control feed onto a space root document, and adopts that root on this device. Other devices of the identity adopt the same root when they next open. Idempotent; resolves to the root URL, which identity.haloSpaceRootUrl then reports.

      Returns Promise<string>

    • Parameters

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

      Returns Promise<Presentation>

    • Parameters

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

      Returns Credential[]

    • Parameters

      • args: RecoverIdentityArgs

      Returns Promise<Identity>

    • Parameters

      • profile: ProfileDocument

      Returns Promise<Identity>

    • Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods