kernl API
    Preparing search index...

    Interface HandlerDefaults

    The user's handler choices: what this device remembers, and what their account published.

    interface HandlerDefaults {
        changes$: Observable<string>;
        sync: boolean;
        all(): Readonly<Record<string, string>>;
        get(archetype: string): string | undefined;
        load(): Promise<void>;
        set(archetype: string, catalogId: string | undefined): Promise<void>;
        setSync(on: boolean): void;
        synced(archetype: string): HandlerPreferences | undefined;
    }
    Index
    changes$ sync
    all get load set setSync synced
    changes$: Observable<string>

    The archetype whose defaults or published preferences just changed.

    sync: boolean

    Whether choices are published to the account. Off until the user turns it on.

    • Every default this device remembers, by archetype.

      Returns Readonly<Record<string, string>>

    • This device's default for an archetype.

      Parameters

      • archetype: string

      Returns string | undefined

    • Read the signed-in account's published preferences from its relays.

      Returns Promise<void>

    • Remember a default, or forget it with undefined. With sync on and an account that can sign, the choice is also published as the user's handler preference for the archetype.

      Parameters

      • archetype: string
      • catalogId: string | undefined

      Returns Promise<void>

    • Parameters

      • on: boolean

      Returns void

    • The account's published preferences for an archetype, once loaded.

      Parameters

      • archetype: string

      Returns HandlerPreferences | undefined

    Settings
    Member Visibility

    On This Page
    Properties
    Methods