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<ArrayBuffer>;
            keyIndex: number;
            membership: CallMembershipIdentityParts;
            rtcBackendIdentity: string;
        }[],
    >;
    join(joinConfig: EncryptionConfig | undefined): void;
    leave(): void;
    onMembershipsUpdate(oldMemberships: CallMembership[]): void;
}

Index

Methods

getEncryptionKeys join leave onMembershipsUpdate

Methods

getEncryptionKeys

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

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

join

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

leave

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

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

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

Interface IEncryptionManager`Internal`

Index

Methods

Methods

getEncryptionKeys

Returns ReadonlyMap<
    string,
    readonly {
        key: Uint8Array<ArrayBuffer>;
        keyIndex: number;
        membership: CallMembershipIdentityParts;
        rtcBackendIdentity: string;
    }[],
>

join

Parameters

Returns void

leave

Returns void

onMembershipsUpdate

Parameters

Returns void

Settings

On This Page

Interface IEncryptionManagerInternal

Index

Methods

Methods

getEncryptionKeys

Returns ReadonlyMap< string, readonly { key: Uint8Array<ArrayBuffer>; keyIndex: number; membership: CallMembershipIdentityParts; rtcBackendIdentity: string; }[],>

join

Parameters

Returns void

leave

Returns void

onMembershipsUpdate

Parameters

Returns void

Settings

On This Page

Interface IEncryptionManager`Internal`

Returns ReadonlyMap<
string,
readonly {
key: Uint8Array<ArrayBuffer>;
keyIndex: number;
membership: CallMembershipIdentityParts;
rtcBackendIdentity: string;
}[],
>