Add more doc

This commit is contained in:
Benoit Marty 2021-05-14 11:44:44 +02:00
parent d6e3bb59f4
commit c27b7aec26
1 changed files with 6 additions and 0 deletions

View File

@ -19,7 +19,13 @@ package org.matrix.android.sdk.api.auth.registration
/** /**
* Set of methods to be able to create an account on a homeserver. * Set of methods to be able to create an account on a homeserver.
* *
* Common scenario to register an account successfully:
* - Call [getRegistrationFlow] to check that you application supports all the mandatory registration stages
* - Call [createAccount] to start the account creation
* - Fulfill all mandatory stages using the methods [performReCaptcha] [acceptTerms] [dummy], etc.
*
* More documentation can be found in the file https://github.com/vector-im/element-android/blob/main/docs/signup.md * More documentation can be found in the file https://github.com/vector-im/element-android/blob/main/docs/signup.md
* and https://matrix.org/docs/spec/client_server/latest#account-registration-and-management
*/ */
interface RegistrationWizard { interface RegistrationWizard {
/** /**