matrix-js-sdk
    Preparing search index...

    Interface IEncryptionManagerInternal

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

    interface IEncryptionManager {
        isKeyRotationSuppressed: boolean;
        getEncryptionKeys(): ReadonlyMap<
            string,
            readonly {
                backendIdentity: string;
                key: Uint8Array<ArrayBuffer>;
                keyIndex: number;
                membership: CallMembershipIdentityParts;
            }[],
        >;
        join(
            joinConfig: EncryptionConfig | undefined,
            publishedTransports: Transport[],
        ): void;
        leave(): void;
        onMembershipsUpdate(oldMemberships: CallMembership[]): void;
    }
    Index
    isKeyRotationSuppressed: boolean

    Whether the key rotation is currently halted.

    EncryptionConfig.keyRotationParticipantLimit

    • Retrieves the encryption keys currently managed by the encryption manager.

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

      A map of participant IDs to their encryption keys.

    • Joins the encryption manager with the provided configuration.

      Parameters

      • joinConfig: EncryptionConfig | undefined

        The configuration for joining encryption, or undefined

      • publishedTransports: Transport[]

        The transports on which we are publishing. (Needed to determine which participant identity formats to use, for compatibility.)

      Returns void