Optional accessOptional cryptoOptional cryptoOptional deviceA 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 deviceDevice 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 fallbackICEServerWhether 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 fetchThe function to invoke for HTTP requests.
Most supported environments have a global fetch registered to which this will fall back.
Optional init: RequestInitOptional forceTURNWhether relaying calls through a TURN server should be forced. Default false.
Optional iceUp 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 idOptional identityIdentity 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 localThe device ID for the local SFU to use for group calling, if any
Optional localThe user ID for the local SFU to use for group calling, if any
Optional localThe default maximum amount of time to wait before timing out HTTP requests. If not specified, there is no timeout.
Optional pickleKey used to pickle olm objects or other sensitive data.
Optional queryExtra query parameters to append
to all requests with this client. Useful for application services which require
?user_id=.
Optional roomMethod to generate room names for empty rooms and rooms names based on membership. Defaults to a built-in English handler with basic pluralisation.
Optional schedulerThe 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 storeThe 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 supportsTrue to advertise support for call transfers to other parties on Matrix calls. Default false.
Optional timelineSet 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 useSet to true to use Authorization header instead of query param to send the access token to the server.
Default false.
Optional useIf true, to-device signalling for group calls will be encrypted with Olm. Default: true.
Optional userOptional usingWhether to allow sending messages to encrypted rooms when encryption is not available internally within this SDK. This is useful if you are using an external E2E proxy, for example. Defaults to false.
Optional verificationGenerated using TypeDoc
A store to be used for end-to-end crypto session data. If not specified, end-to-end crypto will be disabled. The
createClienthelper 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).