Get our own device ID.
Get the unique ID that identifies this SAS verification flow, be either a to-device request ID or a room event ID.
Get the device ID of the other side.
Get the user id of the other side.
Get the room ID if the verification is happening inside a room.
Get our own user ID.
Accept the SAS verification.
This does nothing (and returns undefined
) if the verification was
already accepted, otherwise it returns an OutgoingRequest
that needs to be sent out.
Are we in a state where we can show the short auth string?
Cancel the verification.
Returns either an OutgoingRequest
which should be sent out, or
undefined
if the verification is already cancelled.
Get info about the cancellation if the verification flow has been cancelled.
Cancel the verification.
This cancels the verification with given code (e.g. m.user
).
Returns either an OutgoingRequest
which should be sent out, or
undefined
if the verification is already cancelled.
Confirm the SAS verification.
This confirms that the short auth strings match on both sides.
Does nothing if we’re not in a state where we can confirm the short auth string.
Returns a Promise
for an array of OutgoingRequest
s.
Get the decimal version of the short auth string.
Returns None if we can’t yet present the short auth string, otherwise a tuple containing three 4-digit integers that represent the short auth string.
Get the emoji version of the short auth string.
Returns undefined
if we can't yet present the short auth string,
otherwise an array of seven Emoji
objects.
Get the index of the emoji representing the short auth string
Returns undefined
if we can’t yet present the short auth
string, otherwise seven u8
numbers in the range from 0 to 63
inclusive which can be converted to an emoji using the
relevant specification
entry.
Has the verification been accepted by both parties?
Have we confirmed that the short auth string matches?
Is the SAS flow cancelled?
Is the SAS flow done?
Is this a verification that is verifying one of our own devices?
Register a callback which will be called whenever there is an update to the request.
The callback
is called with no parameters.
Did this verification flow start from a verification request?
Does this verification flow support displaying emoji for the short authentication string?
Has the SAS verification flow timed out?
True if we initiated the verification flow (ie, we sent the
m.key.verification.request
).
Generated using TypeDoc
Short Authentication String (SAS) verification.