Interface ICreateClientOpts

Hierarchy

Properties

accessToken? baseUrl cryptoCallbacks? cryptoStore? deviceId? deviceToImport? fallbackICEServerAllowed? fetchFn? forceTURN? iceCandidatePoolSize? idBaseUrl? identityServer? localSfuDeviceId? localSfuUserId? localTimeoutMs? pickleKey? queryParams? roomNameGenerator? scheduler? store? supportsCallTransfer? timelineSupport? useAuthorizationHeader? useE2eForGroupCall? userId? verificationMethods?

Properties

Optional accessToken

accessToken?: string

baseUrl

baseUrl: string

Optional cryptoCallbacks

cryptoCallbacks?: ICryptoCallbacks

Optional cryptoStore

cryptoStore?: CryptoStore

A store to be used for end-to-end crypto session data. If not specified, end-to-end crypto will be disabled. The createClient helper will create a default store if needed. Calls the factory supplied to setCryptoStoreFactory if unspecified; or if no factory has been specified, uses a default implementation (indexeddb in the browser, in-memory otherwise).

Optional deviceId

deviceId?: string

A unique identifier for this device; used for tracking things like crypto keys and access tokens. If not specified, end-to-end encryption will be disabled.

Optional deviceToImport

deviceToImport?: IExportedDevice

Device data exported with "exportDevice" method that must be imported to recreate this device. Should only be useful for devices with end-to-end crypto enabled. If provided, deviceId and userId should NOT be provided at the top level (they are present in the exported data).

Optional fallbackICEServerAllowed

fallbackICEServerAllowed?: boolean

Whether to allow a fallback ICE server should be used for negotiating a WebRTC connection if the homeserver doesn't provide any servers. Defaults to false.

Optional fetchFn

fetchFn?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)

Type declaration

    • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

    • The function to invoke for HTTP requests. Most supported environments have a global fetch registered to which this will fall back.

      Parameters

      • input: RequestInfo | URL
      • Optional init: RequestInit

      Returns Promise<Response>

Optional forceTURN

forceTURN?: boolean

Whether relaying calls through a TURN server should be forced. Default false.

Optional iceCandidatePoolSize

iceCandidatePoolSize?: number

Up to this many ICE candidates will be gathered when an incoming call arrives. Gathering does not send data to the caller, but will communicate with the configured TURN server. Default 0.

Optional idBaseUrl

idBaseUrl?: string

Optional identityServer

identityServer?: IIdentityServerProvider

Identity server provider to retrieve the user's access token when accessing the identity server. See also https://github.com/vector-im/element-web/issues/10615 which seeks to replace the previous approach of manual access tokens params with this callback throughout the SDK.

Optional localSfuDeviceId

localSfuDeviceId?: string

The device ID for the local SFU to use for group calling, if any

Optional localSfuUserId

localSfuUserId?: string

The user ID for the local SFU to use for group calling, if any

Optional localTimeoutMs

localTimeoutMs?: number

The default maximum amount of time to wait before timing out HTTP requests. If not specified, there is no timeout.

Optional pickleKey

pickleKey?: string

Key used to pickle olm objects or other sensitive data.

Optional queryParams

queryParams?: Record<string, string>

Extra query parameters to append to all requests with this client. Useful for application services which require ?user_id=.

Optional roomNameGenerator

roomNameGenerator?: ((roomId: string, state: RoomNameState) => null | string)

Type declaration

    • (roomId: string, state: RoomNameState): null | string

    • Method to generate room names for empty rooms and rooms names based on membership. Defaults to a built-in English handler with basic pluralisation.

      Parameters

      Returns null | string

Optional scheduler

scheduler?: MatrixScheduler<ISendEventResponse>

The scheduler to use. If not specified, this client will not retry requests on failure. This client will supply its own processing function to setProcessFunction.

Optional store

store?: IStore

The data store used for sync data from the homeserver. If not specified, this client will not store any HTTP responses. The createClient helper will create a default store if needed.

Optional supportsCallTransfer

supportsCallTransfer?: boolean

True to advertise support for call transfers to other parties on Matrix calls. Default false.

Optional timelineSupport

timelineSupport?: boolean

Set to true to enable improved timeline support, see getEventTimeline. It is disabled by default for compatibility with older clients - in particular to maintain support for back-paginating the live timeline after a '/sync' result with a gap.

Optional useAuthorizationHeader

useAuthorizationHeader?: boolean

Set to true to use Authorization header instead of query param to send the access token to the server.

Default false.

Optional useE2eForGroupCall

useE2eForGroupCall?: boolean

If true, to-device signalling for group calls will be encrypted with Olm. Default: true.

Optional userId

userId?: string

Optional verificationMethods

verificationMethods?: string[]

Settings

Member Visibility

Theme

Generated using TypeDoc