Class ServerCapabilities

Manages storing and periodically refreshing the server capabilities.

Index

Constructors

Methods

clearTimeouts fetchCapabilities getCachedCapabilities poll start stop

Constructors

constructor

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

Properties

`Private` `Optional` capabilities

capabilities?: Capabilities

`Private` `Readonly` http

http: MatrixHttpApi<IHttpOpts & {
onlyData: true;
}>

`Private` `Optional` refreshTimeout

refreshTimeout?: number

`Private` `Optional` retryTimeout

retryTimeout?: number

Methods

`Private` clearTimeouts

clearTimeouts(): void
Returns void
- Defined in src/serverCapabilities.ts:126

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:106

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:98

`Private` poll

poll(): Promise<void>
Returns Promise<void>
- Defined in src/serverCapabilities.ts:112

start

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

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

stop

stop(): void
Stops the service

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