matrix-js-sdk
    Preparing search index...

    Class CapabilityPoller<ResponseType>Abstract

    Manages storing and periodically refreshing the server capabilities.

    Type Parameters

    • ResponseType

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    cached?: ResponseType
    http: MatrixHttpApi<IHttpOpts & { onlyData: true }>
    logger: Logger

    Methods

    • Synchronously calls each of the listeners registered for the event named event, in the order they were registered, passing the supplied arguments to each.

      Type Parameters

      • T extends "update"

      Parameters

      • event: T

        The name of the event to emit

      • ...args: Parameters<{ update: (data: ResponseType) => void }[T]>

        Arguments to pass to the listener

      Returns boolean

      true if the event had listeners, false otherwise.

    • Synchronously calls each of the listeners registered for the event named event, in the order they were registered, passing the supplied arguments to each.

      Type Parameters

      • T extends "update"

      Parameters

      • event: T

        The name of the event to emit

      • ...args: Parameters<{ update: (data: ResponseType) => void }[T]>

        Arguments to pass to the listener

      Returns boolean

      true if the event had listeners, false otherwise.

    • Adds the listener function to the end of the listeners array for the event named event.

      No checks are made to see if the listener has already been added. Multiple calls passing the same combination of event and listener will result in the listener being added, and called, multiple times.

      By default, event listeners are invoked in the order they are added. The prependListener method can be used as an alternative to add the event listener to the beginning of the listeners array.

      Type Parameters

      Parameters

      • event: T

        The name of the event.

      • listener: Listener<"update", { update: (data: ResponseType) => void }, T>

        The callback function

      Returns this

      a reference to the EventEmitter, so that calls can be chained.

    • Adds a one-time listener function for the event named event. The next time event is triggered, this listener is removed and then invoked.

      Returns a reference to the EventEmitter, so that calls can be chained.

      By default, event listeners are invoked in the order they are added. The prependOnceListener method can be used as an alternative to add the event listener to the beginning of the listeners array.

      Type Parameters

      Parameters

      • event: T

        The name of the event.

      • listener: Listener<"update", { update: (data: ResponseType) => void }, T>

        The callback function

      Returns this

      a reference to the EventEmitter, so that calls can be chained.

    • Adds the listener function to the beginning of the listeners array for the event named event.

      No checks are made to see if the listener has already been added. Multiple calls passing the same combination of event and listener will result in the listener being added, and called, multiple times.

      Type Parameters

      Parameters

      • event: T

        The name of the event.

      • listener: Listener<"update", { update: (data: ResponseType) => void }, T>

        The callback function

      Returns this

      a reference to the EventEmitter, so that calls can be chained.

    • Removes all listeners, or those of the specified event.

      It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

      Parameters

      • Optionalevent: "update" | EventEmitterEvents

        The name of the event. If undefined, all listeners everywhere are removed.

      Returns this

      a reference to the EventEmitter, so that calls can be chained.