Interface AccountDataClient

Interface for managing account data on the server.

A subset of MatrixClient.

Hierarchy

Properties

getAccountDataFromServer setAccountData

Methods

addListener emit listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener

Properties

getAccountDataFromServer

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

Type declaration

    • <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.

      Returns

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

      Type Parameters

      • T extends Record<string, any>

      Parameters

      • eventType: string

        The type of account data

      Returns Promise<null | T>

setAccountData

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

Type declaration

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

    • Set account data event for the current user, with retries

      Returns

      an empty object

      Parameters

      • eventType: string

        The type of account data

      • content: any

        the content object to be set

      Returns Promise<{}>

Methods

addListener

emit

listenerCount

listeners

off

on

once

prependListener

prependOnceListener

rawListeners

removeAllListeners

removeListener

Settings

Member Visibility

Theme

Generated using TypeDoc