Properties

event: string

The JSON-encoded decrypted event.

forwarder: undefined | UserId

If the keys for this message were shared-on-invite as part of an MSC4268 key bundle, the ID of the user who sent us the bundle.

forwarderDevice: undefined | DeviceId

If the keys for this message were shared-on-invite as part of an MSC4268 key bundle, the ID of the device from which this bundle was sent.

forwardingCurve25519KeyChain: any[]

Returns an empty array

Previously, this returned the chain of Curve25519 keys through which this session was forwarded, via m.forwarded_room_key events. However, that is not cryptographically reliable, and clients should not be using it.

sender: UserId

The user ID of the event sender, note this is untrusted data unless the verification_state is as well trusted.

senderClaimedEd25519Key: undefined | string

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

senderCurve25519Key: string

The Curve25519 key of the device that created the megolm decryption key originally.

senderDevice: undefined | DeviceId

The device ID of the device that sent us the event, note this is untrusted data unless verification_state is as well trusted.

Methods

  • Returns void

  • Returns void

  • 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.

    Parameters

    • strict: boolean

    Returns ShieldState