kaios-types
    Preparing search index...

    Interface SettingsLock

    dom.mozSettings.enabled

    interface SettingsLock {
        closed: boolean;
        onsettingstransactionfailure:
            | ((this: SettingsLock, ev: MozSettingsTransactionEvent) => any)
            | null;
        onsettingstransactionsuccess:
            | ((this: SettingsLock, ev: MozSettingsTransactionEvent) => any)
            | null;
        addEventListener(
            type: string,
            callback: EventListenerOrEventListenerObject | null,
            options?: boolean | AddEventListenerOptions,
        ): void;
        clear(): DOMRequest;
        dispatchEvent(event: Event): boolean;
        get(name: string): DOMRequest;
        removeEventListener(
            type: string,
            callback: EventListenerOrEventListenerObject | null,
            options?: boolean | EventListenerOptions,
        ): void;
        set(settings: Record<string, any>): DOMRequest;
    }

    Hierarchy

    • EventTarget
      • SettingsLock
    Index

    Properties

    closed onsettingstransactionfailure onsettingstransactionsuccess

    Methods

    addEventListener clear dispatchEvent get removeEventListener set

    Properties

    closed: boolean

    Whether this lock is invalid (closed).

    onsettingstransactionfailure:
        | ((this: SettingsLock, ev: MozSettingsTransactionEvent) => any)
        | null

    Event handler called when a settings transaction fails.

    onsettingstransactionsuccess:
        | ((this: SettingsLock, ev: MozSettingsTransactionEvent) => any)
        | null

    Event handler called when a settings transaction completes successfully.

    Methods

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject | null
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject | null
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Sets one or more settings.

      Parameters

      • settings: Record<string, any>

        A JSON object with name/value pairs to be set.

      Returns DOMRequest

      A DOMRequest that indicates the success or failure of the operation.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods