Struct containing information on how a to-device message was decrypted.

Properties

sender: UserId

The user ID of the sender of the event.

Note this is untrusted data unless isSenderVerified is true.

senderCurve25519Key: string

The base64-encoded public Curve25519 key of the device that encrypted the message.

Accessors

  • get senderDevice(): undefined | DeviceId

    The device ID of the device that sent us the to-device message.

    Could be undefined in the case where the to-device message sender checks are delayed. There is no delay for to-device messages other than m.room_key, so this will always be truthy for other message types (the decryption would fail if the sender device keys cannot be found).

    Note this is untrusted data unless isSenderVerified is true.

    Returns undefined | DeviceId

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

    The device ID of the device that sent us the to-device message.

    Could be undefined in the case where the to-device message sender checks are delayed. There is no delay for to-device messages other than m.room_key, so this will always be truthy for other message types (the decryption would fail if the sender device keys cannot be found).

    Note this is untrusted data unless isSenderVerified is true.

    Parameters

    Returns void

Methods

  • Returns void

  • Returns whether the sender device is in a verified state. This reflects the state at the time of decryption.

    Returns boolean