Interface for managing account data on the server.

A subset of MatrixClient.

interface AccountDataClient {
    getAccountDataFromServer: (<T>(eventType: string) => Promise<null | T>);
    setAccountData: ((eventType: string, content: any) => Promise<{}>);
    addListener<T>(event: T, listener: Listener<AccountData, ClientEventHandlerMap, T>): this;
    emit<T>(event: T, ...args: Parameters<ClientEventHandlerMap[T]>): boolean;
    emit<T>(event: T, ...args: Parameters<ClientEventHandlerMap[T]>): boolean;
    emitPromised<T>(event: T, ...args: Parameters<ClientEventHandlerMap[T]>): Promise<boolean>;
    emitPromised<T>(event: T, ...args: Parameters<ClientEventHandlerMap[T]>): Promise<boolean>;
    listenerCount(event: EventEmitterEvents | AccountData): number;
    listeners(event: EventEmitterEvents | AccountData): Function[];
    off<T>(event: T, listener: Listener<AccountData, ClientEventHandlerMap, T>): this;
    on<T>(event: T, listener: Listener<AccountData, ClientEventHandlerMap, T>): this;
    once<T>(event: T, listener: Listener<AccountData, ClientEventHandlerMap, T>): this;
    prependListener<T>(event: T, listener: Listener<AccountData, ClientEventHandlerMap, T>): this;
    prependOnceListener<T>(event: T, listener: Listener<AccountData, ClientEventHandlerMap, T>): this;
    rawListeners(event: EventEmitterEvents | AccountData): Function[];
    removeAllListeners(event?: EventEmitterEvents | AccountData): this;
    removeListener<T>(event: T, listener: Listener<AccountData, ClientEventHandlerMap, T>): this;
}

Hierarchy (view full)

Properties

getAccountDataFromServer: (<T>(eventType: string) => Promise<null | T>)

Get account data event of given type for the current user. This variant gets account data directly from the homeserver if the local store is not ready, which can be useful very early in startup before the initial sync.

Type declaration

    • <T>(eventType): Promise<null | T>
    • Type Parameters

      Parameters

      • eventType: string

        The type of account data

      Returns Promise<null | T>

      The contents of the given account data event, or null if the event is not found

setAccountData: ((eventType: string, content: any) => Promise<{}>)

Set account data event for the current user, with retries

Type declaration

    • (eventType, content): Promise<{}>
    • Parameters

      • eventType: string

        The type of account data

      • content: any

        the content object to be set

      Returns Promise<{}>

      an empty object

Methods

  • 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

    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

    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

    Returns this

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