@nextcloud/files
    Preparing search index...

    Class FilesRegistryInternal

    The registry for files app. This is used to keep track of registered actions, filters, headers, etc. and to emit events when new items are registered. Allowing to keep a reactive state of the registered items in the UI without being coupled to one specific reactivity framework.

    This is an internal implementation detail and should not be used directly.

    PublicFilesRegistry - for the public API to listen to registry events.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    addEventListener: <
        T extends
            | "register:listFilter"
            | "register:action"
            | "register:listAction"
            | "register:listHeader"
            | "unregister:listFilter",
    >(
        type: T,
        listener:
            | TypedEventListenerOrEventListenerObject<FilesRegistryEvents, T>
            | null,
        options?: boolean | AddEventListenerOptions,
    ) => void

    Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    dispatchEvent: (event: Event) => boolean

    Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    To ensure type safety use dispatchTypedEvent instead.

    removeEventListener: <
        T extends
            | "register:listFilter"
            | "register:action"
            | "register:listAction"
            | "register:listHeader"
            | "unregister:listFilter",
    >(
        type: T,
        callback:
            | TypedEventListenerOrEventListenerObject<FilesRegistryEvents, T>
            | null,
        options?: boolean | EventListenerOptions,
    ) => void

    Removes the event listener in target's event listener list with the same type, callback, and options.

    Methods