Class OutgoingRoomKeyRequestManager

Index

Constructors

Methods

cancelAndResendAllOutgoingRequests cancelRoomKeyRequest getOutgoingSentRoomKeyRequest queueRoomKeyRequest sendQueuedRequests stop

Constructors

constructor

new OutgoingRoomKeyRequestManager(baseApis, deviceId, cryptoStore): OutgoingRoomKeyRequestManager
Parameters
- baseApis: MatrixClient
- deviceId: string
- cryptoStore: CryptoStore
Returns OutgoingRoomKeyRequestManager
- Defined in src/crypto/OutgoingRoomKeyRequestManager.ts:107

Methods

cancelAndResendAllOutgoingRequests

cancelAndResendAllOutgoingRequests(): Promise<void[]>
Find anything in sent state, and kick it around the loop again. This is intended for situations where something substantial has changed, and we don't really expect the other end to even care about the cancellation. For example, after initialization or self-verification.

Returns Promise<void[]>
An array of queueRoomKeyRequest outputs.
- Defined in src/crypto/OutgoingRoomKeyRequestManager.ts:326

cancelRoomKeyRequest

cancelRoomKeyRequest(requestBody): Promise<unknown>
Cancel room key requests, if any match the given requestBody
Parameters
- requestBody: IRoomKeyRequestBody
Returns Promise<unknown>
resolves when the request has been updated in our pending list.
- Defined in src/crypto/OutgoingRoomKeyRequestManager.ts:240

getOutgoingSentRoomKeyRequest

getOutgoingSentRoomKeyRequest(userId, deviceId): Promise<OutgoingRoomKeyRequest[]>
Look for room key requests by target device and state
Parameters
- userId: string
  Target user ID
- deviceId: string
  Target device ID
Returns Promise<OutgoingRoomKeyRequest[]>
resolves to a list of all the OutgoingRoomKeyRequest
- Defined in src/crypto/OutgoingRoomKeyRequestManager.ts:315

queueRoomKeyRequest

queueRoomKeyRequest(requestBody, recipients, resend?): Promise<void>
Queue up a room key request, if we haven't already queued or sent one.

The requestBody is compared (with a deep-equality check) against previous queued or sent requests and if it matches, no change is made. Otherwise, a request is added to the pending list, and a job is started in the background to send it.
Parameters
- requestBody: IRoomKeyRequestBody
- recipients: IRoomKeyRequestRecipient[]
- resend: boolean = false
  whether to resend the key request if there is already one
Returns Promise<void>
resolves when the request has been added to the pending list (or we have established that a similar request already exists)
- Defined in src/crypto/OutgoingRoomKeyRequestManager.ts:144

sendQueuedRequests

sendQueuedRequests(): void
Send any requests that have been queued

Returns void
- Defined in src/crypto/OutgoingRoomKeyRequestManager.ts:125

stop

stop(): void
Called when the client is stopped. Stops any running background processes.

Returns void
- Defined in src/crypto/OutgoingRoomKeyRequestManager.ts:116