Class EncryptionAlgorithm`Abstract`

base type for encryption implementations

Index

Constructors

Properties

baseApis crypto deviceId olmDevice userId

Methods

encryptMessage forceDiscardSession? onRoomMembership prepareToEncrypt reshareKeyWithDevice?

Constructors

constructor

new EncryptionAlgorithm(params: IParams): EncryptionAlgorithm
Parameters
- params: IParams
  parameters
Returns EncryptionAlgorithm
- Defined in src/crypto/algorithms/base.ts:73

Properties

`Protected` `Readonly`baseApis

baseApis: MatrixClient

`Protected` `Readonly`crypto

crypto: Crypto

`Protected` `Readonly`deviceId

deviceId: string

`Protected` `Readonly`olmDevice

olmDevice: OlmDevice

`Protected` `Readonly`userId

userId: string

Methods

`Abstract`encryptMessage

encryptMessage(
    room: Room,
    eventType: string,
    content: IContent,
): Promise<IEncryptedContent>
Encrypt a message event
Parameters
- room: Room
- eventType: string
- content: IContent
  event content
Returns Promise<IEncryptedContent>
Promise which resolves to the new event body
- Defined in src/crypto/algorithms/base.ts:98

`Optional`forceDiscardSession

forceDiscardSession(): void
Returns void
- Defined in src/crypto/algorithms/base.ts:117

onRoomMembership

onRoomMembership(
    event: MatrixEvent,
    member: RoomMember,
    oldMembership?: string,
): void
Called when the membership of a member of the room changes.
Parameters
- event: MatrixEvent
  event causing the change
- member: RoomMember
  user whose membership changed
- OptionaloldMembership: string
  previous membership
Returns void
- Defined in src/crypto/algorithms/base.ts:108

prepareToEncrypt

prepareToEncrypt(room: Room): void
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
- Defined in src/crypto/algorithms/base.ts:87

`Optional`reshareKeyWithDevice

reshareKeyWithDevice(
    senderKey: string,
    sessionId: string,
    userId: string,
    device: DeviceInfo,
): Promise<void>
Parameters
- senderKey: string
- sessionId: string
- userId: string
- device: DeviceInfo
Returns Promise<void>
- Defined in src/crypto/algorithms/base.ts:110