Interface IEncryptionManager`Internal`

This interface is for testing and for making it possible to interchange the encryption manager.

interface IEncryptionManager {
    getEncryptionKeys(): ReadonlyMap<
        string,
        readonly { key: Uint8Array; keyIndex: number }[],
    >;
    join(joinConfig: undefined | EncryptionConfig): void;
    leave(): void;
    onMembershipsUpdate(oldMemberships: CallMembership[]): void;
}

Index

Methods

getEncryptionKeys join leave onMembershipsUpdate

Methods

getEncryptionKeys

getEncryptionKeys(): ReadonlyMap<
string,
readonly { key: Uint8Array; keyIndex: number }[],
>
Retrieves the encryption keys currently managed by the encryption manager.

Returns ReadonlyMap<string, readonly { key: Uint8Array; keyIndex: number }[]>
A map of participant IDs to their encryption keys.
- Defined in src/matrixrtc/EncryptionManager.ts:46

join

join(joinConfig: undefined | EncryptionConfig): void
Joins the encryption manager with the provided configuration.
Parameters
- joinConfig: undefined | EncryptionConfig
  The configuration for joining encryption, or undefined if no specific configuration is provided.
Returns void
- Defined in src/matrixrtc/EncryptionManager.ts:27

leave

leave(): void
Leaves the encryption manager, cleaning up any associated resources.

Returns void
- Defined in src/matrixrtc/EncryptionManager.ts:32

onMembershipsUpdate

onMembershipsUpdate(oldMemberships: CallMembership[]): void
Called from the MatrixRTCSession when the memberships in this session updated.
Parameters
- oldMemberships: CallMembership[]
  The previous state of call memberships before the update.
Returns void
- Defined in src/matrixrtc/EncryptionManager.ts:39