@umbraco-cms/backoffice
    Preparing search index...

    Class UmbDocumentConfigurationContextInternal

    A context for fetching and caching the document configuration.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Accessors

    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. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • Returns Promise<UmbDocumentConfigurationModel | null>

      A promise that resolves to the document configuration, or null if the configuration could not be fetched.

      Deprecated since v17. Use getDocumentConfiguration() instead. Will be removed in v19.

    • Get the document configuration from the server, or return the cached configuration if it has already been fetched.

      Returns Promise<UmbDocumentConfigurationModel | null>

      A promise that resolves to the document configuration, or null if the configuration could not be fetched.

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Parameters

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

      Returns void