sender

senderCurve25519Key

forwarder

• get forwarder(): undefined | UserId

  The ID of the user who sent us the keys with which we decrypted this event as part of an MSC4268 key bundle, if present. Only applicable for room events.

  Returns undefined | UserId
• set forwarder(value: undefined | null | UserId): void

  The ID of the user who sent us the keys with which we decrypted this event as part of an MSC4268 key bundle, if present. Only applicable for room events.

  Parameters

  • value: undefined | null | UserId

  Returns void

forwarderDevice

• get forwarderDevice(): undefined | DeviceId

  The device ID of the user who sent us the keys with which we decrypted this event as part of an MSC4268 key bundle, if present. Only applicable for room events.

  Returns undefined | DeviceId
• set forwarderDevice(value: undefined | null | DeviceId): void

  The device ID of the user who sent us the keys with which we decrypted this event as part of an MSC4268 key bundle, if present. Only applicable for room events.

  Parameters

  • value: undefined | null | DeviceId

  Returns void

senderClaimedEd25519Key

• get senderClaimedEd25519Key(): undefined | string

  The signing Ed25519 key that created the megolm key that was used to decrypt this session.

  Returns undefined | string
• set senderClaimedEd25519Key(value: undefined | null | string): void

  The signing Ed25519 key that created the megolm key that was used to decrypt this session.

  Parameters

  • value: undefined | null | string

  Returns void

senderDevice

• get senderDevice(): undefined | DeviceId

  The device ID of the device that sent us the event.

  Note this is untrusted data unless shieldState shows that the sender is verified.

  Returns undefined | DeviceId
• set senderDevice(value: undefined | null | DeviceId): void

  The device ID of the device that sent us the event.

  Note this is untrusted data unless shieldState shows that the sender is verified.

  Parameters

  • value: undefined | null | DeviceId

  Returns void

[dispose]

• "[dispose]"(): void

  Returns void

free

• free(): void

  Returns void

shieldState

• shieldState(strict: boolean): ShieldState

  The verification state of the device that sent us the event. Note this is the state of the device at the time of decryption. It may change in the future if a device gets verified or deleted.

  Arguments

  • strict - whether to enable "strict mode" verification. In non-strict mode, unverified users are given no shield, and keys that have been forwarded or restored from an insecure backup are given a grey shield (both get a red shield in strict mode).

  Parameters

  • strict: boolean

  Returns ShieldState