Class RoomSettings

Room encryption settings which are modified by state events or user options

Constructors

constructor

Properties

algorithm onlyAllowTrustedDevices

Accessors

sessionRotationPeriodMessages sessionRotationPeriodMs

Methods

free

Constructors

constructor

  • new RoomSettings(): RoomSettings

  • Create a new RoomSettings with default values.

    Returns RoomSettings

Properties

algorithm

algorithm: EncryptionAlgorithm

The encryption algorithm that should be used in the room.

Should be one of the members of EncryptionAlgorithm.

onlyAllowTrustedDevices

onlyAllowTrustedDevices: boolean

Whether untrusted devices should receive room keys. If this is false, they will be excluded from the conversation.

Accessors

sessionRotationPeriodMessages

  • get sessionRotationPeriodMessages(): undefined | number

  • The maximum number of messages an encryption session should be used for, before it is rotated.

    Returns undefined | number

  • set sessionRotationPeriodMessages(value: undefined | null | number): void

  • The maximum number of messages an encryption session should be used for, before it is rotated.

    Parameters

    • value: undefined | null | number

    Returns void

sessionRotationPeriodMs

  • get sessionRotationPeriodMs(): undefined | number

  • The maximum time, in milliseconds, that an encryption session should be used for, before it is rotated.

    Returns undefined | number

  • set sessionRotationPeriodMs(value: undefined | null | number): void

  • The maximum time, in milliseconds, that an encryption session should be used for, before it is rotated.

    Parameters

    • value: undefined | null | number

    Returns void

Methods

free

  • free(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods