Interface IPreferencesApi

API for working with the user preferences.

interface IPreferencesApi {
    _apiId: "mendix.PreferencesApi";
    addEventListener<K>(eventType: K, listener: EventHandler<{}, K>): DisposeListener;
    getPreferences(): Promise<Preferences>;
    removeEventListener<K>(eventType: K, listener: EventHandler<{}, K>): void;
}

Hierarchy (view full)

Properties

_apiId

Methods

addEventListener getPreferences removeEventListener

Properties

_apiId

_apiId

Unique identifier for the Preferences API.

Methods

addEventListener

  • addEventListener<K>(eventType, listener): DisposeListener

  • Adds an event listener for the specified event type.

    Type Parameters

    • K extends never

    Parameters

    • eventType: K

      The type of event to listen for.

    • listener: EventHandler<{}, K>

      The event listener to add.

    Returns DisposeListener

    A function that can be called to remove the event listener.

getPreferences

  • getPreferences(): Promise<Preferences>

  • Retrieves the preferences of Studio pro.

    Returns Promise<Preferences>

    A promise that resolves with the retrieved preferences.

removeEventListener

  • removeEventListener<K>(eventType, listener): void

  • Removes an event listener for the specified event type.

    Type Parameters

    • K extends never

    Parameters

    • eventType: K

      The type of event to remove the listener from.

    • listener: EventHandler<{}, K>

      The event listener to remove.

    Returns void

Settings

On This Page

Properties
Methods