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

    This mixin enables a web-component to host controllers. This enables controllers to be added to the life cycle of this element.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Accessors

    Methods

    • Internal

      Interceptor which checks responses for 401 errors and lets the UmbAuthContext know the user is timed out.

      Parameters

      • client: Client

        The OpenAPI client to add the interceptor to. It can be any client supporting Response and Request interceptors.

      Returns void

    • Internal

      Interceptor which checks responses for 500 errors and displays them as a notification if any.

      Parameters

      • client: Client

        The OpenAPI client to add the interceptor to. It can be any client supporting Response and Request interceptors.

      Returns void

    • 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: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • Internal

      Interceptor which checks responses for 403 errors and displays them as a notification.

      Parameters

      • client: Client

        The OpenAPI client to add the interceptor to. It can be any client supporting Response and Request interceptors.

      Returns void

    • Internal

      Interceptor which checks responses for the Umb-Generated-Resource header and replaces the value into the response body.

      Parameters

      • client: Client

        The OpenAPI client to add the interceptor to. It can be any client supporting Response and Request interceptors.

      Returns void

    • Internal

      Interceptor which checks responses for the umb-notifications header and displays them as a notification if any. Removes the umb-notifications from the headers.

      Parameters

      • client: Client

        The OpenAPI client to add the interceptor to. It can be any client supporting Response and Request interceptors.

      Returns void

    • Binds the default interceptors to the client. This includes the auth response interceptor, the error interceptor and the umb-notifications interceptor.

      Parameters

      • client: Client

        The OpenAPI client to add the interceptor to. It can be any client supporting Response and Request interceptors.

      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

    • Internal

      Listen for authorization signal to retry GET-requests that received a 401 Unauthorized response. This will retry all pending requests that received a 401 Unauthorized response after re-authentication. It will also notify the user about non-GET requests that received a 401 Unauthorized response.

      Returns void

    • 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: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void