Class DecryptionAlgorithm`Abstract`

base type for decryption implementations

Hierarchy

DecryptionAlgorithm

Index

Constructors

Properties

baseApis crypto olmDevice roomId? userId

Methods

decryptEvent hasKeysForKeyRequest importRoomKey onRoomKeyEvent onRoomKeyWithheldEvent? retryDecryptionFromSender sendSharedHistoryInboundSessions? shareKeysWithDevice

Constructors

constructor

new DecryptionAlgorithm(params: DecryptionClassParams<IParams>): DecryptionAlgorithm
Parameters
- params: DecryptionClassParams<IParams>
Returns DecryptionAlgorithm
- Defined in src/crypto/algorithms/base.ts:132

Properties

`Protected` `Readonly` baseApis

baseApis: MatrixClient

`Protected` `Readonly` crypto

crypto: Crypto

`Protected` `Readonly` olmDevice

olmDevice: OlmDevice

`Protected` `Optional` `Readonly` roomId

roomId?: string

`Protected` `Readonly` userId

userId: string

Methods

`Abstract` decryptEvent

decryptEvent(event: MatrixEvent): Promise<IEventDecryptionResult>
Decrypt an event

Returns
promise which resolves once we have finished decrypting. Rejects with an algorithms.DecryptionError if there is a problem decrypting the event.
Parameters
- event: MatrixEvent
  
  undecrypted event
Returns Promise<IEventDecryptionResult>
- Defined in src/crypto/algorithms/base.ts:149

hasKeysForKeyRequest

hasKeysForKeyRequest(keyRequest: IncomingRoomKeyRequest): Promise<boolean>
Determine if we have the keys necessary to respond to a room key request

Returns
true if we have the keys and could (theoretically) share them; else false.
Parameters
- keyRequest: IncomingRoomKeyRequest
Returns Promise<boolean>
- Defined in src/crypto/algorithms/base.ts:175

importRoomKey

importRoomKey(session: IMegolmSessionData, opts: object): Promise<void>
Import a room key
Parameters
- session: IMegolmSessionData
- opts: object
  
  object
Returns Promise<void>
- Defined in src/crypto/algorithms/base.ts:165

onRoomKeyEvent

onRoomKeyEvent(params: MatrixEvent): Promise<void>
Handle a key event
Parameters
- params: MatrixEvent
  
  event key event
Returns Promise<void>
- Defined in src/crypto/algorithms/base.ts:156

`Optional` onRoomKeyWithheldEvent

onRoomKeyWithheldEvent(event: MatrixEvent): Promise<void>
Parameters
- event: MatrixEvent
Returns Promise<void>
- Defined in src/crypto/algorithms/base.ts:198

retryDecryptionFromSender

retryDecryptionFromSender(senderKey: string): Promise<boolean>
Retry decrypting all the events from a sender that haven't been decrypted yet.
Parameters
- senderKey: string
  
  the sender's key
Returns Promise<boolean>
- Defined in src/crypto/algorithms/base.ts:193

`Optional` sendSharedHistoryInboundSessions

sendSharedHistoryInboundSessions(devicesByUser: Map<string, DeviceInfo[]>): Promise<void>
Parameters
- devicesByUser: Map<string, DeviceInfo[]>
Returns Promise<void>
- Defined in src/crypto/algorithms/base.ts:199

shareKeysWithDevice

shareKeysWithDevice(keyRequest: IncomingRoomKeyRequest): void
Send the response to a room key request
Parameters
- keyRequest: IncomingRoomKeyRequest
Returns void
- Defined in src/crypto/algorithms/base.ts:183

Generated using TypeDoc