Class ServerCapabilities

Manages storing and periodically refreshing the server capabilities.

Index

Constructors

Methods

fetchCapabilities getCachedCapabilities start stop

Constructors

constructor

new ServerCapabilities(http): ServerCapabilities
Parameters
- http: MatrixHttpApi<IHttpOpts & {
  onlyData: true;
  }>
Returns ServerCapabilities
- Defined in src/serverCapabilities.ts:81

Methods

fetchCapabilities

fetchCapabilities(): Promise<Capabilities>
Fetches the latest server capabilities from the homeserver and returns them, or rejects on failure.

Returns Promise<Capabilities>
- Defined in src/serverCapabilities.ts:109

getCachedCapabilities

getCachedCapabilities(): undefined | Capabilities
Returns the cached capabilities, or undefined if none are cached.

Returns undefined | Capabilities
the current capabilities, if any.
- Defined in src/serverCapabilities.ts:101

start

start(): void
Starts periodically fetching the server capabilities.

Returns void
- Defined in src/serverCapabilities.ts:86

stop

stop(): void
Stops the service

Returns void
- Defined in src/serverCapabilities.ts:93