filippodb
/
SchildiChat-android
mirror of https://github.com/SchildiChat/SchildiChat-android.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use Kdoc format, else it's not extracted to the documentation by dokka

This commit is contained in:
Benoit Marty 2022-05-05 17:00:07 +02:00 committed by Benoit Marty
parent 109b381e2e
commit bad62be497
5 changed files with 85 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/crypto/keysbackup/KeysBackupState.kt
View File

@ -51,33 +51,51 @@ package org.matrix.android.sdk.api.session.crypto.keysbackup
* </pre>
*/
enum class KeysBackupState {
// Need to check the current backup version on the homeserver
/**
* Need to check the current backup version on the homeserver
*/
Unknown,
// Checking if backup is enabled on homeserver
/**
* Checking if backup is enabled on homeserver
*/
CheckingBackUpOnHomeserver,
// Backup has been stopped because a new backup version has been detected on the homeserver
/**
* Backup has been stopped because a new backup version has been detected on the homeserver
*/
WrongBackUpVersion,
// Backup from this device is not enabled
/**
* Backup from this device is not enabled
*/
Disabled,
// There is a backup available on the homeserver but it is not trusted.
// It is not trusted because the signature is invalid or the device that created it is not verified
// Use [KeysBackup.getKeysBackupTrust()] to get trust details.
// Consequently, the backup from this device is not enabled.
/**
* There is a backup available on the homeserver but it is not trusted.
* It is not trusted because the signature is invalid or the device that created it is not verified
* Use [KeysBackup.getKeysBackupTrust()] to get trust details.
* Consequently, the backup from this device is not enabled.
*/
NotTrusted,
// Backup is being enabled: the backup version is being created on the homeserver
/**
* Backup is being enabled: the backup version is being created on the homeserver
*/
Enabling,
// Backup is enabled and ready to send backup to the homeserver
/**
* Backup is enabled and ready to send backup to the homeserver
*/
ReadyToBackUp,
// e2e keys are going to be sent to the homeserver
/**
* e2e keys are going to be sent to the homeserver
*/
WillBackUp,
// e2e keys are being sent to the homeserver
/**
* e2e keys are being sent to the homeserver
*/
BackingUp
}

16
matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/crypto/model/RoomEncryptionTrustLevel.kt
View File

@ -20,15 +20,23 @@ package org.matrix.android.sdk.api.session.crypto.model
* RoomEncryptionTrustLevel represents the trust level in an encrypted room.
*/
enum class RoomEncryptionTrustLevel {
// No one in the room has been verified -> Black shield
/**
* No one in the room has been verified -> Black shield
*/
Default,
// There are one or more device un-verified -> the app should display a red shield
/**
* There are one or more device un-verified -> the app should display a red shield
*/
Warning,
// All devices in the room are verified -> the app should display a green shield
/**
* All devices in the room are verified -> the app should display a green shield
*/
Trusted,
// e2e is active but with an unsupported algorithm
/**
* e2e is active but with an unsupported algorithm
*/
E2EWithUnsupportedAlgorithm
}

12
matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/crypto/verification/VerificationMethod.kt
View File

@ -20,12 +20,18 @@ package org.matrix.android.sdk.api.session.crypto.verification
* Verification methods.
*/
enum class VerificationMethod {
// Use it when your application supports the SAS verification method
/**
* Use it when your application supports the SAS verification method
*/
SAS,
// Use it if your application is able to display QR codes
/**
* Use it if your application is able to display QR codes
*/
QR_CODE_SHOW,
// Use it if your application is able to scan QR codes
/**
* Use it if your application is able to scan QR codes
*/
QR_CODE_SCAN
}

31
matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/send/SendState.kt
View File

@ -17,27 +17,44 @@
package org.matrix.android.sdk.api.session.room.send
enum class SendState {
/**
* The state is unknown
*/
UNKNOWN,
// the event has not been sent
/**
* The event has not been sent
*/
UNSENT,
// the event is encrypting
/**
* The event is encrypting
*/
ENCRYPTING,
// the event is currently sending
/**
* The event is currently sending
*/
SENDING,
// the event has been sent
/**
* The event has been sent
*/
SENT,
// the event has been received from server
/**
* The event has been received from server
*/
SYNCED,
// The event failed to be sent
/**
* The event failed to be sent
*/
UNDELIVERED,
// the event failed to be sent because some unknown devices have been found while encrypting it
/**
* The event failed to be sent because some unknown devices have been found while encrypting it
*/
FAILED_UNKNOWN_DEVICES;
internal companion object {

15
matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/threads/ThreadNotificationState.kt
View File

@ -20,14 +20,19 @@ package org.matrix.android.sdk.api.session.threads
* This class defines the state of a thread notification.
*/
enum class ThreadNotificationState {
// There are no new message
/**
* There are no new message
*/
NO_NEW_MESSAGE,
// There is at least one new message
/**
* There is at least one new message
*/
NEW_MESSAGE,
// The is at least one new message that should be highlighted
// ex. "Hello @aris.kotsomitopoulos"
/**
* The is at least one new message that should be highlighted
* ex. "Hello @aris.kotsomitopoulos"
*/
NEW_HIGHLIGHTED_MESSAGE;
}