The ConfigurationController allows setting editor session data. This data is not stored in the document and can only be used at runtime. Amongst others, the configuration store is available to the editor connectors and Javascript actions running in the editor. Methods inside this controller can be called by window.SDK.configuration.{method-name}

Hierarchy

  • ConfigurationController

Methods

  • This method returns the value for a given configuration key. If a value was not found in the configuration store this method returns an error. The key cannot be null.

    Returns

    value for a given configuration key

    Parameters

    • key: string

    Returns Promise<EditorResponse<string>>

  • This method sets, or overrides the value for a given key. Null values are not allowed for both key and value, using them will result in an error.

    Returns

    Parameters

    • key: string
    • value: string

    Returns Promise<EditorResponse<null>>

Generated using TypeDoc