Interface ClientOptions

Internalapi

Hierarchy

  • ClientOptions

Properties

appUrl? disableDefaultEvents? enableAppSwitching? enableMetrics? iconUrl? matrixNodes? name storage

Properties

Optional appUrl

appUrl?: string

A URL to the website of the application

Optional disableDefaultEvents

disableDefaultEvents?: boolean

Disable all default Events and UI elements. If passed together with "eventHandlers", the default eventHandlers will be removed, and the ones passed by the user will be added.

Optional enableAppSwitching

enableAppSwitching?: boolean

Automatically switch between apps on Mobile Devices (Enabled by Default)

Optional enableMetrics

enableMetrics?: boolean

Enable metrics tracking (Disabled by Default)

Optional iconUrl

iconUrl?: string

A URL to the icon of the application

Optional matrixNodes

matrixNodes?: NodeDistributions

A list of matrix nodes to connect to. If a non-empty array is passed, the default options will be overwritten. One node will be randomly selected based on the local keypair and the other nodes will be used as a fallback in case the primary node goes down.

Only provide the hostname, no https:// prefix. Eg. { [Regions.EU1]: ['matrix.example.com'] }

name

name: string

Name of the application

storage

storage: Storage

The storage that will be used by the SDK

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc