Class MatrixClient

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.

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

_unstable_getSharedRooms addListener addPushRule addSecretStorageKey addThreePidOnly agreeToTerms backPaginateRoomEventsSearch ban beginKeyVerification bindThreePid bootstrapCrossSigning bootstrapSecretStorage buildSyncApiOptions bulkLookupThreePids cancelAndResendEventRoomKeyRequest cancelPendingEvent cancelUpload checkCrossSigningPrivateKey checkDeviceTrust checkIfOwnDeviceCrossSigned checkKeyBackup checkOwnCrossSigningTrust checkSecretStorageKey checkSecretStoragePrivateKey checkTurnServers checkUserTrust claimOneTimeKeys clearStores countSessionsNeedingBackup createAlias createCall createDehydratedDevice createFilter createGroupCall createKeyBackupVersion createMessagesRequest createRecoveryKeyFromPassphrase createRoom createThreadListMessagesRequest deactivateAccount deactivateSynapseUser decryptEventIfNeeded deleteAccountData deleteAlias deleteDevice deleteKeyBackupVersion deleteKeysFromBackup deleteMultipleDevices deletePushRule deleteRoomTag deleteThreePid disableKeyBackup doesServerForceEncryptionForPreset doesServerSupportThread doesServerSupportUnstableFeature downloadKeys downloadKeysForUsers emit emitPromised enableKeyBackup encryptAndSendEvent encryptAndSendToDevices encryptEventIfNeeded exportDevice exportRoomKeys fetchClientWellKnown fetchRelations fetchRoomEvent findPredecessorRooms findSuccessorRooms findVerificationRequestDMInProgress fixupRoomNotifications flagAllGroupSessionsForBackup forceDiscardSession forget generateClientSecret getAccessToken getAccountData getAccountDataFromServer getAuthIssuer getCanResetTimelineCallback getCapabilities getCasLoginUrl getClientWellKnown getCrossSigningCacheCallbacks getCrossSigningId getCrypto getCryptoTrustCrossSignedDevices getCurrentUploads getDefaultSecretStorageKeyId getDehydratedDevice getDevice getDeviceCurve25519Key getDeviceEd25519Key getDeviceId getDevices getDomain getEncryptedIfNeededEventType getEventEncryptionInfo getEventMapper getEventSenderDeviceInfo getEventTimeline getFallbackAuthUrl getFilter getGlobalBlacklistUnverifiedDevices getGlobalErrorOnUnknownDevices getGroupCallForRoom getHomeserverUrl getIdentityAccount getIdentityHashDetails getIdentityServerUrl getIgnoredUsers getJoinedRoomMembers getJoinedRooms getKeyBackupEnabled getKeyBackupVersion getKeyChanges getLatestTimeline getLivekitServiceURL getLocalAliases getMediaConfig getMediaHandler getNotifTimelineSet getOpenIdToken getOrCreateFilter getOutgoingRoomKeyRequest getPresence getProfileInfo getPushActionsForEvent getPushDetailsForEvent getPushRules getPushers getRefreshToken getRoom getRoomDirectoryVisibility getRoomHierarchy getRoomIdForAlias getRoomPushRule getRoomSummary getRoomTags getRoomUpgradeHistory getRooms getSafeUserId getScheduler getSecret getSessionId getSsoLoginUrl getStateEvent getStoredCrossSigningForUser getStoredDevice getStoredDevicesForUser getSyncState getSyncStateData getTerms getThirdpartyLocation getThirdpartyProtocols getThirdpartyUser getThreadTimeline getThreePids getTotalKeyCount getTurnServers getTurnServersExpiry getUrlPreview getUseE2eForGroupCall getUser getUserId getUserIdLocalpart getUsers getVerificationRequestsToDeviceInProgress getVersions getVisibleRooms handleDecryptionOfAFullBackup hasLazyLoadMembersEnabled hasSecretStorageKey identityHashedLookup importRoomKeys initCrypto initRustCrypto invite inviteByEmail inviteByThreePid isCrossSigningReady isCryptoEnabled isEventSenderVerified isFallbackICEServerAllowed isGuest isInitialSyncComplete isKeyBackupKeyStored isKeyBackupTrusted isLoggedIn isRoomEncrypted isSecretStorageReady isSecretStored isSynapseAdministrator isUserIgnored isUsernameAvailable isValidRecoveryKey isVersionSupported joinRoom keyBackupKeyFromPassword keyBackupKeyFromRecoveryKey kick knockRoom leave leaveRoomChain legacyDeviceVerification listenerCount listeners login loginFlows loginWithPassword loginWithToken logout lookupThreePid makeKeyBackupPath makeTxnId members membershipChange mxcUrlToHttp off on once paginateEventTimeline peekInRoom prepareKeyBackupVersion prepareToEncrypt prependListener prependOnceListener processAggregatedTimelineEvents processBeaconEvents processRoomEventsSearch processThreadEvents processThreadRoots publicRooms queueToDevice rawListeners redactEvent refreshToken register registerGuest registerRequest registerWithIdentityServer rehydrateDevice relations removeAllListeners removeListener removePusher reportEvent requestAdd3pidEmailToken requestAdd3pidMsisdnToken requestEmailToken requestLoginToken requestMsisdnToken requestPasswordEmailToken requestPasswordMsisdnToken requestRegisterEmailToken requestRegisterMsisdnToken requestSecret requestTokenFromEndpoint requestVerification requestVerificationDM resendEvent resetNotifTimelineSet resolveRoomAlias restoreKeyBackup restoreKeyBackupWithCache restoreKeyBackupWithPassword restoreKeyBackupWithRecoveryKey restoreKeyBackupWithSecretStorage retryImmediately roomInitialSync roomState scheduleAllGroupSessionsForBackup scrollback search searchMessageText searchRoomEvents searchUserDirectory sendCompleteEvent sendEmoteMessage sendEvent sendEventHttpRequest sendHtmlEmote sendHtmlMessage sendHtmlNotice sendImageMessage sendKeyBackup sendMessage sendNotice sendReadReceipt sendReceipt sendSharedHistoryKeys sendStateEvent sendStickerMessage sendTextMessage sendToDevice sendTyping setAccessToken setAccountData setAvatarUrl setCanResetTimelineCallback setCryptoTrustCrossSignedDevices setDefaultSecretStorageKeyId setDehydrationKey setDeviceBlocked setDeviceDetails setDeviceKnown setDeviceVerification setDeviceVerified setDisplayName setFallbackICEServerAllowed setForceTURN setGlobalBlacklistUnverifiedDevices setGlobalErrorOnUnknownDevices setGuest setGuestAccess setIdentityServerUrl setIgnoredUsers setLivekitServiceURL setLocalNotificationSettings setNotifTimelineSet setPassword setPowerLevel setPresence setProfileInfo setPushRuleActions setPushRuleEnabled setPushRules setPusher setRoomAccountData setRoomDirectoryVisibility setRoomEncryption setRoomMutePushRule setRoomName setRoomReadMarkers setRoomReadMarkersHttpRequest setRoomTag setRoomTopic setSupportsCallTransfer setSyncPresence shouldEncryptEventForRoom slidingSync startCallEventHandler startClient startMatrixRTC stopClient stopPeeking storeClientOptions storeSecret submitMsisdnToken submitMsisdnTokenOtherUrl supportsExperimentalThreads supportsIntentionalMentions supportsThreads supportsVoip syncLeftRooms termsUrlForService timestampToEvent turnServer unban unbindThreePid unstableCreateFileTree unstableGetFileTreeSpace unstable_createLiveBeacon unstable_setLiveBeacon updatePendingEventStatus upgradeRoom uploadContent uploadDeviceSigningKeys uploadKeySignatures uploadKeys uploadKeysRequest userHasCrossSigningKeys waitForClientWellKnown waitUntilRoomReadyForGroupCalls whoami whoisSynapseUser

Constructors

Properties

_store: IStore
baseUrl: string
cachedCapabilities?: {
    capabilities: Capabilities;
    expiration: number;
}

Type declaration

callEventHandler?: CallEventHandler
canResetTimelineCallback?: ResetTimelineCallback
canSupport: Map<Feature, ServerSupport> = ...
canSupportVoip: boolean = false
checkTurnServersIntervalID?: number
clientOpts?: IStoredClientOpts
clientRunning: boolean = false
clientWellKnown?: IClientWellKnown
clientWellKnownIntervalID?: number
clientWellKnownPromise?: Promise<IClientWellKnown>
credentials: {
    userId: null | string;
}

Type declaration

  • userId: null | string
crypto?: Crypto

The libolm crypto implementation, if it is in use.

Deprecated

This should not be used. Instead, use the methods exposed directly on this class or (where they are available) via getCrypto.

cryptoBackend?: CryptoBackend
cryptoCallbacks: ICryptoCallbacks
cryptoStore?: CryptoStore
deviceId: null | string
eventsBeingEncrypted: Set<string> = ...

IDs of events which are currently being encrypted.

This is part of the cancellation mechanism: if the event is no longer listed here when encryption completes, that tells us that it has been cancelled, and we should not send it.

exportedOlmDeviceToImport?: IExportedDevice
fallbackICEServerAllowed: boolean = false
forceTURN: boolean = false
groupCallEventHandler?: GroupCallEventHandler
http: MatrixHttpApi<IHttpOpts & {
    onlyData: true;
}>
iceCandidatePoolSize: number = 0
idBaseUrl?: string
identityServer?: IIdentityServerProvider
ignoredInvites: IgnoredInvites
isGuestAccount: boolean = false
isVoipWithNoMediaAllowed: boolean
livekitServiceURL?: string
logger: Logger
mediaHandler: MediaHandler = ...
notifTimelineSet: null | EventTimelineSet = null
olmVersion: null | [number, number, number] = null
ongoingScrollbacks: {
    [roomId: string]: {
        errorTs?: number;
        promise?: Promise<Room>;
    };
} = {}

Type declaration

  • [roomId: string]: {
        errorTs?: number;
        promise?: Promise<Room>;
    }
    • Optional errorTs?: number
    • Optional promise?: Promise<Room>
peekSync: null | SyncApi = null
pickleKey?: string

Encryption key used for encrypting sensitive data (such as e2ee keys) in storage.

As supplied in the constructor via IMatrixClientCreateOpts#pickleKey.

If unset, either a hardcoded key or no encryption at all is used, depending on the Crypto implementation.

Deprecated

this should be a private property.

pushProcessor: PushProcessor = ...
pushRules?: IPushRules
roomNameGenerator?: ((roomId, state) => null | string)

Type declaration

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

      Returns null | string

serverVersionsPromise?: Promise<IServerVersions>
sessionId: string
supportsCallTransfer: boolean = false
syncLeftRoomsPromise?: Promise<Room[]>
syncedLeftRooms: boolean = false
timelineSupport: boolean = false
toDeviceMessageQueue: ToDeviceMessageQueue
turnServers: ITurnServer[] = []
turnServersExpiry: number = 0
txnCtr: number = 0
urlPreviewCache: {
    [key: string]: Promise<IPreviewUrlResponse>;
} = {}

Type declaration

useE2eForGroupCall: boolean = true
useLivekitForGroupCalls: boolean
usingExternalCrypto: boolean = false
verificationMethods?: string[]
RESTORE_BACKUP_ERROR_BAD_KEY: "RESTORE_BACKUP_ERROR_BAD_KEY" = "RESTORE_BACKUP_ERROR_BAD_KEY"

Accessors

Methods

  • Gets a set of room IDs in common with another user.

    Note: This endpoint is unstable, and can throw an Error. Check progress on MSC2666 for more details.

    Parameters

    • userId: string

      The userId to check.

    Returns Promise<string[]>

    Promise which resolves to an array of rooms

  • 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.

    Parameters

    • data: IAddThreePidOnlyBody

      A object with 3PID validation data from having called account/3pid/<medium>/requestToken on the homeserver.

    Returns Promise<{}>

    Promise which resolves: to an empty object {}

  • Take a result from an earlier searchRoomEvents call, and backfill results.

    Type Parameters

    Parameters

    • searchResults: T

      the results object to be updated

    Returns Promise<T>

    Promise which resolves: updated result object

  • Parameters

    • roomId: string
    • userId: string
    • Optional reason: string

      Optional.

    Returns Promise<{}>

    Promise which resolves: TODO

  • Begin a key verification.

    Parameters

    • method: string

      the verification method to use

    • userId: string

      the user to verify keys with

    • deviceId: string

      the device to verify

    Returns VerificationBase<any, any>

    a verification object

    Deprecated

    Use requestVerification instead.

  • 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.

    Parameters

    • data: IBindThreePidBody

      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.

    Returns Promise<{}>

    Promise which resolves: to an empty object {}

  • Bootstrap cross-signing by creating keys if needed. If everything is already set up, then no changes are made, so this is safe to run to ensure cross-signing is ready for use.

    This function:

    • creates new cross-signing keys if they are not found locally cached nor in secret storage (if it has been set up)

    Returns Promise<void>

  • Bootstrap Secure Secret Storage if needed by creating a default key. If everything is already set up, then no changes are made, so this is safe to run to ensure secret storage is ready for use.

    This function

    • creates a new Secure Secret Storage key if no default key exists
      • if a key backup exists, it is migrated to store the key in the Secret Storage
    • creates a backup if none exists, and one is requested
    • migrates Secure Secret Storage to use the latest algorithm, if an outdated algorithm is found

    Parameters

    Returns Promise<void>

  • Looks up the public Matrix ID mappings for multiple 3PIDs.

    Parameters

    • query: [string, string][]

      Array of arrays containing [medium, address]

    • identityAccessToken: string

      The access_token field of the Identity Server /account/register response (see registerWithIdentityServer).

    Returns Promise<{
        threepids: [medium: string, address: string, mxid: string][];
    }>

    Promise which resolves: Lookup results from IS.

  • Cancel a room key request for this event if one is ongoing and resend the request.

    Parameters

    • event: MatrixEvent

      event of which to cancel and resend the room key request.

    Returns Promise<void>

    A promise that will resolve when the key request is queued

  • Cancel a queued or unsent event.

    Parameters

    Returns void

    Throws

    Error if the event is not in QUEUED, NOT_SENT or ENCRYPTING state

  • Cancel a file upload in progress

    Parameters

    Returns boolean

    true if canceled, otherwise false

  • Checks that a given cross-signing private key matches a given public key. This can be used by the getCrossSigningKey callback to verify that the private key it is about to supply is the one that was requested.

    Parameters

    • privateKey: Uint8Array

      The private key

    • expectedPublicKey: string

      The public key

    Returns boolean

    true if the key matches, otherwise false

  • Check whether one of our own devices is cross-signed by our user's stored keys, regardless of whether we trust those keys yet.

    Parameters

    • deviceId: string

      The ID of the device to check

    Returns boolean

    true if the device is cross-signed

  • Check the copy of our cross-signing key that we have in the device list and see if we can get the private key. If so, mark it as trusted.

    Parameters

    Returns Promise<void>

    Deprecated

    Unneeded for the new crypto

  • Checks that a given secret storage private key matches a given public key. This can be used by the getSecretStorageKey callback to verify that the private key it is about to supply is the one that was requested.

    The Secure Secret Storage API is currently UNSTABLE and may change without notice.

    Parameters

    • privateKey: Uint8Array

      The private key

    • expectedPublicKey: string

      The public key

    Returns boolean

    true if the key matches, otherwise false

    Deprecated

    The use of asymmetric keys for SSSS is deprecated. Use SecretStorage.ServerSideSecretStorage#checkKey for symmetric keys.

  • Claim one-time keys

    Parameters

    • devices: [string, string][]

      a list of [userId, deviceId] pairs

    • keyAlgorithm: string = "signed_curve25519"

      desired key type

    • Optional timeout: number

      the time (in milliseconds) to wait for keys from remote servers

    Returns Promise<IClaimOTKsResult>

    Promise which resolves: result object. Rejects: with an error response (MatrixError).

  • Clear any data out of the persistent stores used by the client.

    Returns Promise<void>

    Promise which resolves when the stores have been cleared.

  • Counts the number of end to end session keys that are waiting to be backed up

    Returns Promise<number>

    Promise which resolves to the number of sessions requiring backup

  • Create an alias to room ID mapping.

    Parameters

    • alias: string

      The room alias to create.

    • roomId: string

      The room ID to link the alias to.

    Returns Promise<{}>

    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

    Parameters

    • roomId: string

      The room the call is to be placed in.

    Returns null | MatrixCall

    the call or null if the browser doesn't support calling.

  • Creates a new dehydrated device (without queuing periodic dehydration)

    Parameters

    • key: Uint8Array

      the dehydration key

    • keyInfo: IDehydratedDeviceKeyInfo

      Information about the key. Primarily for information about how to generate the key from a passphrase.

    • Optional deviceDisplayName: string

      The device display name for the dehydrated device.

    Returns Promise<undefined | string>

    the device id of the newly created dehydrated device

  • 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

    Parameters

    • roomId: string
    • fromToken: null | string
    • limit: number = 30

      the maximum amount of events the retrieve

    • dir: Direction

      'f' or 'b'

    • Optional timelineFilter: Filter

      the timeline filter to pass

    Returns Promise<IMessagesResponse>

  • Create a recovery key from a user-supplied passphrase.

    The Secure Secret Storage API is currently UNSTABLE and may change without notice.

    Parameters

    • Optional password: string

      Passphrase string that can be entered by the user when restoring the backup as an alternative to entering the recovery key. Optional.

    Returns Promise<GeneratedSecretStorageKey>

    Object with public key metadata, encoded private recovery key which should be disposed of after displaying to the user, and raw private key to avoid round tripping if needed.

  • Create a new room.

    Parameters

    Returns Promise<{
        room_id: string;
    }>

    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

    Parameters

    • roomId: string
    • fromToken: null | string
    • limit: number = 30

      the maximum amount of events the retrieve

    • dir: Direction = Direction.Backward

      'f' or 'b'

    • threadListType: null | ThreadFilterType = ThreadFilterType.All
    • Optional timelineFilter: Filter

      the timeline filter to pass

    Returns Promise<IMessagesResponse>

  • 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.

    Parameters

    • Optional auth: AuthDict

      Optional. Auth data to supply for User-Interactive auth.

    • Optional erase: boolean

      Optional. If set, send as erase attribute in the JSON request body, indicating whether the account should be erased. Defaults to false.

    Returns Promise<{
        id_server_unbind_result: IdServerUnbindResult;
    }>

    Promise which resolves: On success, the empty object

  • 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.

    Parameters

    • alias: string

      The room alias to delete.

    Returns Promise<{}>

    Promise which resolves: an empty object {}.

  • Delete the given device

    Parameters

    • deviceId: string

      device to delete

    • Optional auth: AuthDict

      Optional. Auth data to supply for User-Interactive auth.

    Returns Promise<{}>

    Promise which resolves: result object

  • Parameters

    • roomId: undefined
    • sessionId: undefined
    • Optional version: string

    Returns Promise<void>

  • Parameters

    • roomId: string
    • sessionId: undefined
    • Optional version: string

    Returns Promise<void>

  • Parameters

    • roomId: string
    • sessionId: string
    • Optional version: string

    Returns Promise<void>

  • Delete multiple device

    Parameters

    • devices: string[]

      IDs of the devices to delete

    • Optional auth: AuthDict

      Optional. Auth data to supply for User-Interactive auth.

    Returns Promise<{}>

    Promise which resolves: result object

  • Parameters

    • roomId: string
    • tagName: string

      name of room tag to be removed

    Returns Promise<{}>

    Promise which resolves: to an empty object

  • Parameters

    • medium: string

      The threepid medium (eg. 'email')

    • address: string

      The threepid address (eg. 'bob@example.com') this must be as returned by getThreePids.

    Returns Promise<{
        id_server_unbind_result: IdServerUnbindResult;
    }>

    Promise which resolves: The server response on success (generally the empty JSON object)

  • Disable backing up of keys.

    Returns void

    Deprecated

    It should be unnecessary to disable key backup.

  • Query the server to see if it is forcing encryption to be enabled for a given room preset, based on the /versions response.

    Parameters

    • presetName: Preset

      The name of the preset to check.

    Returns Promise<boolean>

    true if the server is forcing encryption for the preset.

  • Query the server to see if it lists support for an unstable feature in the /versions response

    Parameters

    • feature: string

      the feature name

    Returns Promise<boolean>

    true if the feature is supported

  • Download the keys for a list of users and stores the keys in the session store.

    Parameters

    • userIds: string[]

      The users to fetch.

    • Optional forceDownload: boolean

      Always download the keys even if cached.

    Returns Promise<DeviceInfoMap>

    A promise which resolves to a map userId->deviceId->DeviceInfo

    Deprecated

    Prefer CryptoApi.getUserDeviceInfo

  • Download device keys

    Parameters

    • userIds: string[]

      list of users to get keys for

    • token: {
          token?: string;
      } = {}

      sync token to pass in the query request, to help the HS give the most recent results

      • Optional token?: string

    Returns Promise<IDownloadKeyResult>

    Promise which resolves: result object. Rejects: with an error response (MatrixError).

  • Encrypts and sends a given object via Olm to-device messages to a given set of devices.

    Parameters

    • userDeviceInfoArr: IOlmDevice<DeviceInfo>[]

      list of deviceInfo objects representing the devices to send to

    • payload: object

      fields to include in the encrypted payload

    Returns Promise<void>

    Promise which resolves once the message has been encrypted and sent to the given userDeviceMap, and returns the { contentMap, deviceInfoByDeviceId } of the successfully sent messages.

  • Fetches relations for a given event

    Parameters

    • roomId: string

      the room of the event

    • eventId: string

      the id of the event

    • relationType: null | string

      the rel_type of the relations requested

    • Optional eventType: null | string

      the event type of the relations requested

    • opts: IRelationsRequestOpts = ...

      options with optional values for the request.

    Returns Promise<IRelationsResponse>

    the response, with chunk, prev_batch and, next_batch.

  • Parameters

    • room: Room
    • verifyLinks: boolean
    • msc3946ProcessDynamicPredecessor: boolean

    Returns Room[]

  • Parameters

    • room: Room
    • verifyLinks: boolean
    • msc3946ProcessDynamicPredecessor: boolean

    Returns Room[]

  • Once the client has been initialised, we want to clear notifications we know for a fact should be here. This issue should also be addressed on synapse's side and is tracked as part of https://github.com/matrix-org/synapse/issues/14837

    We consider a room or a thread as fully read if the current user has sent the last event in the live timeline of that context and if the read receipt we have on record matches.

    Returns void

  • Marks all group sessions as needing to be backed up without scheduling them to upload in the background.

    (This is done automatically as part of CryptoApi.resetKeyBackup, so there is probably no need to call this manually.)

    Returns Promise<number>

    Promise which resolves to the number of sessions requiring a backup.

  • Forces the current outbound group session to be discarded such that another one will be created next time an event is sent.

    Parameters

    • roomId: string

      The ID of the room to discard the session for

    Returns void

  • Parameters

    • roomId: string
    • deleteRoom: boolean = true

      True to delete the room from the store on success. Default: true.

    Returns Promise<{}>

    Promise which resolves: {} an empty object.

  • Generates a random string suitable for use as a client secret. This method is experimental and may change.

    Returns string

    A new client secret

  • Get the access token associated with this account.

    Returns null | string

    The access_token or null

  • Get account data event of given type for the current user.

    Parameters

    • eventType: string

      The event type

    Returns undefined | MatrixEvent

    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.

    Type Parameters

    • T extends {
          [k: string]: any;
      }

    Parameters

    • eventType: string

      The event type

    Returns Promise<null | T>

    Promise which resolves: The contents of the given account data event.

  • Experimental

    Get the OIDC issuer responsible for authentication on this server, if any

    Returns Promise<{
        issuer: string;
    }>

    Resolves: A promise of an object containing the OIDC issuer if configured

  • Gets the capabilities of the homeserver. Always returns an object of capability keys and their options, which may be empty.

    Parameters

    • fresh: boolean = false

      True to ignore any cached values.

    Returns Promise<Capabilities>

    Promise which resolves to the capabilities of the homeserver

  • Parameters

    • redirectUrl: string

      The URL to redirect to after the HS authenticates with CAS.

    Returns string

    The HS URL to hit to begin the CAS login process.

  • Get the ID of one of the user's cross-signing keys

    Parameters

    • type: string = CrossSigningKey.Master

      The type of key to get the ID of. One of "master", "self_signing", or "user_signing". Defaults to "master".

    Returns null | string

    the key ID

  • Access the crypto API for this client.

    If end-to-end encryption has been enabled for this client (via initCrypto or initRustCrypto), returns an object giving access to the crypto API. Otherwise, returns undefined.

    Returns undefined | CryptoApi

  • Whether to trust a others users signatures of their devices. If false, devices will only be considered 'verified' if we have verified that device individually (effectively disabling cross-signing).

    Default: true

    Returns boolean

    True if trusting cross-signed devices

  • Get a list of all file uploads in progress

    Returns Upload[]

    Array of objects representing current uploads. Currently in progress is element 0. Keys:

    • promise: The promise associated with the upload
    • loaded: Number of bytes uploaded
    • total: Total number of bytes to upload
  • Get the Curve25519 key for this device

    Returns null | string

    base64-encoded curve25519 key. Null if crypto is disabled.

  • Get the Ed25519 key for this device

    Returns null | string

    base64-encoded ed25519 key. Null if crypto is disabled.

    Deprecated

    Prefer CryptoApi.getOwnDeviceKeys

  • Get the device ID of this client

    Returns null | string

    device ID

  • Get the domain for this client's MXID

    Returns null | string

    Domain of this MXID

  • Returns the eventType that should be used taking encryption into account for a given eventType.

    Parameters

    • roomId: string

      the room for the events eventType relates to

    • Optional eventType: null | string

      the event type

    Returns undefined | null | string

    the event type taking encryption into account

  • Get 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.

    Parameters

    • timelineSet: EventTimelineSet

      The timelineSet to look for the event in, must be bound to a room

    • eventId: string

      The ID of the event to look for

    Returns Promise<Optional<EventTimeline>>

    Promise which resolves: EventTimeline including the given event

  • Get the fallback URL to use for unknown interactive-auth stages.

    Parameters

    • loginType: string

      the type of stage being attempted

    • authSessionId: string

      the auth session ID provided by the homeserver

    Returns string

    HS URL to hit to for the fallback interface

  • Retrieve a filter.

    Parameters

    • userId: string

      The user ID of the filter owner

    • filterId: string

      The filter ID to retrieve

    • allowCached: boolean

      True to allow cached filters to be returned. Default: True.

    Returns Promise<Filter>

    Promise which resolves: a Filter object

  • Returns boolean

    whether to error on unknown devices

    This API is currently UNSTABLE and may change or be removed without notice.

  • Get an existing group call for the provided room.

    Parameters

    • roomId: string

    Returns null | GroupCall

    The group call or null if it doesn't already exist.

  • Get the Homeserver URL of this client

    Returns string

    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.

    Parameters

    • identityAccessToken: string

      The access_token field of the Identity Server /account/register response (see registerWithIdentityServer).

    Returns Promise<{
        user_id: string;
    }>

    Promise which resolves: an object with account info.

  • Gets the V2 hashing information from the identity server. Primarily useful for lookups.

    Parameters

    • identityAccessToken: string

      The access token for the identity server.

    Returns Promise<{
        algorithms: string[];
        lookup_pepper: string;
    }>

    The hashing information for the identity server.

  • Get the identity server URL of this client

    Parameters

    • stripProto: boolean = false

      whether or not to strip the protocol from the URL

    Returns undefined | string

    Identity server URL of this client

  • Gets the users that are ignored by this client

    Returns string[]

    The array of users that are ignored (empty if none)

  • Returns null | boolean

    true if the client is configured to back up keys to the server, otherwise false. If we haven't completed a successful check of key backup status yet, returns null.

    Deprecated

    Prefer direct access to CryptoApi.getActiveSessionBackupVersion:

    let enabled = (await client.getCrypto().getActiveSessionBackupVersion()) !== null;
    
  • Get information about the current key backup from the server.

    Performs some basic validity checks on the shape of the result, and raises an error if it is not as expected.

    Note: there is no (supported) way to distinguish between "failure to talk to the server" and "another client uploaded a key backup version using an algorithm I don't understand.

    Returns Promise<null | KeyBackupInfo>

    Information object from API, or null if no backup is present on the server.

  • Ask the server for a list of users who have changed their device lists between a pair of sync tokens

    Parameters

    • oldToken: string
    • newToken: string

    Returns Promise<{
        changed: string[];
        left: string[];
    }>

    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.

    Parameters

    Returns Promise<Optional<EventTimeline>>

    Promise which resolves: EventTimeline timeline with the latest events in the room

  • Returns undefined | string

  • 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.

    Parameters

    • roomId: string

      The room ID to get local aliases for.

    Returns Promise<{
        aliases: string[];
    }>

    Promise which resolves: an object with an aliases property, containing an array of local aliases

  • 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.

    Returns Promise<IOpenIDToken>

    Promise which resolves: Token object

  • Parameters

    • userId: string
    • Optional info: string

      The kind of info to retrieve (e.g. 'displayname', 'avatar_url').

    Returns Promise<{
        avatar_url?: string;
        displayname?: string;
    }>

    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.

    Parameters

    • event: MatrixEvent

      The event to get push actions for.

    • forceRecalculate: boolean = false

      forces to recalculate actions for an event Useful when an event just got decrypted

    Returns null | IActionsObject

    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.

    Parameters

    • event: MatrixEvent

      The event to get push actions for.

    • forceRecalculate: boolean = false

      forces to recalculate actions for an event Useful when an event just got decrypted

    Returns null | PushDetails

    A dict of actions to perform.

  • Gets all pushers registered for the logged-in user

    Returns Promise<{
        pushers: IPusher[];
    }>

    Promise which resolves: Array of objects representing pushers

  • Get the refresh token associated with this account.

    Returns null | string

    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.

    Parameters

    • roomId: undefined | string

      The room ID

    Returns null | Room

    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

    Parameters

    • roomId: string

    Returns Promise<{
        visibility: Visibility;
    }>

    Promise which resolves: TODO

  • Fetches or paginates a room hierarchy as defined by MSC2946. Falls back gracefully to sourcing its data from getSpaceSummary if this API is not yet supported by the server.

    Parameters

    • roomId: string

      The ID of the space-room to use as the root of the summary.

    • Optional limit: number

      The maximum number of rooms to return per page.

    • Optional maxDepth: number

      The maximum depth in the tree from the root room to return.

    • suggestedOnly: boolean = false

      Whether to only return rooms with suggested=true.

    • Optional fromToken: string

      The opaque token to paginate a previous request.

    Returns Promise<IRoomHierarchy>

    the response, with next_batch & rooms fields.

  • Get room info for the given alias.

    Parameters

    • alias: string

      The room alias to resolve.

    Returns Promise<{
        room_id: string;
        servers: string[];
    }>

    Promise which resolves: Object with room_id and servers.

  • Get the room-kind push rule associated with a room.

    Parameters

    • scope: "global" | "device"

      "global" or device-specific.

    • roomId: string

      the id of the room.

    Returns undefined | IPushRule

    the rule or undefined.

  • 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.

    Parameters

    • roomId: string

      The room ID to search from

    • verifyLinks: boolean = false

      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.

    • msc3946ProcessDynamicPredecessor: boolean = false

      if true, look for m.room.predecessor state events as well as create events, and prefer predecessor events where they exist (MSC3946).

    Returns Room[]

    An array of rooms representing the upgrade history.

  • Retrieve all known rooms.

    Returns Room[]

    A list of rooms, or an empty list if there is no data store.

  • Get the user-id of the logged-in user

    Returns string

    MXID for the logged-in user

    Throws

    Error if not logged in

  • Get the session ID of this client

    Returns string

    session ID

  • Parameters

    • redirectUrl: string

      The URL to redirect to after the HS authenticates with the SSO.

    • loginType: string = "sso"

      The type of SSO login we are doing (sso or cas). Defaults to 'sso'.

    • Optional idpId: string

      The ID of the Identity Provider being targeted, optional.

    • Optional action: SSOAction

      the SSO flow to indicate to the IdP, optional.

    Returns string

    The HS URL to hit to begin the SSO login process.

  • Retrieve a state event.

    Parameters

    • roomId: string
    • eventType: string
    • stateKey: string

    Returns Promise<Record<string, any>>

    Promise which resolves: TODO

  • 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.

    Returns null | SyncStateData

  • Get information on how a specific place on a third party protocol may be reached.

    Parameters

    • protocol: string

      The protocol given in getThirdpartyProtocols()

    • params: {
          searchFields?: string[];
      }

      Protocol-specific parameters, as given in the response to getThirdpartyProtocols()

      • Optional searchFields?: string[]

    Returns Promise<IThirdPartyLocation[]>

    Promise which resolves to the result object

  • Get the third party protocols that can be reached using this HS

    Returns Promise<{
        [protocol: string]: IProtocol;
    }>

    Promise which resolves to the result object

  • Get information on how a specific user on a third party protocol may be reached.

    Parameters

    • protocol: string

      The protocol given in getThirdpartyProtocols()

    • Optional params: QueryDict

      Protocol-specific parameters, as given in the response to getThirdpartyProtocols()

    Returns Promise<IThirdPartyUser[]>

    Promise which resolves to the result object

  • This method calculates the total number of keys present in the response of a /room_keys/keys call.

    Parameters

    Returns number

    The total number of keys in the backup.

  • Get the unix timestamp (in milliseconds) at which the current TURN credentials (from getTurnServers) expire

    Returns number

    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.

    Parameters

    • url: string

      The URL to get preview data for

    • ts: number

      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.

    Returns Promise<IPreviewUrlResponse>

    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.

    Returns boolean

    boolean Whether group call signalling will be encrypted

  • Retrieve a user.

    Parameters

    • userId: string

      The user ID to retrieve.

    Returns null | User

    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

    Returns null | string

    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".

    Returns null | string

    The user ID localpart or null.

  • Retrieve all known users.

    Returns User[]

    A list of users, or an empty list if there is no data store.

  • 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.

    Parameters

    • msc3946ProcessDynamicPredecessor: boolean = false

      if true, look for an m.room.predecessor state event and use it if found (MSC3946).

    Returns Room[]

    A list of rooms, or an empty list if there is no data store.

  • This method handles the decryption of a full backup, i.e a call to /room_keys/keys. It will decrypt the keys in chunks and call the block callback for each chunk.

    Parameters

    • res: IRoomsKeysResponse

      The response from the server containing the keys to be decrypted.

    • backupDecryptor: BackupDecryptor

      An instance of the BackupDecryptor class used to decrypt the keys.

    • chunkSize: number

      The size of the chunks to be processed at a time.

    • block: ((chunk) => Promise<void>)

      A callback function that is called for each chunk of keys.

    Returns Promise<void>

    A promise that resolves when the decryption is complete.

  • Get if lazy loading members is being used.

    Returns boolean

    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.

    Parameters

    • addressPairs: [string, string][]

      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"]

    • identityAccessToken: string

      The access token for the identity server.

    Returns Promise<{
        address: string;
        mxid: string;
    }[]>

    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 libolm.

    You should call this method after creating the matrixclient, but before calling startClient, if you want to support end-to-end encryption.

    It will return a Promise which will resolve when the crypto layer has been successfully initialised.

    Returns Promise<void>

  • Experimental

    Initialise support for end-to-end encryption in this client, using the rust matrix-sdk-crypto.

    An alternative to initCrypto.

    WARNING: this API is very experimental, should not be used in production, and may change without notice! Eventually it will be deprecated and initCrypto will do the same thing.

    Parameters

    • useIndexedDB: {
          useIndexedDB?: boolean;
      } = {}

      True to use an indexeddb store, false to use an in-memory store. Defaults to 'true'.

      • Optional useIndexedDB?: boolean

    Returns Promise<void>

    a Promise which will resolve when the crypto layer has been successfully initialised.

  • Parameters

    • roomId: string
    • userId: string
    • Optional reason: string

      Optional.

    Returns Promise<{}>

    Promise which resolves: {} an empty object.

  • Invite a user to a room based on their email address.

    Parameters

    • roomId: string

      The room to invite the user to.

    • email: string

      The email address to invite.

    Returns Promise<{}>

    Promise which resolves: {} an empty object.

  • Invite a user to a room based on a third-party identifier.

    Parameters

    • roomId: string

      The room to invite the user to.

    • medium: string

      The medium to invite the user e.g. "email".

    • address: string

      The address for the specified medium.

    Returns Promise<{}>

    Promise which resolves: {} an empty object.

  • Checks whether cross signing:

    • is enabled on this account and trusted by this device
    • has private keys either cached locally or stored in secret storage

    If this function returns false, bootstrapCrossSigning() can be used to fix things such that it returns true. That is to say, after bootstrapCrossSigning() completes successfully, this function should return true.

    Returns Promise<boolean>

    True if cross-signing is ready to be used on this device

  • Is end-to-end crypto enabled for this client.

    Returns boolean

    True if end-to-end is enabled.

    Deprecated

    prefer getCrypto

  • 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.

    Returns boolean

  • Return whether the client is configured for a guest account.

    Returns boolean

    True if this is a guest access_token (or no token is supplied).

  • Whether the initial sync has completed.

    Returns boolean

    True if at least one sync has happened.

  • Returns boolean

    true if there is a valid access_token for this client.

  • Checks whether secret storage:

    • is enabled on this account
    • is storing cross-signing private keys
    • is storing session backup key (if enabled)

    If this function returns false, bootstrapSecretStorage() can be used to fix things such that it returns true. That is to say, after bootstrapSecretStorage() completes successfully, this function should return true.

    Returns Promise<boolean>

    True if secret storage is ready to be used on this device

  • 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.

    Returns Promise<boolean>

    true if the user appears to be a Synapse administrator.

  • Gets whether or not a specific user is being ignored by this client.

    Parameters

    • userId: string

      the user ID to check

    Returns boolean

    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.

    Parameters

    • username: string

      The username to check the availability of.

    Returns Promise<boolean>

    Promise which resolves: to boolean of whether the username is available.

  • Parameters

    • recoveryKey: string

    Returns boolean

  • Check if a particular spec version is supported by the server.

    Parameters

    • version: string

      The spec version (such as "r0.5.0") to check for.

    Returns Promise<boolean>

    Whether it is supported

  • Join a room. If you have already joined the room, this will no-op.

    Parameters

    • roomIdOrAlias: string

      The room ID or room alias to join.

    • opts: IJoinRoomOpts = {}

      Options when joining the room.

    Returns Promise<Room>

    Promise which resolves: Room object.

  • Get the raw key for a key backup from the password Used when migrating key backups into SSSS

    The cross-signing API is currently UNSTABLE and may change without notice.

    Parameters

    • password: string

      Passphrase

    • backupInfo: KeyBackupInfo

      Backup metadata from checkKeyBackup

    Returns Promise<Uint8Array>

    key backup key

  • Get the raw key for a key backup from the recovery key Used when migrating key backups into SSSS

    The cross-signing API is currently UNSTABLE and may change without notice.

    Parameters

    • recoveryKey: string

      The recovery key

    Returns Uint8Array

    key backup key

  • Parameters

    • roomId: string
    • userId: string
    • Optional reason: string

      Optional.

    Returns Promise<{}>

    Promise which resolves: {} an empty object.

  • Knock a room. If you have already knocked the room, this will no-op.

    Parameters

    • roomIdOrAlias: string

      The room ID or room alias to knock.

    • opts: KnockRoomOpts = {}

      Options when knocking the room.

    Returns Promise<{
        room_id: string;
    }>

    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.

    Parameters

    • roomId: string

      The room ID to start leaving at

    • includeFuture: boolean = true

      If true, the whole chain (past and future) of upgraded rooms will be left.

    Returns Promise<{
        [roomId: string]: Error | MatrixError | null;
    }>

    Promise which resolves when completed with an object keyed by room ID and value of the error encountered when leaving or null.

  • 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.

    Parameters

    • stopClient: boolean = false

      whether to stop the client before calling /logout to prevent invalid token errors.

    Returns Promise<{}>

    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

    Parameters

    • medium: string

      The medium of the threepid, eg. 'email'

    • address: string

      The textual address of the threepid

    • identityAccessToken: string

      The access_token field of the Identity Server /account/register response (see registerWithIdentityServer).

    Returns Promise<{} | {
        address: string;
        medium: string;
        mxid: string;
    }>

    Promise which resolves: A threepid mapping object or the empty object if no mapping exists

  • Make up a new transaction id

    Returns string

    a new, unique, transaction id

  • Parameters

    • roomId: string
    • Optional includeMembership: string

      the membership type to include in the response

    • Optional excludeMembership: string

      the membership type to exclude from the response

    • Optional atEventId: string

      the id of the event for which moment in the timeline the members should be returned for

    Returns Promise<{
        [userId: string]: IStateEventWithRoomId[];
    }>

    Promise which resolves: dictionary of userid to profile information

  • Parameters

    • roomId: string
    • userId: undefined | string
    • membership: string
    • Optional reason: string

    Returns Promise<{}>

  • Turn an MXC URL into an HTTP one. This method is experimental and may change.

    Parameters

    • mxcUrl: string

      The MXC URL

    • Optional width: number

      The desired width of the thumbnail.

    • Optional height: number

      The desired height of the thumbnail.

    • Optional resizeMethod: string

      The thumbnail resize method to use, either "crop" or "scale".

    • Optional allowDirectLinks: boolean

      If 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.

    • Optional allowRedirects: boolean

      If true, the caller supports the URL being 307 or 308 redirected to another resource upon request. If false, redirects are not expected.

    Returns null | string

    the avatar URL or null.

  • 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 TypedEventEmitter#prependListener method can be used as an alternative to add the event listener to the beginning of the listeners array.

    Type Parameters

    Parameters

    Returns this

    a reference to the EventEmitter, so that calls can be chained.

  • Take an EventTimeline, and back/forward-fill results.

    Parameters

    Returns Promise<boolean>

    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.

    Parameters

    • roomId: string

      The room to attempt to peek into.

    Returns Promise<Room>

    Promise which resolves: Room object

  • Set up the data required to create a new backup version. The backup version will not be created and enabled until createKeyBackupVersion is called.

    Parameters

    • Optional password: null | string | Uint8Array

      Passphrase string that can be entered by the user when restoring the backup as an alternative to entering the recovery key. Optional.

    • opts: IKeyBackupPrepareOpts = ...

    Returns Promise<Pick<IPreparedKeyBackupVersion, "algorithm" | "auth_data" | "recovery_key">>

    Object that can be passed to createKeyBackupVersion and additionally has a 'recovery_key' member with the user-facing recovery key string.

    Deprecated

    Use CryptoApi.resetKeyBackup.

  • Perform any background tasks that can be done before a message is ready to send, in order to speed up sending of the message.

    Parameters

    • room: Room

      the room the event is in

    Returns void

    Deprecated

    Prefer CryptoApi.prepareToEncrypt:

    client.getCrypto().prepareToEncrypt(room);
    
  • Calls aggregation functions for event types that are aggregated Polls and location beacons

    Parameters

    • Optional room: Room

      room the events belong to

    • Optional events: MatrixEvent[]

      timeline events to be processed

    Returns void

  • Internal

    helper for searchRoomEvents and backPaginateRoomEventsSearch. Processes the response from the API call and updates the searchResults

    Type Parameters

    Parameters

    Returns T

    searchResults

  • Processes a list of threaded events and adds them to their respective timelines

    Parameters

    • room: Room

      the room the adds the threaded events

    • threadedEvents: MatrixEvent[]

      an array of the threaded events

    • toStartOfTimeline: boolean

      the direction in which we want to add the events

    Returns void

  • Processes a list of thread roots and creates a thread model

    Parameters

    • room: Room

      the room to create the threads in

    • threadedEvents: MatrixEvent[]

      an array of thread roots

    • toStartOfTimeline: boolean

      the direction

    Returns void

  • 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.

    Parameters

    Returns Promise<void>

  • 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.

    Parameters

    • refreshToken: string

      The refresh token.

    Returns Promise<IRefreshTokenResponse>

    Promise which resolves to the new token.

  • Parameters

    • username: string
    • password: string
    • sessionId: null | string
    • auth: {
          session?: string;
          type: string;
      }
      • Optional session?: string
      • type: string
    • Optional bindThreepids: null | boolean | {
          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.

    • Optional guestAccessToken: string
    • Optional inhibitLogin: boolean

    Returns Promise<RegisterResponse>

    Promise 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);

    Parameters

    Returns Promise<RegisterResponse>

    Promise which resolves: JSON object that contains: { user_id, device_id, access_token, home_server }

  • 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.

    Parameters

    Returns Promise<{
        access_token: string;
        token: string;
    }>

    Promise which resolves: with object containing an Identity Server access token.

  • Try to rehydrate a device if available. The client must have been initialized with a cryptoCallback.getDehydrationKey option, and this function must be called before initCrypto and startClient are called.

    Returns Promise<undefined | string>

    Promise which resolves to undefined if a device could not be dehydrated, or to the new device ID if the dehydration was successful.

  • 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.

    Parameters

    • roomId: string

      the room of the event

    • eventId: string

      the id of the event

    • relationType: null | string

      the rel_type of the relations requested

    • Optional eventType: null | string

      the event type of the relations requested

    • opts: IRelationsRequestOpts = ...

      options with optional values for the request.

    Returns Promise<{
        events: MatrixEvent[];
        nextBatch?: null | string;
        originalEvent?: null | MatrixEvent;
        prevBatch?: null | string;
    }>

    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).

    Parameters

    Returns this

    a reference to the EventEmitter, so that calls can be chained.

  • Removes an existing pusher

    Parameters

    • pushKey: string

      pushkey of pusher to remove

    • appId: string

      app_id of pusher to remove

    Returns Promise<{}>

    Promise which resolves: Empty json object on success

  • Reports an event as inappropriate to the server, which may then notify the appropriate people.

    Parameters

    • roomId: string

      The room in which the event being reported is located.

    • eventId: string

      The event to report.

    • score: number

      The score to rate this content as where -100 is most offensive and 0 is inoffensive.

    • reason: string

      The reason the content is being reported. May be blank.

    Returns Promise<{}>

    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).

    Parameters

    • email: string

      As requestEmailToken

    • clientSecret: string

      As requestEmailToken

    • sendAttempt: number

      As requestEmailToken

    • Optional nextLink: string

      As requestEmailToken

    Returns Promise<IRequestTokenResponse>

    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.

    Parameters

    • phoneCountry: string

      As requestRegisterMsisdnToken

    • phoneNumber: string

      As requestRegisterMsisdnToken

    • clientSecret: string

      As requestEmailToken

    • sendAttempt: number

      As requestEmailToken

    • Optional nextLink: string

      As requestEmailToken

    Returns Promise<IRequestMsisdnTokenResponse>

    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.

    Parameters

    • email: string

      The email address to request a token for

    • clientSecret: string

      A secret binary string generated by the client. It is recommended this be around 16 ASCII characters.

    • sendAttempt: number

      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.

    • Optional nextLink: string

      Optional If specified, the client will be redirected to this link after validation.

    • Optional identityAccessToken: string

      The access_token field of the identity server /account/register response (see registerWithIdentityServer).

    Returns Promise<IRequestTokenResponse>

    Promise which resolves: TODO

    Throws

    Error if no identity server is set

  • 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.

    Parameters

    • phoneCountry: string

      The ISO 3166-1 alpha-2 code for the country in which phoneNumber should be parsed relative to.

    • phoneNumber: string

      The phone number, in national or international format

    • clientSecret: string

      A secret binary string generated by the client. It is recommended this be around 16 ASCII characters.

    • sendAttempt: number

      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.

    • Optional nextLink: string

      Optional If specified, the client will be redirected to this link after validation.

    • Optional identityAccessToken: string

      The access_token field of the Identity Server /account/register response (see registerWithIdentityServer).

    Returns Promise<IRequestMsisdnTokenResponse>

    Promise which resolves to an object with a sid string

    Throws

    Error if no identity server is set

  • 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.

    Parameters

    • email: string

      As requestEmailToken

    • clientSecret: string

      As requestEmailToken

    • sendAttempt: number

      As requestEmailToken

    • Optional nextLink: string

      As requestEmailToken

    Returns Promise<IRequestTokenResponse>

    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.

    Parameters

    • phoneCountry: string

      As requestRegisterMsisdnToken

    • phoneNumber: string

      As requestRegisterMsisdnToken

    • clientSecret: string

      As requestEmailToken

    • sendAttempt: number

      As requestEmailToken

    • nextLink: string

      As requestEmailToken

    Returns Promise<IRequestMsisdnTokenResponse>

    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

    Parameters

    • email: string

      As requestEmailToken

    • clientSecret: string

      As requestEmailToken

    • sendAttempt: number

      As requestEmailToken

    • Optional nextLink: string

      As requestEmailToken

    Returns Promise<IRequestTokenResponse>

    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.

    Parameters

    • phoneCountry: string

      The ISO 3166-1 alpha-2 code for the country in which phoneNumber should be parsed relative to.

    • phoneNumber: string

      The phone number, in national or international format

    • clientSecret: string

      As requestEmailToken

    • sendAttempt: number

      As requestEmailToken

    • Optional nextLink: string

      As requestEmailToken

    Returns Promise<IRequestMsisdnTokenResponse>

    Promise which resolves: As requestEmailToken

  • Request a secret from another device.

    The Secure Secret Storage API is currently UNSTABLE and may change without notice.

    Parameters

    • name: string

      the name of the secret to request

    • devices: string[]

      the devices to request the secret from

    Returns ISecretRequest

    the secret request object

  • Internal utility function for requesting validation tokens from usage-specific requestToken endpoints.

    Type Parameters

    Parameters

    • endpoint: string

      The endpoint to send the request to

    • params: QueryDict

      Parameters for the POST request

    Returns Promise<T>

    Promise which resolves: As requestEmailToken

  • Reset the notifTimelineSet entirely, paginating in some historical notifs as a starting point for subsequent pagination.

    Returns void

  • Parameters

    • roomAlias: string

    Returns Promise<{
        room_id: string;
        servers: string[];
    }>

    Promise which resolves: Object with room_id and servers.

    Deprecated

    use getRoomIdForAlias instead

  • Restore from an existing key backup via a private key stored in secret storage.

    Parameters

    • backupInfo: KeyBackupInfo

      Backup metadata from checkKeyBackup

    • Optional targetRoomId: string

      Room ID to target a specific room. Restores all rooms if omitted.

    • Optional targetSessionId: string

      Session ID to target a specific session. Restores all sessions if omitted.

    • Optional opts: IKeyBackupRestoreOpts

      Optional params such as callbacks

    Returns Promise<IKeyBackupRestoreResult>

    Status of restoration with total and imported key counts.

  • 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).

    Returns boolean

    True if this resulted in a request being retried.

  • Marks all group sessions as needing to be backed up and schedules them to upload in the background as soon as possible.

    (This is done automatically as part of CryptoApi.resetKeyBackup, so there is probably no need to call this manually.)

    Returns Promise<void>

  • 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).

    Parameters

    • room: Room

      The room to get older messages in.

    • limit: number = 30

      Optional. The maximum number of previous events to pull in. Default: 30.

    Returns Promise<Room>

    Promise which resolves: Room. If you are at the beginning of the timeline, Room.oldState.paginationToken will be null.

  • Perform a server-side search for room events.

    The returned promise resolves to an object containing the fields:

    • count: estimate of the number of results
    • next_batch: token for back-pagination; if undefined, there are no more results
    • highlights: a list of words to highlight from the stemming algorithm
    • results: a list of results

    Each entry in the results list is a SearchResult.

    Parameters

    Returns Promise<ISearchResults>

    Promise which resolves: result object

  • Query the user directory with a term matching user IDs, display names and domains.

    Parameters

    • options: {
          limit?: number;
          term: string;
      }
      • Optional limit?: number

        the maximum number of results to return. The server will apply a limit if unspecified.

      • term: string

        the term with which to search.

    Returns Promise<IUserDirectoryResponse>

    Promise which resolves: an array of results.

  • Parameters

    • roomId: string
    • threadId: null | string
    • eventObject: Partial<IEvent>

      An object with the partial structure of an event, to which event_id, user_id, room_id and origin_server_ts will be added.

    • Optional txnId: string

      Optional.

    Returns Promise<ISendEventResponse>

    Promise which resolves: to an empty object {}

  • Back up session keys to the homeserver.

    Parameters

    • roomId: undefined

      ID of the room that the keys are for Optional.

    • sessionId: undefined

      ID of the session that the keys are for Optional.

    • version: undefined | string

      backup version Optional.

    • data: IKeyBackup

      Object keys to send

    Returns Promise<void>

    a promise that will resolve when the keys are uploaded

  • Parameters

    • roomId: string
    • sessionId: undefined
    • version: undefined | string
    • data: IKeyBackup

    Returns Promise<void>

  • Parameters

    • roomId: string
    • sessionId: string
    • version: undefined | string
    • data: IKeyBackup

    Returns Promise<void>

  • Send a read receipt.

    Parameters

    • event: null | MatrixEvent

      The event that has been read.

    • receiptType: ReceiptType = ReceiptType.Read

      other than ReceiptType.Read are experimental! Optional.

    • unthreaded: boolean = false

    Returns Promise<undefined | {}>

    Promise which resolves: to an empty object {}

  • Send a receipt.

    Parameters

    • event: MatrixEvent

      The event being acknowledged

    • receiptType: ReceiptType

      The kind of receipt e.g. "m.read". Other than ReceiptType.Read are experimental!

    • Optional body: Record<string, any>

      Additional content to send alongside the receipt.

    • unthreaded: boolean = false

      An unthreaded receipt will clear room+thread notifications

    Returns Promise<{}>

    Promise which resolves: to an empty object {}

  • Share shared-history decryption keys with the given users.

    Parameters

    • roomId: string

      the room for which keys should be shared.

    • userIds: string[]

      a list of users to share with. The keys will be sent to all of the user's current devices.

    Returns Promise<void>

  • 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.

    Parameters

    • eventType: string

      type of event to send content to send. Map from user_id to device_id to content object.

    • contentMap: SendToDeviceContentMap
    • Optional txnId: string

      transaction id. One will be made up if not supplied.

    Returns Promise<{}>

    Promise which resolves: to an empty object {}

  • Parameters

    • roomId: string
    • isTyping: boolean
    • timeoutMs: number

    Returns Promise<{}>

    Promise which resolves: to an empty object {}

  • Set the access token associated with this account.

    Parameters

    • token: string

      The new access token.

    Returns void

  • Set account data event for the current user. It will retry the request up to 5 times.

    Parameters

    • eventType: string

      The event type

    • content: IContent

      the contents object for the event

    Returns Promise<{}>

    Promise which resolves: an empty object

  • 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.

    Parameters

    Returns void

  • Set the dehydration key. This will also periodically dehydrate devices to the server.

    Parameters

    • key: Uint8Array

      the dehydration key

    • keyInfo: IDehydratedDeviceKeyInfo

      Information about the key. Primarily for information about how to generate the key from a passphrase.

    • Optional deviceDisplayName: string

      The device display name for the dehydrated device.

    Returns Promise<void>

    A promise that resolves when the dehydrated device is stored.

  • Mark the given device as blocked/unblocked

    Parameters

    • userId: string

      owner of the device

    • deviceId: string

      unique identifier for the device or user's cross-signing public key ID.

    • blocked: boolean = true

      whether to mark the device as blocked. defaults to 'true'.

    Returns Promise<void>

  • Update the given device

    Parameters

    • deviceId: string

      device to update

    • body: {
          display_name: string;
      }

      body of request

      • display_name: string

    Returns Promise<{}>

    Promise which resolves: to an empty object {}

  • Mark the given device as known/unknown

    Parameters

    • userId: string

      owner of the device

    • deviceId: string

      unique identifier for the device or user's cross-signing public key ID.

    • known: boolean = true

      whether to mark the device as known. defaults to 'true'.

    Returns Promise<void>

  • Parameters

    • userId: string
    • deviceId: string
    • Optional verified: null | boolean
    • Optional blocked: null | boolean
    • Optional known: null | boolean

    Returns Promise<void>

  • Mark the given device as verified

    Parameters

    • userId: string

      owner of the device

    • deviceId: string

      unique identifier for the device or user's cross-signing public key ID.

    • verified: boolean = true

      whether to mark the device as verified. defaults to 'true'.

    Returns Promise<void>

  • 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.

    Parameters

    • allow: boolean

    Returns void

  • Set whether VoIP calls are forced to use only TURN candidates. This is the same as the forceTURN option when creating the client.

    Parameters

    • force: boolean

      True to force use of TURN servers

    Returns void

  • Set the global override for whether the client should ever send encrypted messages to unverified devices. This provides the default for rooms which do not specify a value.

    Parameters

    • value: boolean

      whether to blacklist all unverified devices by default

    Returns boolean

    Deprecated

    Prefer direct access to CryptoApi.globalBlacklistUnverifiedDevices:

    client.getCrypto().globalBlacklistUnverifiedDevices = value;
    
  • Set whether sendMessage in a room with unknown and unverified devices should throw an error and not send them message. This has 'Global' for symmetry with setGlobalBlacklistUnverifiedDevices but there is currently no room-level equivalent for this setting.

    This API is currently UNSTABLE and may change or be removed without notice.

    It has no effect with the Rust crypto implementation.

    Parameters

    • value: boolean

      whether error on unknown devices

      client.getCrypto().globalErrorOnUnknownDevices = value;
      

    Returns void

  • Experimental

    Set whether this client is a guest account. This method is experimental and may change without warning.

    Parameters

    • guest: boolean

      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.

    Returns void

  • Set r/w flags for guest access in a room.

    Parameters

    • roomId: string

      The room to configure guest access in.

    • opts: IGuestAccessOpts

      Options

    Returns Promise<void>

    Promise which resolves

  • Set the identity server URL of this client

    Parameters

    • Optional url: string

      New identity server URL

    Returns void

  • Sets the users that the current user should ignore.

    Parameters

    • userIds: string[]

      the user IDs to ignore

    Returns Promise<{}>

    Promise which resolves: an empty object

  • Parameters

    • newURL: string

    Returns void

  • Make a request to change your password.

    Parameters

    • authDict: AuthDict
    • newPassword: string

      The new desired password.

    • Optional logoutDevices: boolean

      Should all sessions be logged out after the password change. Defaults to true.

    Returns Promise<{}>

    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.

    Parameters

    • roomId: string

      the room to update power levels in

    • userId: string | string[]

      the ID of the user or users to update power levels of

    • powerLevel: undefined | number

      the numeric power level to update given users to

    • Optional event: null | MatrixEvent

      deprecated and no longer used.

    Returns Promise<ISendEventResponse>

    Promise which resolves: to an ISendEventResponse object

  • Parameters

    • info: "avatar_url"

      The kind of info to set (e.g. 'avatar_url')

    • data: {
          avatar_url: string;
      }

      The JSON object to set.

      • avatar_url: string

    Returns Promise<{}>

  • Parameters

    • info: "displayname"
    • data: {
          displayname: string;
      }
      • displayname: string

    Returns Promise<{}>

  • Enable or disable a push notification rule.

    Parameters

    • scope: string
    • kind: PushRuleKind
    • ruleId: string
    • enabled: boolean

    Returns Promise<{}>

    Promise which resolves: to an empty object {}

  • Update the push rules for the account. This should be called whenever updated push rules are available.

    Parameters

    Returns void

  • Adds a new pusher or updates an existing pusher

    Parameters

    Returns Promise<{}>

    Promise which resolves: Empty json object on success

  • Parameters

    • roomId: string
    • eventType: string

      event type to be set

    • content: Record<string, any>

      event content

    Returns Promise<{}>

    Promise which resolves: to an empty object {}

  • Set the visbility of a room in the current HS's room directory

    Parameters

    • roomId: string
    • visibility: Visibility

      "public" to make the room visible in the public directory, or "private" to make it invisible.

    Returns Promise<{}>

    Promise which resolves: to an empty object {}

  • Enable end-to-end encryption for a room. This does not modify room state. Any messages sent before the returned promise resolves will be sent unencrypted.

    Parameters

    • roomId: string

      The room ID to enable encryption in.

    • config: IRoomEncryption

      The encryption config for the room.

    Returns Promise<void>

    A promise that will resolve when encryption is set up.

    Deprecated

    Not supported for Rust Cryptography. To enable encryption in a room, send an m.room.encryption state event.

  • Set a room-kind muting push rule in a room. The operation also updates MatrixClient.pushRules at the end.

    Parameters

    • scope: "global" | "device"

      "global" or device-specific.

    • roomId: string

      the id of the room.

    • mute: boolean

      the mute state.

    Returns undefined | Promise<void>

    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.

    Parameters

    • roomId: string

      ID of the room that has been read

    • rmEventId: string

      ID of the event that has been read

    • Optional rrEvent: MatrixEvent

      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. The local echo of this receipt will be done if set. Optional.

    • Optional rpEvent: MatrixEvent

      the m.read.private read receipt event for when we don't want other users to see the read receipts. This is experimental. Optional.

    Returns Promise<{}>

    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.

    Parameters

    • roomId: string

      ID of the room that has been read

    • rmEventId: string

      ID of the event that has been read

    • Optional rrEventId: string

      ID 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.

    • Optional rpEventId: string

      rpEvent the m.read.private read receipt event for when we don't want other users to see the read receipts. This is experimental. Optional.

    Returns Promise<{}>

    Promise which resolves: the empty object, {}.

  • Parameters

    • roomId: string
    • tagName: string

      name of room tag to be set

    • metadata: ITagMetadata = {}

      associated with that tag to be stored

    Returns Promise<{}>

    Promise which resolves: to an empty object

  • Set whether to advertise transfer support to other parties on Matrix calls.

    Parameters

    • support: boolean

      True to advertise the 'm.call.transferee' capability

    Returns void

  • 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.

    Parameters

    • Optional presence: SetPresence

      the presence to specify to set_presence of sync calls

    Returns Promise<void>

  • Determine whether a given event should be encrypted when we send it to the given room.

    This takes into account event type and room configuration.

    Parameters

    Returns Promise<boolean>

  • High level helper method to stop the client from polling and allow a clean shutdown.

    Returns void

  • Stop any ongoing room peeking.

    Returns void

  • 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)

    Returns Promise<void>

    for store operation

  • Store an encrypted secret on the server.

    The Secure Secret Storage API is currently UNSTABLE and may change without notice.

    Parameters

    • name: string

      The name of the secret

    • secret: string

      The secret contents.

    • Optional keys: string[]

      The IDs of the keys to use to encrypt the secret or null/undefined to use the default (will throw if no default key is set).

    Returns Promise<void>

  • 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.

    Parameters

    • sid: string

      The sid given in the response to requestToken

    • clientSecret: string

      A secret binary string generated by the client. This must be the same value submitted in the requestToken call.

    • msisdnToken: string

      The MSISDN token, as enetered by the user.

    • identityAccessToken: null | string

      The access_token field of the Identity Server /account/register response (see registerWithIdentityServer). Some legacy identity servers had no authentication here.

    Returns Promise<{
        success: boolean;
    }>

    Promise which resolves: Object, containing success boolean.

    Throws

    Error if No identity server is set

  • 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.

    Parameters

    • url: string

      The URL to submit the token to

    • sid: string

      The sid given in the response to requestToken

    • clientSecret: string

      A secret binary string generated by the client. This must be the same value submitted in the requestToken call.

    • msisdnToken: string

      The MSISDN token, as enetered by the user.

    Returns Promise<{
        success: boolean;
    }>

    Promise which resolves: Object, containing success boolean.

  • Returns boolean

    Deprecated

    use supportsThreads() instead

  • Experimental

    A helper to determine intentional mentions support

    Returns boolean

    a boolean to determine if intentional mentions are enabled on the server

  • A helper to determine thread support

    Returns boolean

    a boolean to determine if threads are enabled

  • Check if the runtime environment supports VoIP calling.

    Returns boolean

    True if VoIP is supported.

  • Populate the store with rooms the user has left.

    Returns Promise<Room[]>

    Promise which resolves: TODO - Resolved when the rooms have been added to the data store.

  • Parameters

    • roomId: string
    • userId: string

    Returns Promise<{}>

    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.

    Parameters

    • medium: string

      The threepid medium (eg. 'email')

    • address: string

      The threepid address (eg. 'bob@example.com') this must be as returned by getThreePids.

    Returns Promise<{
        id_server_unbind_result: IdServerUnbindResult;
    }>

    Promise which resolves: on success

  • 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.

    Parameters

    • name: string

      The name of the tree space.

    Returns Promise<MSC3089TreeSpace>

    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.

    Parameters

    • roomId: string

      The room ID to get a tree space reference for.

    Returns null | MSC3089TreeSpace

    The tree space, or null if not a tree space.

  • Upgrades a room to a new protocol version

    Parameters

    • roomId: string
    • newVersion: string

      The target version to upgrade to

    Returns Promise<{
        replacement_room: string;
    }>

    Promise which resolves: Object with key 'replacement_room'

  • Upload a file to the media repository on the homeserver.

    Parameters

    • file: XMLHttpRequestBodyInit

      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.

    • Optional opts: UploadOpts

      options object

    Returns Promise<UploadResponse>

    Promise which resolves to response object, as determined by this.opts.onlyData, opts.rawResponse, and opts.onlyContentUri. Rejects with an error (usually a MatrixError).

  • Checks if the user has previously published cross-signing keys

    This means downloading the devicelist for the user and checking if the list includes the cross-signing pseudo-device.

    Returns Promise<boolean>

    Deprecated

    Prefer CryptoApi.userHasCrossSigningKeys:

    result = client.getCrypto().userHasCrossSigningKeys();
    
  • 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.

    Parameters

    • roomId: string

      The room ID to wait for

    Returns Promise<void>

    A promise that resolves once existing group calls in the room have been processed.

Generated using TypeDoc