mirror of
https://github.com/SchildiChat/SchildiChat-android.git
synced 2024-11-25 02:45:53 +03:00
Add missing punctuation
This commit is contained in:
Benoit Marty
parent
92d54dc733
commit
53c83ab8d8
20 changed files with 59 additions and 59 deletions
|
|
@ -19,30 +19,30 @@ package org.matrix.android.sdk.api.auth.registration
|
|||
import org.matrix.android.sdk.api.session.Session
|
||||
|
||||
/**
|
||||
* Either a session or an object containing data about registration stages
|
||||
* Either a session or an object containing data about registration stages.
|
||||
*/
|
||||
sealed class RegistrationResult {
|
||||
/**
|
||||
* The registration is successful, the [Session] is provided
|
||||
* The registration is successful, the [Session] is provided.
|
||||
*/
|
||||
data class Success(val session: Session) : RegistrationResult()
|
||||
|
||||
/**
|
||||
* The registration still miss some steps. See [FlowResult] to know the details
|
||||
* The registration still miss some steps. See [FlowResult] to know the details.
|
||||
*/
|
||||
data class FlowResponse(val flowResult: FlowResult) : RegistrationResult()
|
||||
}
|
||||
|
||||
/**
|
||||
* Information about the missing and completed [Stage]
|
||||
* Information about the missing and completed [Stage].
|
||||
*/
|
||||
data class FlowResult(
|
||||
/**
|
||||
* List of missing stages
|
||||
* List of missing stages.
|
||||
*/
|
||||
val missingStages: List<Stage>,
|
||||
/**
|
||||
* List of completed stages
|
||||
* List of completed stages.
|
||||
*/
|
||||
val completedStages: List<Stage>
|
||||
)
|
||||
|
|
|
|||
|
|
@ -17,38 +17,38 @@
|
|||
package org.matrix.android.sdk.api.auth.registration
|
||||
|
||||
/**
|
||||
* Registration stages
|
||||
* Registration stages.
|
||||
*/
|
||||
sealed class Stage(open val mandatory: Boolean) {
|
||||
|
||||
/**
|
||||
* m.login.recaptcha stage
|
||||
* m.login.recaptcha stage.
|
||||
*/
|
||||
data class ReCaptcha(override val mandatory: Boolean, val publicKey: String) : Stage(mandatory)
|
||||
|
||||
/**
|
||||
* m.login.email.identity stage
|
||||
* m.login.email.identity stage.
|
||||
*/
|
||||
data class Email(override val mandatory: Boolean) : Stage(mandatory)
|
||||
|
||||
/**
|
||||
* m.login.msisdn stage
|
||||
* m.login.msisdn stage.
|
||||
*/
|
||||
data class Msisdn(override val mandatory: Boolean) : Stage(mandatory)
|
||||
|
||||
/**
|
||||
* m.login.dummy, can be mandatory if there is no other stages. In this case the account cannot be created by just sending a username
|
||||
* and a password, the dummy stage has to be done
|
||||
* and a password, the dummy stage has to be done.
|
||||
*/
|
||||
data class Dummy(override val mandatory: Boolean) : Stage(mandatory)
|
||||
|
||||
/**
|
||||
* Undocumented yet: m.login.terms stage
|
||||
* Undocumented yet: m.login.terms stage.
|
||||
*/
|
||||
data class Terms(override val mandatory: Boolean, val policies: TermPolicies) : Stage(mandatory)
|
||||
|
||||
/**
|
||||
* For unknown stages
|
||||
* For unknown stages.
|
||||
*/
|
||||
data class Other(override val mandatory: Boolean, val type: String, val params: Map<*, *>?) : Stage(mandatory)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ package org.matrix.android.sdk.api.cache
|
|||
|
||||
sealed class CacheStrategy {
|
||||
/**
|
||||
* Data is always fetched from the server
|
||||
* Data is always fetched from the server.
|
||||
*/
|
||||
object NoCache : CacheStrategy()
|
||||
|
||||
|
|
@ -29,7 +29,7 @@ sealed class CacheStrategy {
|
|||
data class TtlCache(val validityDurationInMillis: Long, val strict: Boolean) : CacheStrategy()
|
||||
|
||||
/**
|
||||
* Once retrieved, the data is stored in cache and will be always get from the cache
|
||||
* Once retrieved, the data is stored in cache and will be always get from the cache.
|
||||
*/
|
||||
object InfiniteCache : CacheStrategy()
|
||||
}
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ sealed class Failure(cause: Throwable? = null) : Throwable(cause = cause) {
|
|||
object SuccessError : Failure(RuntimeException(RuntimeException("SuccessResult is false")))
|
||||
|
||||
/**
|
||||
* When server send an error, but it cannot be interpreted as a MatrixError
|
||||
* When server send an error, but it cannot be interpreted as a MatrixError.
|
||||
*/
|
||||
data class OtherServerError(val errorBody: String, val httpCode: Int) : Failure(RuntimeException("HTTP $httpCode: $errorBody"))
|
||||
|
||||
|
|
|
|||
|
|
@ -52,50 +52,50 @@ package org.matrix.android.sdk.api.session.crypto.keysbackup
|
|||
*/
|
||||
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
|
||||
* 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
|
||||
}
|
||||
|
|
|
|||
|
|
@ -21,22 +21,22 @@ package org.matrix.android.sdk.api.session.crypto.model
|
|||
*/
|
||||
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
|
||||
}
|
||||
|
|
|
|||
|
|
@ -21,17 +21,17 @@ package org.matrix.android.sdk.api.session.crypto.verification
|
|||
*/
|
||||
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
|
||||
}
|
||||
|
|
|
|||
|
|
@ -18,12 +18,12 @@ package org.matrix.android.sdk.api.session.crypto.verification
|
|||
|
||||
sealed class VerificationTxState {
|
||||
/**
|
||||
* Uninitialized state
|
||||
* Uninitialized state.
|
||||
*/
|
||||
object None : VerificationTxState()
|
||||
|
||||
/**
|
||||
* Specific for SAS
|
||||
* Specific for SAS.
|
||||
*/
|
||||
abstract class VerificationSasTxState : VerificationTxState()
|
||||
|
||||
|
|
@ -43,25 +43,25 @@ sealed class VerificationTxState {
|
|||
object Verifying : VerificationSasTxState()
|
||||
|
||||
/**
|
||||
* Specific for QR code
|
||||
* Specific for QR code.
|
||||
*/
|
||||
abstract class VerificationQrTxState : VerificationTxState()
|
||||
|
||||
/**
|
||||
* Will be used to ask the user if the other user has correctly scanned
|
||||
* Will be used to ask the user if the other user has correctly scanned.
|
||||
*/
|
||||
object QrScannedByOther : VerificationQrTxState()
|
||||
object WaitingOtherReciprocateConfirm : VerificationQrTxState()
|
||||
|
||||
/**
|
||||
* Terminal states
|
||||
* Terminal states.
|
||||
*/
|
||||
abstract class TerminalTxState : VerificationTxState()
|
||||
|
||||
object Verified : TerminalTxState()
|
||||
|
||||
/**
|
||||
* Cancelled by me or by other
|
||||
* Cancelled by me or by other.
|
||||
*/
|
||||
data class Cancelled(val cancelCode: CancelCode, val byMe: Boolean) : TerminalTxState()
|
||||
}
|
||||
|
|
|
|||
|
|
@ -18,42 +18,42 @@ package org.matrix.android.sdk.api.session.room.send
|
|||
|
||||
enum class SendState {
|
||||
/**
|
||||
* The state is unknown
|
||||
* 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;
|
||||
|
||||
|
|
|
|||
|
|
@ -21,17 +21,17 @@ package org.matrix.android.sdk.api.session.threads
|
|||
*/
|
||||
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
|
||||
* The is at least one new message that should be highlighted.
|
||||
* ex. "Hello @aris.kotsomitopoulos"
|
||||
*/
|
||||
NEW_HIGHLIGHTED_MESSAGE;
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ package org.matrix.android.sdk.userstories
|
|||
|
||||
/**
|
||||
* ### Title
|
||||
* Init a Matrix object
|
||||
* Init a Matrix object.
|
||||
*
|
||||
* ### Required APIs:
|
||||
* - [org.matrix.android.sdk.api.Matrix] constructor
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ package org.matrix.android.sdk.userstories
|
|||
|
||||
/**
|
||||
* ### Title
|
||||
* Sign in to an existing account
|
||||
* Sign in to an existing account.
|
||||
*
|
||||
* #### Required APIs:
|
||||
* - [org.matrix.android.sdk.api.Matrix.authenticationService]
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ package org.matrix.android.sdk.userstories
|
|||
|
||||
/**
|
||||
* ### Title
|
||||
* Verify a Session after a Sign in
|
||||
* Verify a Session after a Sign in.
|
||||
*
|
||||
* #### Required APIs:
|
||||
* - TODO
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ package org.matrix.android.sdk.userstories
|
|||
|
||||
/**
|
||||
* ### Title
|
||||
* Sign out
|
||||
* Sign out.
|
||||
*
|
||||
* #### Required APIs:
|
||||
* - TODO
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ package org.matrix.android.sdk.userstories
|
|||
|
||||
/**
|
||||
* ### Title
|
||||
* Get the Room list
|
||||
* Get the Room list.
|
||||
*
|
||||
* #### Required APIs:
|
||||
* - TODO
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ package org.matrix.android.sdk.userstories
|
|||
|
||||
/**
|
||||
* ### Title
|
||||
* Display a Room timeline, and navigate backward and forward
|
||||
* Display a Room timeline, and navigate backward and forward.
|
||||
*
|
||||
* #### Required APIs:
|
||||
* - TODO
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ package org.matrix.android.sdk.userstories
|
|||
|
||||
/**
|
||||
* ### Title
|
||||
* Display a Room timeline at a specific point
|
||||
* Display a Room timeline at a specific point.
|
||||
*
|
||||
* #### Required APIs:
|
||||
* - TODO
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ package org.matrix.android.sdk.userstories
|
|||
|
||||
/**
|
||||
* ### Title
|
||||
* Send content to a room, including monitoring the sending state
|
||||
* Send content to a room, including monitoring the sending state.
|
||||
*
|
||||
* #### Required APIs:
|
||||
* - TODO
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ package org.matrix.android.sdk.userstories
|
|||
|
||||
/**
|
||||
* ### Title
|
||||
* Get notified when new Events are received
|
||||
* Get notified when new Events are received.
|
||||
*
|
||||
* #### Required APIs:
|
||||
* - TODO
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ package org.matrix.android.sdk.userstories
|
|||
|
||||
/**
|
||||
* ### Title
|
||||
* Manage the sync with the server
|
||||
* Manage the sync with the server.
|
||||
*
|
||||
* #### Required APIs:
|
||||
* - TODO
|
||||
|
|
|
|||
Loading…
Reference in a new issue