Interface for managing account data on the server.

A subset of MatrixClient.

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

Hierarchy (View Summary)

Properties

getAccountDataFromServer: <K extends keyof AccountDataEvents>(
    eventType: K,
) => Promise<null | AccountDataEvents[K]>

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

setAccountData: <K extends keyof AccountDataEvents>(
    eventType: K,
    content: AccountDataEvents[K],
) => Promise<{}>

Set account data event for the current user, with retries

Type declaration

Methods