OptionalcallProtected OptionalcanProtectedcanProtected OptionalcheckProtected OptionalclientProtected OptionalclientProtected OptionalclientProtected OptionalclientProtectedfallbackICEServerOptionalgroupOptionalidOptionalidentityReadonlyignoredProtectedisReadonlyisOptionallivekitReadonlymatrixRTCProtectedmediaProtectednotifProtectedongoingProtectedpeekReadonlypushOptionalpushOptionalroomOptionalschedulerProtected OptionalserverProtectedsessionProtected OptionalsyncProtectedsyncedProtected OptionalsyncProtectedturnProtectedturnProtectedtxnProtected OptionalverificationStatic ReadonlyRESTORE_Access the server-side secret storage API for this client.
Get all pending delayed events for the calling user.
Note: This endpoint is unstable, and can throw an Error.
Check progress on MSC4140 for more details.
OptionalfromToken: stringSend a delayed timeline event.
Note: This endpoint is unstable, and can throw an Error.
Check progress on MSC4140 for more details.
OptionaltxnId: stringSend a delayed state event.
Note: This endpoint is unstable, and can throw an Error.
Check progress on MSC4140 for more details.
Manage a delayed event associated with the given delay_id.
Note: This endpoint is unstable, and can throw an Error.
Check progress on MSC4140 for more details.
Alias for on.
Promise which resolves: an empty object {}
Add a 3PID to your homeserver account. This API does not use an identity server, as the homeserver is expected to handle 3PID ownership validation.
A object with 3PID validation data from having called
account/3pid/<medium>/requestToken on the homeserver.
Promise which resolves: to an empty object {}
Take a result from an earlier searchRoomEvents call, and backfill results.
the results object to be updated
Promise which resolves: updated result object
Optionalreason: stringOptional.
Promise which resolves: TODO
Bind a 3PID for discovery onto an identity server via the homeserver. The identity server handles 3PID ownership validation and the homeserver records the new binding to track where all 3PIDs for the account are bound.
A object with 3PID validation data from having called
validate/<medium>/requestToken on the identity server. It should also
contain id_server and id_access_token fields as well.
Promise which resolves: to an empty object {}
ProtectedbuildConstruct a SyncApiOptions for this client, suitable for passing into the SyncApi constructor
Looks up the public Matrix ID mappings for multiple 3PIDs.
Array of arrays containing [medium, address]
The access_token field of the Identity
Server /account/register response (see registerWithIdentityServer).
Promise which resolves: Lookup results from IS.
Cancel a file upload in progress
The object returned from uploadContent
true if canceled, otherwise false
Claim one-time keys
a list of [userId, deviceId] pairs
desired key type
Optionaltimeout: numberthe time (in milliseconds) to wait for keys from remote servers
Promise which resolves: result object. Rejects: with an error response (MatrixError).
Clear any data out of the persistent stores used by the client.
Promise which resolves when the stores have been cleared.
Create an alias to room ID mapping.
The room alias to create.
The room ID to link the alias to.
Promise which resolves: an empty object {}
Creates a new call. The place*Call methods on the returned call can be used to actually place a call
The room the call is to be placed in.
the call or null if the browser doesn't support calling.
Create a new filter.
The HTTP body for the request
Promise which resolves to a Filter object.
Creates a new group call and sends the associated state event to alert other members that the room now has a group call.
The room the call is to be placed in.
OptionaldataChannelsEnabled: booleanOptionaldataChannelOptions: IGroupCallDataChannelOptionsMakes a request to /messages with the appropriate lazy loading filter set. XXX: if we do get rid of scrollback (as it's not used at the moment), we could inline this method again in paginateEventTimeline as that would then be the only call-site
Create a new room.
a list of options to pass to the /createRoom API.
Promise which resolves: {room_id: {string}}
Makes a request to /messages with the appropriate lazy loading filter set. XXX: if we do get rid of scrollback (as it's not used at the moment), we could inline this method again in paginateEventTimeline as that would then be the only call-site
the maximum amount of events the retrieve
'f' or 'b'
OptionaltimelineFilter: Filterthe timeline filter to pass
Deactivates the logged-in account. Obviously, further calls that require authorisation should fail after this method is called. The state of the MatrixClient object is not affected: it is up to the caller to either reset or destroy the MatrixClient after this method succeeds.
Optionalauth: AuthDictOptional. Auth data to supply for User-Interactive auth.
Optionalerase: booleanOptional. If set, send as erase attribute in the
JSON request body, indicating whether the account should be erased. Defaults
to false.
Promise which resolves: On success, the empty object
Deactivates a user using Synapse's administrator API. This function is implementation specific and may change as a result.
the User ID to deactivate.
the deactivate response - see Synapse docs for information.
Attempts to decrypt an event
The event to decrypt
Optionaloptions: IDecryptOptionsA decryption promise
Delete an alias to room ID mapping. This alias must be on your local server, and you must have sufficient access to do this operation.
The room alias to delete.
Promise which resolves: an empty object {}.
Delete the given device
device to delete
Optionalauth: AuthDictOptional. Auth data to supply for User-Interactive auth.
Promise which resolves: result object
Delete a property on your extended profile.
The key of the property to delete.
Delete multiple device
IDs of the devices to delete
Optionalauth: AuthDictOptional. Auth data to supply for User-Interactive auth.
Promise which resolves: result object
Promise which resolves: an empty object {}
name of room tag to be removed
Promise which resolves: to an empty object
The threepid medium (eg. 'email')
The threepid address (eg. 'bob@example.com') this must be as returned by getThreePids.
Promise which resolves: The server response on success (generally the empty JSON object)
Determine if the server supports extended profiles, as described by MSC4133.
true if supported, otherwise false
Query the server to see if it lists support for an unstable feature in the /versions response
the feature name
true if the feature is supported
Download device keys
list of users to get keys for
sync token to pass in the query request, to help the HS give the most recent results
Promise which resolves: result object. Rejects: with an error response (MatrixError).
Synchronously calls each of the listeners registered for the event named
event, in the order they were registered, passing the supplied arguments
to each.
The name of the event to emit
Arguments to pass to the listener
true if the event had listeners, false otherwise.
Synchronously calls each of the listeners registered for the event named
event, in the order they were registered, passing the supplied arguments
to each.
The name of the event to emit
Arguments to pass to the listener
true if the event had listeners, false otherwise.
Similar to emit but calls all listeners within a Promise.all and returns the promise chain
The name of the event to emit
Arguments to pass to the listener
true if the event had listeners, false otherwise.
Similar to emit but calls all listeners within a Promise.all and returns the promise chain
The name of the event to emit
Arguments to pass to the listener
true if the event had listeners, false otherwise.
Protectedencryptencrypts the event if necessary; adds the event to the queue, or sends it; marks the event as sent/unsent
returns a promise which resolves with the result of the send request
Simply sends a delayed event without encrypting it. TODO: Allow encrypted delayed events, and encrypt them properly
Properties of the delay for this event.
returns a promise which resolves with the result of the delayed send request
Fetches the latest capabilities from the homeserver, ignoring any cached versions. The newly returned version is cached.
A promise which resolves to the capabilities of the homeserver
ProtectedfetchFetches relations for a given event
the room of the event
the id of the event
the rel_type of the relations requested
OptionaleventType: null | stringthe event type of the relations requested
options with optional values for the request.
the response, with chunk, prev_batch and, next_batch.
True to delete the room from the store on success. Default: true.
Promise which resolves: {} an empty object.
Generates a random string suitable for use as a client secret. This method is experimental and may change.
A new client secret
Get the access token associated with this account.
The access_token or null
Get account data event of given type for the current user.
The event type
The contents of the given account data event
Get account data event of given type for the current user. This variant gets account data directly from the homeserver if the local store is not ready, which can be useful very early in startup before the initial sync.
The event type
Promise which resolves: The contents of the given account data event.
ExperimentalGet the OIDC issuer responsible for authentication on this server, if any
Resolves: A promise of an object containing the OIDC issuer if configured
ExperimentalDiscover and validate delegated auth configuration
validated authentication metadata and optionally signing keys
Gets the cached capabilities of the homeserver. If none have been fetched yet, return undefined.
The capabilities of the homeserver
Get the callback set via setCanResetTimelineCallback.
The callback or null
Gets the cached capabilities of the homeserver, returning cached ones if available. If there are no cached capabilities and none can be fetched, throw an exception.
Promise resolving with The capabilities of the homeserver
The URL to redirect to after the HS authenticates with CAS.
The HS URL to hit to begin the CAS login process.
Access the crypto API for this client.
If end-to-end encryption has been enabled for this client (via initRustCrypto),
returns an object giving access to the crypto API. Otherwise, returns undefined.
Get a list of all file uploads in progress
Array of objects representing current uploads. Currently in progress is element 0. Keys:
Get the device ID of this client
device ID
Get the domain for this client's MXID
Domain of this MXID
Optionaloptions: MapperOptsGet an EventTimeline for the given event
If the EventTimelineSet object already has the given event in its store, the corresponding timeline will be returned. Otherwise, a /context request is made, and used to construct an EventTimeline. If the event does not belong to this EventTimelineSet then undefined will be returned.
The timelineSet to look for the event in, must be bound to a room
The ID of the event to look for
Promise which resolves: EventTimeline including the given event
Fetch a specific key from the user's extended profile.
The user ID to fetch the profile of.
The key of the property to fetch.
The property value.
Get the fallback URL to use for unknown interactive-auth stages.
the type of stage being attempted
the auth session ID provided by the homeserver
HS URL to hit to for the fallback interface
Get an existing group call for the provided room.
The group call or null if it doesn't already exist.
Get the Homeserver URL of this client
Homeserver URL of this client
Get account info from the identity server. This is useful as a neutral check to verify that other APIs are likely to approve access by testing that the token is valid, terms have been agreed, etc.
The access_token field of the Identity
Server /account/register response (see registerWithIdentityServer).
Promise which resolves: an object with account info.
Gets the V2 hashing information from the identity server. Primarily useful for lookups.
The access token for the identity server.
The hashing information for the identity server.
Get the identity server URL of this client
whether or not to strip the protocol from the URL
Identity server URL of this client
Gets the users that are ignored by this client
The array of users that are ignored (empty if none)
Retrieve membership info. for a room.
ID of the room to get membership for
Promise which resolves: A list of currently joined users and their profile data.
Promise which resolves: A list of the user's current rooms
Ask the server for a list of users who have changed their device lists between a pair of sync tokens
Promise which resolves: result object. Rejects: with an error response (MatrixError).
Get an EventTimeline for the latest events in the room. This will just
call /messages to get the latest message in the room, then use
client.getEventTimeline(...) to construct a new timeline from it.
The timelineSet to find or add the timeline to
Promise which resolves: EventTimeline timeline with the latest events in the room
Gets the local aliases for the room. Note: this includes all local aliases, unlike the curated list from the m.room.canonical_alias state event.
The room ID to get local aliases for.
Promise which resolves: an object with an aliases property, containing an array of local aliases
Get the config for the media repository.
If true, the caller supports authenticated media and wants an authentication-required URL. Note that server support for authenticated media will not be checked - it is the caller's responsibility to do so before calling this function.
Promise which resolves with an object containing the config.
Return the global notification EventTimelineSet, if any
the globl notification EventTimelineSet
Gets a bearer token from the homeserver that the user can present to a third party in order to prove their ownership of the Matrix account they are logged into.
Promise which resolves: Token object
The user to get presence for
Promise which resolves: The presence state for this user.
Optionalinfo: stringThe kind of info to retrieve (e.g. 'displayname', 'avatar_url').
Promise which resolves: TODO
Obtain a dict of actions which should be performed for this event according to the push rules for this user. Caches the dict on the event.
The event to get push actions for.
forces to recalculate actions for an event Useful when an event just got decrypted
A dict of actions to perform.
Obtain a dict of actions which should be performed for this event according to the push rules for this user. Caches the dict on the event.
The event to get push actions for.
forces to recalculate actions for an event Useful when an event just got decrypted
A dict of actions to perform.
Get the push rules for the account from the server.
Promise which resolves to the push rules.
Get the refresh token associated with this account.
The refresh_token or null
Get the room for the given room ID. This function will return a valid room for any room for which a Room event has been emitted. Note in particular that other events, eg. RoomState.members will be emitted for a room before this function will return the given room.
The room ID
The Room or null if it doesn't exist or there is no data store.
Get the visibility of a room in the current HS's room directory
Promise which resolves: TODO
Fetches or paginates a room hierarchy asmatrix-js-sdk/spec/unit/matrix-client.spec.ts defined by MSC2946.
Falls back gracefully to sourcing its data from getSpaceSummary if this API is not yet supported by the server.
The ID of the space-room to use as the root of the summary.
Optionallimit: numberThe maximum number of rooms to return per page.
OptionalmaxDepth: numberThe maximum depth in the tree from the root room to return.
Whether to only return rooms with suggested=true.
OptionalfromToken: stringThe opaque token to paginate a previous request.
the response, with next_batch & rooms fields.
Get room info for the given alias.
The room alias to resolve.
Promise which resolves: Object with room_id and servers.
Get the room-kind push rule associated with a room.
"global" or device-specific.
the id of the room.
the rule or undefined.
Retrieve all known rooms.
A list of rooms, or an empty list if there is no data store.
Fetches the summary of a room as defined by an initial version of MSC3266 and implemented in Synapse Proposed at https://github.com/matrix-org/matrix-doc/pull/3266
The ID or alias of the room to get the summary of.
Optionalvia: string[]The list of servers which know about the room if only an ID was provided.
Promise which resolves: to an object keyed by tagId with objects containing a numeric order field.
Determines the history of room upgrades for a given room, as far as the client can see. Returns an array of Rooms where the first entry is the oldest and the last entry is the newest (likely current) room. If the provided room is not found, this returns an empty list. This works in both directions, looking for older and newer rooms of the given room.
The room ID to search from
If true, the function will only return rooms which can be proven to be linked. For example, rooms which have a create event pointing to an old room which the client is not aware of or doesn't have a matching tombstone would not be returned.
if true, look for m.room.predecessor state events as well as create events, and prefer predecessor events where they exist (MSC3946).
An array of rooms representing the upgrade history.
Return the provided scheduler, if any.
The scheduler or undefined
Get the session ID of this client
session ID
The URL to redirect to after the HS authenticates with the SSO.
The type of SSO login we are doing (sso or cas). Defaults to 'sso'.
OptionalidpId: stringThe ID of the Identity Provider being targeted, optional.
Optionalaction: SSOActionthe SSO flow to indicate to the IdP, optional.
The HS URL to hit to begin the SSO login process.
Returns the additional data object associated with the current sync state, or null if there is no such data. Sync errors, if available, are put in the 'error' key of this object.
Get information on how a specific place on a third party protocol may be reached.
The protocol given in getThirdpartyProtocols()
Protocol-specific parameters, as given in the response to getThirdpartyProtocols()
Promise which resolves to the result object
Get information on how a specific user on a third party protocol may be reached.
The protocol given in getThirdpartyProtocols()
Optionalparams: QueryDictProtocol-specific parameters, as given in the response to getThirdpartyProtocols()
Promise which resolves to the result object
Get the unix timestamp (in milliseconds) at which the current TURN credentials (from getTurnServers) expire
The expiry timestamp in milliseconds
Get a preview of the given URL as of (roughly) the given point in time, described as an object with OpenGraph keys and associated values. Attributes may be synthesized where actual OG metadata is lacking. Caches results to prevent hammering the server.
The URL to get preview data for
The preferred point in time that the preview should describe (ms since epoch). The preview returned will either be the most recent one preceding this timestamp if available, or failing that the next most recent available preview.
Promise which resolves: Object of OG metadata.
Returns true if to-device signalling for group calls will be encrypted with Olm. If false, it will be sent unencrypted.
boolean Whether group call signalling will be encrypted
Retrieve a user.
The user ID to retrieve.
A user or null if there is no data store or the user does not exist.
Get the user-id of the logged-in user
MXID for the logged-in user, or null if not logged in
Get the local part of the current user ID e.g. "foo" in "@foo:bar".
The user ID localpart or null.
Retrieve all known users.
A list of users, or an empty list if there is no data store.
Get the API versions supported by the server, along with any unstable APIs it supports
The server /versions response
Retrieve all rooms that should be displayed to the user This is essentially getRooms() with some rooms filtered out, eg. old versions of rooms that have been replaced or (in future) other rooms that have been marked at the protocol level as not to be displayed to the user.
if true, look for an m.room.predecessor state event and use it if found (MSC3946).
A list of rooms, or an empty list if there is no data store.
Get if lazy loading members is being used.
Whether or not members are lazy loaded by this client
Performs a hashed lookup of addresses against the identity server. This is only supported on identity servers which have at least the version 2 API.
An array of 2 element arrays.
The first element of each pair is the address, the second is the 3PID medium.
Eg: ["email@example.org", "email"]
The access token for the identity server.
A collection of address mappings to found MXIDs. Results where no user could be found will not be listed.
Initialise support for end-to-end encryption in this client, using the rust matrix-sdk-crypto.
WARNING: the cryptography stack is not thread-safe. Having multiple MatrixClient instances connected to
the same Indexed DB will cause data corruption and decryption failures. The application layer is responsible for
ensuring that only one MatrixClient issue is instantiated at a time.
OptionalstorageKey?: Uint8Array<ArrayBufferLike>A key with which to encrypt the indexeddb store. If provided, it must be exactly
32 bytes of data, and must be the same each time the client is initialised for a given device.
If both this and storagePassword are unspecified, the store will be unencrypted.
OptionalstoragePassword?: stringAn alternative to storageKey. A password which will be used to derive a key to
encrypt the store with. Deriving a key from a password is (deliberately) a slow operation, so prefer
to pass a storageKey directly where possible.
OptionaluseIndexedDB?: booleanTrue to use an indexeddb store, false to use an in-memory store. Defaults to 'true'.
a Promise which will resolve when the crypto layer has been successfully initialised.
Optionalreason: stringOptional.
Promise which resolves: {} an empty object.
Invite a user to a room based on their email address.
The room to invite the user to.
The email address to invite.
Promise which resolves: {} an empty object.
Invite a user to a room based on a third-party identifier.
The room to invite the user to.
The medium to invite the user e.g. "email".
The address for the specified medium.
Promise which resolves: {} an empty object.
Get 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.
Return whether the client is configured for a guest account.
True if this is a guest access_token (or no token is supplied).
Whether the initial sync has completed.
True if at least one sync has happened.
Check whether the key backup private key is stored in secret storage.
map of key name to key info the secret is encrypted with, or null if it is not present or not encrypted with a trusted key
true if there is a valid access_token for this client.
Whether encryption is enabled for a room.
the room id to query.
whether encryption is enabled.
Not correctly supported for Rust Cryptography. Use CryptoApi.isEncryptionEnabledInRoom and/or Room.hasEncryptionStateEvent.
Determines if the current user is an administrator of the Synapse homeserver. Returns false if untrue or the homeserver does not appear to be a Synapse homeserver. This function is implementation specific and may change as a result.
true if the user appears to be a Synapse administrator.
Gets whether or not a specific user is being ignored by this client.
the user ID to check
true if the user is ignored, false otherwise
Check whether a username is available prior to registration. An error response indicates an invalid/unavailable username.
The username to check the availability of.
Promise which resolves: to boolean of whether the username is available.
Check if a particular spec version is supported by the server.
The spec version (such as "r0.5.0") to check for.
Whether it is supported
Join a room. If you have already joined the room, this will no-op.
The room ID or room alias to join.
Options when joining the room.
Promise which resolves: Room object.
Optionalreason: stringOptional.
Promise which resolves: {} an empty object.
Knock a room. If you have already knocked the room, this will no-op.
The room ID or room alias to knock.
Options when knocking the room.
Promise which resolves: {room_id: {string}}
Leaves all rooms in the chain of room upgrades based on the given room. By
default, this will leave all the previous and upgraded rooms, including the
given room. To only leave the given room and any previous rooms, keeping the
upgraded (modern) rooms untouched supply false to includeFuture.
The room ID to start leaving at
If true, the whole chain (past and future) of upgraded rooms will be left.
Promise which resolves when completed with an object keyed by room ID and value of the error encountered when leaving or null.
Returns the number of listeners listening to the event named event.
The name of the event being listened for
Returns a copy of the array of listeners for the event named event.
Promise which resolves to a LoginResponse object
This method has unintuitive behaviour: it updates the MatrixClient instance with some of the
returned credentials. Instead, call loginRequest and create a new MatrixClient instance using the
results. See https://github.com/matrix-org/matrix-js-sdk/issues/4502.
Promise which resolves to the available login flows
Sends a POST /login request to the server.
If successful, this will create a new device and access token for the user.
Credentials and other details for the login request.
GET /login request.Promise which resolves to a LoginResponse object
This method has unintuitive behaviour: it updates the MatrixClient instance with some of the
returned credentials. Instead, call loginRequest with data.type: "m.login.password", and create a new
MatrixClient instance using the results. See https://github.com/matrix-org/matrix-js-sdk/issues/4502.
Login token previously received from homeserver
Promise which resolves to a LoginResponse object
This method has unintuitive behaviour: it updates the MatrixClient instance with some of the
returned credentials. Instead, call loginRequest with data.type: "m.login.token", and create a new
MatrixClient instance using the results. See https://github.com/matrix-org/matrix-js-sdk/issues/4502.
Logs out the current session. Obviously, further calls that require authorisation should fail after this method is called. The state of the MatrixClient object is not affected: it is up to the caller to either reset or destroy the MatrixClient after this method succeeds.
whether to stop the client before calling /logout to prevent invalid token errors.
Promise which resolves: On success, the empty object {}
Looks up the public Matrix ID mapping for a given 3rd party identifier from the identity server
The medium of the threepid, eg. 'email'
The textual address of the threepid
The access_token field of the Identity
Server /account/register response (see registerWithIdentityServer).
Promise which resolves: A threepid mapping object or the empty object if no mapping exists
Make up a new transaction id
a new, unique, transaction id
OptionalincludeMembership: stringthe membership type to include in the response
OptionalexcludeMembership: stringthe membership type to exclude from the response
OptionalatEventId: stringthe id of the event for which moment in the timeline the members should be returned for
Promise which resolves: dictionary of userid to profile information
Turn an MXC URL into an HTTP one. This method is experimental and may change.
The MXC URL
Optionalwidth: numberThe desired width of the thumbnail.
Optionalheight: numberThe desired height of the thumbnail.
OptionalresizeMethod: stringThe thumbnail resize method to use, either "crop" or "scale".
OptionalallowDirectLinks: booleanIf true, return any non-mxc URLs directly. Fetching such URLs will leak information about the user to anyone they share a room with. If false, will return null for such URLs.
OptionalallowRedirects: booleanIf true, the caller supports the URL being 307 or
308 redirected to another resource upon request. If false, redirects
are not expected. Implied true when useAuthentication is true.
OptionaluseAuthentication: booleanIf true, the caller supports authenticated
media and wants an authentication-required URL. Note that server support
for authenticated media will not be checked - it is the caller's responsibility
to do so before calling this function. Note also that useAuthentication
implies allowRedirects. Defaults to false (unauthenticated endpoints).
the avatar URL or null.
Alias for removeListener
Adds the listener function to the end of the listeners array for the
event named event.
No checks are made to see if the listener has already been added. Multiple calls
passing the same combination of event and listener will result in the listener
being added, and called, multiple times.
By default, event listeners are invoked in the order they are added. The prependListener method can be used as an alternative to add the event listener to the beginning of the listeners array.
The name of the event.
The callback function
a reference to the EventEmitter, so that calls can be chained.
Adds a one-time listener function for the event named event. The
next time event is triggered, this listener is removed and then invoked.
Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The prependOnceListener method can be used as an alternative to add the event listener to the beginning of the listeners array.
The name of the event.
The callback function
a reference to the EventEmitter, so that calls can be chained.
Take an EventTimeline, and back/forward-fill results.
timeline object to be updated
Promise which resolves to a boolean: false if there are no events and we reached either end of the timeline; else true.
Peek into a room and receive updates about the room. This only works if the history visibility for the room is world_readable.
The room to attempt to peek into.
The number of timeline events to initially retrieve.
Promise which resolves: Room object
Adds the listener function to the beginning of the listeners array for the
event named event.
No checks are made to see if the listener has already been added. Multiple calls
passing the same combination of event and listener will result in the listener
being added, and called, multiple times.
The name of the event.
The callback function
a reference to the EventEmitter, so that calls can be chained.
Adds a one-timelistener function for the event named event to the beginning of the listeners array.
The next time event is triggered, this listener is removed, and then invoked.
The name of the event.
The callback function
a reference to the EventEmitter, so that calls can be chained.
Calls aggregation functions for event types that are aggregated Polls and location beacons
Optionalroom: Roomroom the events belong to
Optionalevents: MatrixEvent[]timeline events to be processed
Optionalroom: RoomOptionalevents: MatrixEvent[]Internalhelper for searchRoomEvents and backPaginateRoomEventsSearch. Processes the response from the API call and updates the searchResults
searchResults
Processes a list of threaded events and adds them to their respective timelines
the room the adds the threaded events
an array of the threaded events
the direction in which we want to add the events
Processes a list of thread roots and creates a thread model
the room to create the threads in
an array of thread roots
the direction
Options for this request
Promise which resolves: IPublicRoomsResponse
Sends events directly to specific devices using Matrix's to-device messaging system. The batch will be split up into appropriately sized batches for sending and stored in the store so they can be retried later if they fail to send. Retries will happen automatically.
The to-device messages to send
Returns a copy of the array of listeners for the event named eventName,
including any wrappers (such as those created by .once()).
OptionaltxnId: stringtransaction id. One will be made up if not supplied.
Optionalopts: IRedactOptsRedact options
Promise which resolves: TODO
OptionaltxnId: stringtransaction id. One will be made up if not supplied.
Optionalopts: IRedactOptsRedact options
Promise which resolves: TODO
Refreshes an access token using a provided refresh token. The refresh token must be valid for the current access token known to the client instance.
Note that this function will not cause a logout if the token is deemed unknown by the server - the caller is responsible for managing logout actions on error.
The refresh token.
Promise which resolves to the new token.
OptionalbindThreepids: { email?: boolean; msisdn?: boolean }Set key 'email' to true to bind any email threepid uses during registration in the identity server. Set 'msisdn' to true to bind msisdn.
OptionalguestAccessToken: stringOptionalinhibitLogin: booleanPromise which resolves to a RegisterResponse object
Register a guest account.
This method returns the auth info needed to create a new authenticated client,
Remember to call setGuest(true) on the (guest-)authenticated client, e.g:
const tmpClient = await sdk.createClient(MATRIX_INSTANCE);
const { user_id, device_id, access_token } = tmpClient.registerGuest();
const client = createClient({
baseUrl: MATRIX_INSTANCE,
accessToken: access_token,
userId: user_id,
deviceId: device_id,
})
client.setGuest(true);
JSON HTTP body to provide.
Promise which resolves: JSON object that contains:
{ user_id, device_id, access_token, home_server }
parameters for registration request
Optionalkind: stringtype of user to register. may be "guest"
Promise which resolves: to the /register response
Register with an identity server using the OpenID token from the user's Homeserver, which can be retrieved via MatrixClient#getOpenIdToken.
Note that the /account/register endpoint (as well as IS authentication in
general) was added as part of the v2 API version.
Promise which resolves: with object containing an Identity Server access token.
Returns relations for a given event. Handles encryption transparently, with the caveat that the amount of events returned might be 0, even though you get a nextBatch. When the returned promise resolves, all messages should have finished trying to decrypt.
the room of the event
the id of the event
the rel_type of the relations requested
OptionaleventType: null | stringthe event type of the relations requested
options with optional values for the request.
an object with events as MatrixEvent[] and optionally nextBatch if more relations are available.
Removes all listeners, or those of the specified event.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).
Optionalevent: EventEmitterEvents | EmittedEventsThe name of the event. If undefined, all listeners everywhere are removed.
a reference to the EventEmitter, so that calls can be chained.
Removes the specified listener from the listener array for the event named event.
a reference to the EventEmitter, so that calls can be chained.
Removes an existing pusher
pushkey of pusher to remove
app_id of pusher to remove
Promise which resolves: Empty json object on success
Reports an event as inappropriate to the server, which may then notify the appropriate people.
The room in which the event being reported is located.
The event to report.
The score to rate this content as where -100 is most offensive and 0 is inoffensive.
The reason the content is being reported. May be blank.
Promise which resolves to an empty object if successful
Reports a room as inappropriate to the server, which may then notify the appropriate people.
This API was introduced in Matrix v1.13.
The room being reported.
The reason the room is being reported. May be blank.
Promise which resolves to an empty object if successful
Requests an email verification token for the purposes of adding a third party identifier to an account. This API requests a token from the homeserver. The doesServerRequireIdServerParam() method can be used to determine if the server requires the id_server parameter to be provided. If an account with the given email address already exists and is associated with an account other than the one the user is authed as, it will either send an email to the address informing them of this or return M_THREEPID_IN_USE (which one is up to the homeserver).
As requestEmailToken
As requestEmailToken
As requestEmailToken
OptionalnextLink: stringAs requestEmailToken
Promise which resolves: As requestEmailToken
Requests a text message verification token for the purposes of adding a third party identifier to an account. This API proxies the identity server /validate/email/requestToken API, adding specific behaviour for the addition of phone numbers to an account, as requestAdd3pidEmailToken.
As requestRegisterMsisdnToken
As requestRegisterMsisdnToken
As requestEmailToken
As requestEmailToken
OptionalnextLink: stringAs requestEmailToken
Promise which resolves: As requestEmailToken
Requests an email verification token directly from an identity server.
This API is used as part of binding an email for discovery on an identity
server. The validation data that results should be passed to the
bindThreePid method to complete the binding process.
The email address to request a token for
A secret binary string generated by the client. It is recommended this be around 16 ASCII characters.
If an identity server sees a duplicate request with the same sendAttempt, it will not send another email. To request another email to be sent, use a larger value for the sendAttempt param as was used in the previous request.
OptionalnextLink: stringOptional If specified, the client will be redirected to this link after validation.
OptionalidentityAccessToken: stringThe access_token field of the identity
server /account/register response (see registerWithIdentityServer).
Promise which resolves: TODO
Make a request for an m.login.token to be issued as per
https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv1loginget_token
The server may require User-Interactive auth.
Optionalauth: AuthDictOptional. Auth data to supply for User-Interactive auth.
Promise which resolves: On success, the token response or UIA auth data.
Requests a MSISDN verification token directly from an identity server.
This API is used as part of binding a MSISDN for discovery on an identity
server. The validation data that results should be passed to the
bindThreePid method to complete the binding process.
The ISO 3166-1 alpha-2 code for the country in which phoneNumber should be parsed relative to.
The phone number, in national or international format
A secret binary string generated by the client. It is recommended this be around 16 ASCII characters.
If an identity server sees a duplicate request with the same sendAttempt, it will not send another SMS. To request another SMS to be sent, use a larger value for the sendAttempt param as was used in the previous request.
OptionalnextLink: stringOptional If specified, the client will be redirected to this link after validation.
OptionalidentityAccessToken: stringThe access_token field of the Identity
Server /account/register response (see registerWithIdentityServer).
Promise which resolves to an object with a sid string
Requests an email verification token for the purposes of resetting the password on an account. This API proxies the identity server /validate/email/requestToken API, adding specific behaviour for the password resetting. Specifically, if no account with the given email address exists, it may either return M_THREEPID_NOT_FOUND or send an email to the address informing them of this (which one is up to the homeserver).
requestEmailToken calls the equivalent API directly on the identity server, therefore bypassing the password reset specific logic.
As requestEmailToken
As requestEmailToken
As requestEmailToken
OptionalnextLink: stringAs requestEmailToken
Promise which resolves: As requestEmailToken
Requests a text message verification token for the purposes of resetting the password on an account. This API proxies the identity server /validate/email/requestToken API, adding specific behaviour for the password resetting, as requestPasswordEmailToken.
As requestRegisterMsisdnToken
As requestRegisterMsisdnToken
As requestEmailToken
As requestEmailToken
As requestEmailToken
Promise which resolves: As requestEmailToken
Requests an email verification token for the purposes of registration. This API requests a token from the homeserver. The doesServerRequireIdServerParam() method can be used to determine if the server requires the id_server parameter to be provided.
Parameters and return value are as for requestEmailToken
As requestEmailToken
As requestEmailToken
As requestEmailToken
OptionalnextLink: stringAs requestEmailToken
Promise which resolves: As requestEmailToken
Requests a text message verification token for the purposes of registration. This API requests a token from the homeserver. The doesServerRequireIdServerParam() method can be used to determine if the server requires the id_server parameter to be provided.
The ISO 3166-1 alpha-2 code for the country in which phoneNumber should be parsed relative to.
The phone number, in national or international format
As requestEmailToken
As requestEmailToken
OptionalnextLink: stringAs requestEmailToken
Promise which resolves: As requestEmailToken
Resend an event. Will also retry any to-device messages waiting to be sent.
The event to resend.
Optional. The room the event is in. Will update the timeline entry if provided.
Promise which resolves: to an ISendEventResponse object
Reset the notifTimelineSet entirely, paginating in some historical notifs as a starting point for subsequent pagination.
Retry a backed off syncing request immediately. This should only be used when the user explicitly attempts to retry their lost connection. Will also retry any outbound to-device messages currently in the queue to be sent (retries of regular outgoing events are handled separately, per-event).
True if this resulted in a request being retried.
Promise which resolves: TODO
Retrieve older messages from the given room and put them in the timeline.
If this is called multiple times whilst a request is ongoing, the same Promise will be returned. If there was a problem requesting scrollback, there will be a small delay before another request can be made (to prevent tight-looping when there is no connection).
The room to get older messages in.
Optional. The maximum number of previous events to pull in. Default: 30.
Promise which resolves: Room. If you are at the beginning
of the timeline, Room.oldState.paginationToken will be
null.
Perform a server-side search.
the JSON object to pass to the request body.
Optionalnext_batch?: stringthe batch token to pass in the query string
OptionalabortSignal: AbortSignaloptional signal used to cancel the http request.
Promise which resolves to the search response object.
Perform a server-side search for room events.
The returned promise resolves to an object containing the fields:
Each entry in the results list is a SearchResult.
Promise which resolves: result object
Query the user directory with a term matching user IDs, display names and domains.
Optionallimit?: numberthe maximum number of results to return. The server will apply a limit if unspecified.
the term with which to search.
Promise which resolves: an array of results.
OptionaltxnId: stringOptional.
Promise which resolves: to a ISendEventResponse object
OptionaltxnId: stringOptional.
Promise which resolves: to a ISendEventResponse object
OptionaltxnId: stringOptionaltxnId: stringPromise which resolves: to a ISendEventResponse object
Promise which resolves: to a ISendEventResponse object
Promise which resolves: to a ISendEventResponse object
Promise which resolves: to a ISendEventResponse object
Promise which resolves: to a ISendEventResponse object
Promise which resolves: to a ISendEventResponse object
Optionalinfo: ImageInfoOptionaltext: stringPromise which resolves: to a ISendEventResponse object
Optionalinfo: ImageInfoOptionaltext: stringPromise which resolves: to a ISendEventResponse object
OptionaltxnId: stringOptional.
Promise which resolves: to an ISendEventResponse object
OptionaltxnId: stringOptional.
Promise which resolves: to an ISendEventResponse object
OptionaltxnId: stringOptional.
Promise which resolves: to a ISendEventResponse object
OptionaltxnId: stringOptional.
Promise which resolves: to a ISendEventResponse object
Send a read receipt.
The event that has been read.
other than ReceiptType.Read are experimental! Optional.
Promise which resolves: to an empty object {}
Send a receipt.
The event being acknowledged
The kind of receipt e.g. "m.read". Other than ReceiptType.Read are experimental!
Optionalbody: Record<string, any>Additional content to send alongside the receipt.
An unthreaded receipt will clear room+thread notifications
Promise which resolves: to an empty object {}
Send a state event into a room
ID of the room to send the event into
type of the state event to send
content of the event to send
the stateKey to send into the room
Options for the request function.
Promise which resolves: TODO
Optionalinfo: ImageInfoOptionaltext: stringPromise which resolves: to a ISendEventResponse object
Optionalinfo: ImageInfoOptionaltext: stringPromise which resolves: to a ISendEventResponse object
OptionaltxnId: stringOptional.
OptionaltxnId: stringOptional.
Send an event to a specific list of devices. This is a low-level API that simply wraps the HTTP API call to send to-device messages. We recommend using queueToDevice() which is a higher level API.
type of event to send content to send. Map from user_id to device_id to content object.
OptionaltxnId: stringtransaction id. One will be made up if not supplied.
Promise which resolves: to an empty object {}
Promise which resolves: to an empty object {}
Set the access token associated with this account.
The new access token.
Set account data event for the current user, and wait for the result to be echoed over /sync.
Waiting for the remote echo ensures that a subsequent call to getAccountData will return the updated value.
If called before the client is started with startClient, logs a warning and falls back to setAccountDataRaw.
Retries the request up to 5 times in the case of an ConnectionError.
The event type
the contents object for the event
Set account data event for the current user, without waiting for the remote echo.
The event type
the contents object for the event
Set a function which is called when /sync returns a 'limited' response. It is called with a room ID and returns a boolean. It should return 'true' if the SDK can SAFELY remove events from this room. It may not be safe to remove events if there are other references to the timelines for this room, e.g because the client is actively viewing events in this room. Default: returns false.
The callback which will be invoked.
Update the given device
device to update
body of request
Promise which resolves: to an empty object {}
Set a property on your extended profile.
The key of the property to set.
The value to set on the property.
Set 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.
Set whether VoIP calls are forced to use only TURN candidates. This is the same as the forceTURN option when creating the client.
True to force use of TURN servers
ExperimentalSet whether this client is a guest account. This method is experimental and may change without warning.
True if this is a guest account. if the token is a macaroon, it should be encoded in it that it is a 'guest' access token, which means that the SDK can determine this entirely without the dev manually flipping this flag.
Set r/w flags for guest access in a room.
The room to configure guest access in.
Options
Promise which resolves
Set the identity server URL of this client
Optionalurl: stringNew identity server URL
Sets the users that the current user should ignore.
the user IDs to ignore
Promise which resolves: an empty object
Persists local notification settings
Promise which resolves: an empty object
Make a request to change your password.
The new desired password.
OptionallogoutDevices: booleanShould all sessions be logged out after the password change. Defaults to true.
Promise which resolves: to an empty object {}
Set a power level to one or multiple users.
Will apply changes atop of current power level event from local state if running & synced, falling back
to fetching latest from the /state/ API.
the room to update power levels in
the ID of the user or users to update power levels of
the numeric power level to update given users to
Promise which resolves: to an ISendEventResponse object
The kind of info to set (e.g. 'avatar_url')
The JSON object to set.
The kind of info to set (e.g. 'avatar_url')
The JSON object to set.
Adds a new pusher or updates an existing pusher
Object representing a pusher
Promise which resolves: Empty json object on success
Set the actions for a push notification rule.
Promise which resolves: to an empty object {}
Enable or disable a push notification rule.
Promise which resolves: to an empty object {}
Update the push rules for the account. This should be called whenever updated push rules are available.
event type to be set
event content
Promise which resolves: to an empty object {}
Set the visibility of a room in the current HS's room directory
"public" to make the room visible in the public directory, or "private" to make it invisible.
Promise which resolves: to an empty object {}
Set a room-kind muting push rule in a room. The operation also updates MatrixClient.pushRules at the end.
"global" or device-specific.
the id of the room.
the mute state.
Promise which resolves: result object
Set a marker to indicate the point in a room before which the user has read every
event. This can be retrieved from room account data (the event type is m.fully_read)
and displayed as a horizontal line in the timeline that is visually distinct to the
position of the user's own read receipt.
ID of the room that has been read
ID of the event that has been read
OptionalrrEvent: MatrixEventthe event tracked by the read receipt. This is here for convenience because the RR and the RM are commonly updated at the same time as each other. The local echo of this receipt will be done if set. Optional.
OptionalrpEvent: MatrixEventthe m.read.private read receipt event for when we don't want other users to see the read receipts. This is experimental. Optional.
Promise which resolves: the empty object, {}.
Set a marker to indicate the point in a room before which the user has read every
event. This can be retrieved from room account data (the event type is m.fully_read)
and displayed as a horizontal line in the timeline that is visually distinct to the
position of the user's own read receipt.
ID of the room that has been read
ID of the event that has been read
OptionalrrEventId: stringID of the event tracked by the read receipt. This is here for convenience because the RR and the RM are commonly updated at the same time as each other. Optional.
OptionalrpEventId: stringrpEvent the m.read.private read receipt event for when we don't want other users to see the read receipts. This is experimental. Optional.
Promise which resolves: the empty object, {}.
name of room tag to be set
associated with that tag to be stored
Promise which resolves: to an empty object
The room to update the topic in.
Optionaltopic: stringThe plaintext topic. May be empty to remove the topic.
OptionalhtmlTopic: stringOptional.
Promise which resolves: TODO
Set whether to advertise transfer support to other parties on Matrix calls.
True to advertise the 'm.call.transferee' capability
Specify the set_presence value to be used for subsequent calls to the Sync API. This has an advantage over calls to the PUT /presence API in that it doesn't clobber status_msg set by other devices.
Optionalpresence: SetPresencethe presence to specify to set_presence of sync calls
Perform a single MSC3575 sliding sync request.
The request to make.
OptionalproxyBaseUrl: stringThe base URL for the sliding sync proxy.
OptionalabortSignal: AbortSignalOptional signal to abort request mid-flight.
The sliding sync response, or a standard error.
High level helper method to begin syncing and poll for new events. To listen for these events, add a listener for ClientEvent.Event via MatrixClient#on. Alternatively, listen for specific state change events.
Optionalopts: IStartClientOptsOptions to apply when syncing.
High level helper method to stop the client from polling and allow a clean shutdown.
Stop any ongoing room peeking.
store client options with boolean/string/numeric values to know in the next session what flags the sync data was created with (e.g. lazy loading)
for store operation
Submits a MSISDN token to the identity server
This is used when submitting the code sent by SMS to a phone number. The identity server has an equivalent API for email but the js-sdk does not expose this, since email is normally validated by the user clicking a link rather than entering a code.
The sid given in the response to requestToken
A secret binary string generated by the client. This must be the same value submitted in the requestToken call.
The MSISDN token, as entered by the user.
The access_token field of the Identity
Server /account/register response (see registerWithIdentityServer).
Some legacy identity servers had no authentication here.
Promise which resolves: Object, containing success boolean.
Submits a MSISDN token to an arbitrary URL.
This is used when submitting the code sent by SMS to a phone number in the
newer 3PID flow where the homeserver validates 3PID ownership (as part of
requestAdd3pidMsisdnToken). The homeserver response may include a
submit_url to specify where the token should be sent, and this helper can
be used to pass the token to this URL.
The URL to submit the token to
The sid given in the response to requestToken
A secret binary string generated by the client. This must be the same value submitted in the requestToken call.
The MSISDN token, as entered by the user.
Promise which resolves: Object, containing success boolean.
ExperimentalA helper to determine intentional mentions support
a boolean to determine if intentional mentions are enabled on the server
A helper to determine thread support
a boolean to determine if threads are enabled
Check if the runtime environment supports VoIP calling.
True if VoIP is supported.
Find the event_id closest to the given timestamp in the given direction.
Resolves: A promise of an object containing the event_id and origin_server_ts of the closest event to the timestamp in the given direction
Promise which resolves: ITurnServerResponse object
Promise which resolves: Object (currently empty)
Unbind a 3PID for discovery on an identity server via the homeserver. The homeserver removes its record of the binding to keep an updated record of where all 3PIDs for the account are bound.
The threepid medium (eg. 'email')
The threepid address (eg. 'bob@example.com') this must be as returned by getThreePids.
Promise which resolves: on success
Create an m.beacon_info event
Upsert a live beacon event using a specific m.beacon_info.* event variable type
string
Creates a new file tree space with the given name. The client will pick defaults for how it expects to be able to support the remaining API offered by the returned class.
Note that this is UNSTABLE and may have breaking changes without notice.
The name of the tree space.
Promise which resolves to the created space.
Gets a reference to a tree space, if the room ID given is a tree space. If the room does not appear to be a tree space then null is returned.
Note that this is UNSTABLE and may have breaking changes without notice.
The room ID to get a tree space reference for.
The tree space, or null if not a tree space.
ProtectedupdateUpgrades a room to a new protocol version
The target version to upgrade to
Promise which resolves: Object with key 'replacement_room'
Upload a file to the media repository on the homeserver.
The object to upload. On a browser, something that can be sent to XMLHttpRequest.send (typically a File). Under node.js, a a Buffer, String or ReadStream.
Optionalopts: UploadOptsoptions object
Promise which resolves to response object, as determined by this.opts.onlyData, opts.rawResponse, and opts.onlyContentUri. Rejects with an error (usually a MatrixError).
Optionalauth: AuthDictOptionalkeys: CrossSigningKeysUpload keys
body of upload request
Optionalopts: voidthis method no longer takes any opts, used to take opts.device_id but this was not removed from the spec as a redundant parameter
Promise which resolves: result object. Rejects: with an error response (MatrixError).
Wait until an initial state for the given room has been processed by the client and the client is aware of any ongoing group calls. Awaiting on the promise returned by this method before calling getGroupCallForRoom() avoids races where getGroupCallForRoom is called before the state for that room has been processed. It does not, however, fix other races, eg. two clients both creating a group call at the same time.
The room ID to wait for
A promise that resolves once existing group calls in the room have been processed.
Fetches information about the user for the configured access token.
Performs a whois lookup on a user using Synapse's administrator API. This function is implementation specific and may change as a result.
the User ID to look up.
the whois response - see Synapse docs for information.
Represents a Matrix Client. Only directly construct this if you want to use custom modules. Normally, createClient should be used as it specifies 'sensible' defaults for these modules.