Class EncryptionAlgorithm`Abstract`

base type for encryption implementations

Alias

module:crypto/algorithms/base.EncryptionAlgorithm

Param

parameters

Param

The UserID for the local user

Param

The identifier for this device.

Param

crypto core

Param

olm.js wrapper

Param

base matrix api interface

Param

The ID of the room we will be sending to

Param

The body of the m.room.encryption event

Hierarchy

EncryptionAlgorithm

Index

Constructors

Properties

baseApis crypto deviceId olmDevice roomId? userId

Methods

encryptMessage forceDiscardSession? onRoomMembership prepareToEncrypt reshareKeyWithDevice?

Constructors

constructor

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

Properties

`Protected` `Readonly` baseApis

baseApis: MatrixClient

`Protected` `Readonly` crypto

crypto: Crypto

`Protected` `Readonly` deviceId

deviceId: string

`Protected` `Readonly` olmDevice

olmDevice: OlmDevice

`Protected` `Optional` `Readonly` roomId

roomId?: string

`Protected` `Readonly` userId

userId: string

Methods

`Abstract` encryptMessage

encryptMessage(room: Room, eventType: string, content: object): Promise<object>
Encrypt a message event

Method
module:crypto/algorithms/base.EncryptionAlgorithm.encryptMessage

Abstract

Returns
Promise which resolves to the new event body
Parameters
- room: Room
- eventType: string
- content: object
  
  event content
Returns Promise<object>
- Defined in src/crypto/algorithms/base.ts:111

`Optional` forceDiscardSession

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

onRoomMembership

onRoomMembership(event: MatrixEvent, member: RoomMember, oldMembership?: string): void
Called when the membership of a member of the room changes.

Abstract
Parameters
- event: MatrixEvent
  
  event causing the change
- member: RoomMember
  
  user whose membership changed
- Optional oldMembership: string
  
  previous membership
Returns void
- Defined in src/crypto/algorithms/base.ts:122

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:96

`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:124

Generated using TypeDoc