Get info about the cancellation if the verification request has been cancelled.
Get the unique ID of this verification request.
The ID of the other device that is participating in this verification.
The ID of the other user that is participating in this verification request.
Get our own supported verification methods that we advertised.
Will be present only we requested the verification or if we’re in the ready state.
Our own user id.
Get the room ID if the verification is happening inside a room.
Get the supported verification methods of the other side.
Will be present only if the other side requested the verification or if we’re in the ready state.
undefined if we do not yet know the supported methods; otherwise, an
array of VerificationMethods.
Accept the verification request.
This method will accept the request and signal that it
supports the m.sas.v1, the m.qr_code.show.v1, and
m.reciprocate.v1 method.
m.qr_code.show.v1 will only be signaled if the qrcode
feature is enabled. This feature is disabled by default. If
it's enabled and QR code scanning should be supported or QR
code showing shouldn't be supported the accept_with_methods
method should be used instead.
It returns either a ToDeviceRequest, a RoomMessageRequest
or undefined.
Accept the verification request signaling that our client supports the given verification methods.
methods represents the methods that we should advertise as
supported by us.
It returns either a ToDeviceRequest, a RoomMessageRequest
or undefined.
Cancel the verification request.
It returns either a ToDeviceRequest, a RoomMessageRequest
or undefined.
Generate a QR code that can be used by another client to start a QR code based verification.
Returns a Qr or undefined.
If this request has transitioned into a concrete verification
flow (and not yet been completed or cancelled), returns a Verification
object.
Returns: a Sas, a Qr, or undefined.
Has the verification flow that was started with this request been cancelled?
Has the verification flow that was started with this request finished?
Has the verification request been answered by another device?
Is the verification request ready to start a verification flow?
Is this a verification that is verifying one of our own devices?
Get the current phase of this request.
Returns a VerificationRequestPhase.
Register a callback which will be called whenever there is an update to the request.
The callback is called with no parameters.
Start a QR code verification by providing a scanned QR code for this verification flow.
Transition from this verification request into a SAS verification flow.
Returns Promise<[Sas, RoomMessageRequest|ToDeviceRequest] | undefined>
The number of milliseconds remaining before this verification flow times out.
Returns zero if the time has already passed.
Has the verification flow timed out?
Did we initiate the verification request?
Create an event content that can be sent as a room event to request verification from the other side. This should be used only for verifications of other users and it should be sent to a room we consider to be a DM with the other user.
Generated using TypeDoc
An object controlling key verification requests.
Interactive verification flows usually start with a verification request, this object lets you send and reply to such a verification request.
After the initial handshake the verification flow transitions into one of the verification methods.