From 3a044bd6552348e2e05b5f7a8f1f763f81d1c75f Mon Sep 17 00:00:00 2001 From: Benoit Marty Date: Wed, 12 Feb 2020 11:33:36 +0100 Subject: [PATCH] Add Javadoc --- .../session/crypto/sas/VerificationService.kt | 21 ++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/VerificationService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/VerificationService.kt index d3b33cb6f5..1b5f5d3dd6 100644 --- a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/VerificationService.kt +++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/crypto/sas/VerificationService.kt @@ -96,12 +96,31 @@ interface VerificationService { transactionId: String): Boolean interface Listener { - // TODO javadoc + /** + * Called when a verification request is created either by the user, or by the other user. + */ fun verificationRequestCreated(pr: PendingVerificationRequest) {} + + /** + * Called when a verification request is updated. + */ fun verificationRequestUpdated(pr: PendingVerificationRequest) {} + /** + * Called when a transaction is created, either by the user or initiated by the other user. + */ fun transactionCreated(tx: VerificationTransaction) {} + + /** + * Called when a transaction is updated. You may be interested to track the state of the VerificationTransaction. + */ fun transactionUpdated(tx: VerificationTransaction) {} + + /** + * Inform the the deviceId of the userId has been marked as manually verified by the SDK. + * It will be called after VerificationService.markedLocallyAsManuallyVerified() is called. + * + */ fun markedAsManuallyVerified(userId: String, deviceId: String) {} }