matrix-sdk-android/org.matrix.android.sdk.api.session.crypto.verification/VerificationService

VerificationService

interface VerificationService
Content copied to clipboard

https://matrix.org/docs/spec/client_server/r0.5.0#key-verification-framework

Verifying keys manually by reading out the Ed25519 key is not very user friendly, and can lead to errors. Verification is a user-friendly key verification process. Verification is intended to be a highly interactive process for users, and as such exposes verification methods which are easier for users to use.

Types

Link copied to clipboard
object Companion
Content copied to clipboard
Link copied to clipboard
interface Listener
Content copied to clipboard

Functions

Link copied to clipboard
abstract suspend fun cancelVerificationRequest(request: PendingVerificationRequest)
Content copied to clipboard
abstract suspend fun cancelVerificationRequest(otherUserId: String, transactionId: String)
Content copied to clipboard
Link copied to clipboard
abstract suspend fun declineVerificationRequestInDMs(    otherUserId: String,     transactionId: String,     roomId: String)
Content copied to clipboard
Link copied to clipboard
abstract suspend fun getExistingTransaction(otherUserId: String, tid: String): VerificationTransaction?
Content copied to clipboard
Link copied to clipboard
abstract suspend fun getExistingVerificationRequest(otherUserId: String, tid: String?): PendingVerificationRequest?
Content copied to clipboard
Link copied to clipboard
abstract suspend fun getExistingVerificationRequestInRoom(roomId: String, tid: String): PendingVerificationRequest?
Content copied to clipboard
Link copied to clipboard
abstract suspend fun getExistingVerificationRequests(otherUserId: String): List<PendingVerificationRequest>
Content copied to clipboard
Link copied to clipboard
abstract suspend fun markedLocallyAsManuallyVerified(userId: String, deviceID: String)
Content copied to clipboard

Mark this device as verified manually.

abstract suspend fun onPotentiallyInterestingEventRoomFailToDecrypt(event: Event)
Content copied to clipboard
Link copied to clipboard
abstract suspend fun readyPendingVerification(    methods: List<VerificationMethod>,     otherUserId: String,     transactionId: String): Boolean
Content copied to clipboard

You should call this method after receiving a verification request. Accept the verification request advertising the given methods as supported Returns false if the request is unknown or transaction is not ready.

Link copied to clipboard
abstract suspend fun reciprocateQRVerification(    otherUserId: String,     requestId: String,     scannedData: String): String?
Content copied to clipboard
Link copied to clipboard
abstract suspend fun requestDeviceVerification(    methods: List<VerificationMethod>,     otherUserId: String,     otherDeviceId: String?): PendingVerificationRequest
Content copied to clipboard

Request an interactive verification to begin

Link copied to clipboard
abstract fun requestEventFlow(): Flow<VerificationEvent>
Content copied to clipboard
Link copied to clipboard
abstract suspend fun requestKeyVerificationInDMs(    methods: List<VerificationMethod>,     otherUserId: String,     roomId: String,     localId: String? = LocalEcho.createLocalEchoId()): PendingVerificationRequest
Content copied to clipboard

Request key verification with another user via room events (instead of the to-device API).

Link copied to clipboard
abstract suspend fun requestSelfKeyVerification(methods: List<VerificationMethod>): PendingVerificationRequest
Content copied to clipboard

Request a self key verification using to-device API (instead of room events).

Link copied to clipboard
abstract suspend fun startKeyVerification(    method: VerificationMethod,     otherUserId: String,     requestId: String): String?
Content copied to clipboard