Class EncryptionAlgorithm`Abstract`

base type for encryption implementations

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
  
  parameters
Returns EncryptionAlgorithm
- Defined in src/crypto/algorithms/base.ts:74

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: IContent): Promise<IEncryptedContent>
Encrypt a message event

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

`Optional` forceDiscardSession

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

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
- Optional oldMembership: string
  
  previous membership
Returns void
- Defined in src/crypto/algorithms/base.ts:110

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

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

Generated using TypeDoc