Information on a received m.room_key.withheld event.

Properties

The encryption algorithm of the session that is being withheld.

This may be from an m.room_key.withheld event, or from a shared room key bundle under MSC4268.

roomId: RoomId

The room ID of the session that is being withheld.

sender: UserId

The User ID of the sender of the withheld information.

This may be the sender of an m.room_key.withheld event, or the sender of a shared room key bundle under MSC4268.

sessionId: string

The session ID of the session that is being withheld.

withheldCode: string

The code indicating why the key was withheld.

This may be the code from an m.room_key.withheld event (such as m.unverified), or from a shared room key bundle under MSC4268.

Methods

  • Returns void