Class RoomList

Information about the encryption settings of rooms. Loads this information from the supplied crypto store when init() is called, and saves it to the crypto store whenever it is updated via setRoomEncryption(). Can supply full information about a room's encryption via getRoomEncryption(), or just answer whether or not a room has encryption via isRoomEncrypted.

Index

Constructors

Properties

cryptoStore? roomEncryption

Methods

getRoomEncryption init isRoomEncrypted setRoomEncryption

Constructors

constructor

new RoomList(cryptoStore?): RoomList
Parameters
- Optional cryptoStore: CryptoStore
Returns RoomList
- Defined in src/crypto/RoomList.ts:43

Properties

`Private` `Optional` `Readonly` cryptoStore

cryptoStore?: CryptoStore

`Private` roomEncryption

roomEncryption: Record<string, IRoomEncryption> = {}

Methods

getRoomEncryption

getRoomEncryption(roomId): null | IRoomEncryption
Parameters
- roomId: string
Returns null | IRoomEncryption
- Defined in src/crypto/RoomList.ts:53

init

init(): Promise<void>
Returns Promise<void>
- Defined in src/crypto/RoomList.ts:45

isRoomEncrypted

isRoomEncrypted(roomId): boolean
Parameters
- roomId: string
Returns boolean
- Defined in src/crypto/RoomList.ts:57

setRoomEncryption

setRoomEncryption(roomId, roomInfo): Promise<void>
Parameters
- roomId: string
- roomInfo: IRoomEncryption
Returns Promise<void>
- Defined in src/crypto/RoomList.ts:61

Generated using TypeDoc