Class BackupManager

constructor

• new BackupManager(baseApis: MatrixClient, getKey: GetKey): BackupManager

• Parameters

  • baseApis: MatrixClient
  • getKey: GetKey

  Returns BackupManager

backupInfo

checkedForBackup

ReadonlygetKey

version

• get version(): undefined | string

• Returns undefined | string

backupGroupSession

• backupGroupSession(senderKey: string, sessionId: string): Promise<void>

• Parameters

  • senderKey: string
  • sessionId: string

  Returns Promise<void>

backupPendingKeys

• backupPendingKeys(limit: number): Promise<number>

• Take some e2e keys waiting to be backed up and send them to the backup.

  Parameters

  • limit: number

    Maximum number of keys to back up

  Returns Promise<number>

  Number of sessions backed up

checkAndStart

• checkAndStart(): Promise<null | IKeyBackupCheck>

• Check the server for an active key backup and if one is present and has a valid signature from one of the user's verified devices, start backing up to it.

  Returns Promise<null | IKeyBackupCheck>

checkKeyBackup

• checkKeyBackup(): Promise<null | IKeyBackupCheck>

• Forces a re-check of the key backup and enables/disables it as appropriate.

  Returns Promise<null | IKeyBackupCheck>

  Object with backup info (as returned by getKeyBackupVersion) in backupInfo and trust information (as returned by isKeyBackupTrusted) in trustInfo.

countSessionsNeedingBackup

• countSessionsNeedingBackup(): Promise<number>

• 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

createKeyBackupVersion

• createKeyBackupVersion(info: KeyBackupInfo): Promise<void>

• Parameters

  • info: KeyBackupInfo

  Returns Promise<void>

deleteAllKeyBackupVersions

• deleteAllKeyBackupVersions(): Promise<void>

• Deletes all key backups.

  Will call the API to delete active backup until there is no more present.

  Returns Promise<void>

deleteKeyBackupVersion

• deleteKeyBackupVersion(version: string): Promise<void>

• Deletes the given key backup.

  Parameters

  • version: string

    The backup version to delete.

  Returns Promise<void>

disableKeyBackup

• disableKeyBackup(): void

• Disable backing up of keys.

  Returns void

enableKeyBackup

• enableKeyBackup(info: KeyBackupInfo): Promise<void>

• Parameters

  • info: KeyBackupInfo

  Returns Promise<void>

flagAllGroupSessionsForBackup

• flagAllGroupSessionsForBackup(): Promise<number>

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

  Returns Promise<number>

  Promise which resolves to the number of sessions now requiring a backup (which will be equal to the number of sessions in the store).

getKeyBackupEnabled

• getKeyBackupEnabled(): null | boolean

• Returns null | boolean

isKeyBackupTrusted

• isKeyBackupTrusted(backupInfo?: KeyBackupInfo): Promise<TrustInfo>

• Check if the given backup info is trusted.

  Parameters

  • OptionalbackupInfo: KeyBackupInfo

    key backup info dict from /room_keys/version

  Returns Promise<TrustInfo>

prepareKeyBackupVersion

• prepareKeyBackupVersion(
      key?: null | string | Uint8Array<ArrayBufferLike>,
      algorithm?: string,
  ): Promise<IPreparedKeyBackupVersion>

• Parameters

  • Optionalkey: null | string | Uint8Array<ArrayBufferLike>
  • Optionalalgorithm: string

  Returns Promise<IPreparedKeyBackupVersion>

queryKeyBackupRateLimited

• queryKeyBackupRateLimited(
      targetRoomId: undefined | string,
      targetSessionId: undefined | string,
  ): Promise<void>

• Attempts to retrieve a session from a key backup, if enough time has elapsed since the last check for this session id.

  Parameters

  • targetRoomId: undefined | string
  • targetSessionId: undefined | string

  Returns Promise<void>

scheduleAllGroupSessionsForBackup

• scheduleAllGroupSessionsForBackup(): Promise<void>

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

  Returns Promise<void>

scheduleKeyBackupSend

• scheduleKeyBackupSend(maxDelay?: number): Promise<void>

• Schedules sending all keys waiting to be sent to the backup, if not already scheduled. Retries if necessary.

  Parameters

  • maxDelay: number = 10000

    Maximum delay to wait in ms. 0 means no delay.

  Returns Promise<void>

stop

• stop(): void

• Stop the backup manager from backing up keys and allow a clean shutdown.

  Returns void

StaticcheckBackupVersion

• checkBackupVersion(info: KeyBackupInfo): void

• Performs a quick check to ensure that the backup info looks sane.

  Throws an error if a problem is detected.

  Parameters

  • info: KeyBackupInfo

    the key backup info

  Returns void

StaticmakeAlgorithm

• makeAlgorithm(info: KeyBackupInfo, getKey: GetKey): Promise<BackupAlgorithm>

• Parameters

  • info: KeyBackupInfo
  • getKey: GetKey

  Returns Promise<BackupAlgorithm>