{@code
* Auth0 auth0 = new Auth0("YOUR_CLIENT_ID", "YOUR_DOMAIN");
@@ -65,7 +65,7 @@ public Auth0(@NonNull Context context) {
}
/**
- * Creates a new object using clientId & domain
+ * Creates a new object using clientId {@literal &} domain
*
* @param clientId of your Auth0 application
* @param domain of your Auth0 account
@@ -167,13 +167,17 @@ public void setOIDCConformant(boolean enabled) {
/**
* If the clients works in OIDC conformant mode or not
+ *
+ * @return whether the android client is OIDC conformant or not.
*/
public boolean isOIDCConformant() {
return oidcConformant;
}
/**
- * @return if every Request, Response and other sensitive information should be logged.
+ * Getter for the HTTP logger is enabled or not.
+ *
+ * @return whether every Request, Response and other sensitive information should be logged or not.
*/
public boolean isLoggingEnabled() {
return loggingEnabled;
diff --git a/auth0/src/main/java/com/auth0/android/authentication/AuthenticationAPIClient.java b/auth0/src/main/java/com/auth0/android/authentication/AuthenticationAPIClient.java
index fa6306716..a79b57524 100755
--- a/auth0/src/main/java/com/auth0/android/authentication/AuthenticationAPIClient.java
+++ b/auth0/src/main/java/com/auth0/android/authentication/AuthenticationAPIClient.java
@@ -61,11 +61,12 @@
/**
* API client for Auth0 Authentication API.
- *
- *
+ *
+ * {@code
* Auth0 auth0 = new Auth0("your_client_id", "your_domain");
* AuthenticationAPIClient client = new AuthenticationAPIClient(auth0);
- *
+ * }
+ *
*
* @see Auth API docs
*/
@@ -159,12 +160,11 @@ public void setUserAgent(String userAgent) {
/**
* Log in a user with email/username and password for a connection/realm.
- * * In OIDC conformant mode ({@link Auth0#isOIDCConformant()}) it will use the password-realm grant type for the {@code /oauth/token} endpoint * otherwise it will use {@code /oauth/ro} - *
* Example: - *
+ *
+ * {@code
* client
* .login("{username or email}", "{password}", "{database connection name}")
* .start(new BaseCallback() {
@@ -174,7 +174,8 @@ public void setUserAgent(String userAgent) {
* {@literal}Override
* public void onFailure(AuthenticationException error) { }
* });
- *
+ *
+ * {@code
* client.login("{username or email}", "{password}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -216,7 +218,8 @@ public AuthenticationRequest login(@NonNull String usernameOrEmail, @NonNull Str
* {@literal}Override
* public void onFailure(AuthenticationException error) { }
* });
- *
+ *
+ * {@code
* client.loginWithOAuthAccessToken("{token}", "{connection name}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -246,7 +250,8 @@ public AuthenticationRequest login(@NonNull String usernameOrEmail, @NonNull Str
* {@literal}Override
* public void onFailure(AuthenticationException error) { }
* });
- *
+ *
+ * {@code
* client.loginWithPhoneNumber("{phone number}", "{code}", "{passwordless connection name}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -282,7 +288,8 @@ public AuthenticationRequest loginWithOAuthAccessToken(@NonNull String token, @N
* {@literal}@Override
* public void onFailure(AuthenticationException error) { }
* });
- *
+ *
+ * {@code
* client.loginWithPhoneNumber("{phone number}", "{code}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -314,7 +322,8 @@ public AuthenticationRequest loginWithPhoneNumber(@NonNull String phoneNumber, @
* {@literal}@Override
* public void onFailure(AuthenticationException error) { }
* });
- *
+ *
+ * {@code
* client.loginWithEmail("{email}", "{code}", "{passwordless connection name}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -338,7 +348,8 @@ public AuthenticationRequest loginWithPhoneNumber(@NonNull String phoneNumber, @
* {@literal}@Override
* public void onFailure(AuthenticationException error) { }
* });
- *
+ *
+ * {@code
* client.loginWithEmail("{email}", "{code}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -370,7 +382,8 @@ public AuthenticationRequest loginWithEmail(@NonNull String email, @NonNull Stri
* {@literal}@Override
* public void onFailure(AuthenticationException error) { }
* });
- *
+ *
+ * {@code
* client.userInfo("{access_token}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -393,7 +407,8 @@ public AuthenticationRequest loginWithEmail(@NonNull String email, @NonNull Stri
* {@literal}@Override
* public void onFailure(AuthenticationException error) { }
* });
- * * Example usage: - *
+ *
+ * {@code
* client.tokenInfo("{id_token}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -417,7 +432,8 @@ public Request userInfo(@NonNull String ac
* {@literal}@Override
* public void onFailure(AuthenticationException error) { }
* });
- *
+ *
+ * {@code
* client.createUser("{email}", "{password}", "{username}", "{database connection name}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -446,7 +463,8 @@ public Request tokenInfo(@NonNull String i
* {@literal}@Override
* public void onFailure(AuthenticationException error) { }
* });
- *
+ *
+ * {@code
* client.createUser("{email}", "{password}", "{database connection name}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -486,7 +505,8 @@ public DatabaseConnectionRequest createUs
* {@literal}@Override
* public void onFailure(AuthenticationException error) { }
* });
- *
+ *
+ * {@code
* client.signUp("{email}", "{password}", "{username}", "{database connection name}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -512,7 +533,8 @@ public DatabaseConnectionRequest createUs
* {@literal}Override
* public void onFailure(AuthenticationException error) {}
* });
- *
+ *
+ * {@code
* client.signUp("{email}", "{password}", "{database connection name}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -541,7 +564,8 @@ public SignUpRequest signUp(@NonNull String email, @NonNull String password, @No
* {@literal}Override
* public void onFailure(AuthenticationException error) {}
* });
- *
+ *
+ * {@code
* client.resetPassword("{email}", "{database connection name}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -567,7 +592,8 @@ public SignUpRequest signUp(@NonNull String email, @NonNull String password, @No
* {@literal}Override
* public void onFailure(AuthenticationException error) {}
* });
- * * Example usage: - *
+ *
+ * {@code
* client.renewAuth("{refresh_token}")
* .addParameter("scope", "openid profile email")
* .start(new BaseCallback() {
@@ -607,7 +633,8 @@ public DatabaseConnectionRequest resetPassword(@N
* {@literal}@Override
* public void onFailure(AuthenticationException error) { }
* });
- *
+ *
+ * {@code
* client.delegationWithIdToken("{id token}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -648,7 +676,8 @@ public ParameterizableRequest renewAuth(@N
* {@literal}Override
* public void onFailure(AuthenticationException error) {}
* });
- *
+ *
+ * {@code
* client.delegationWithRefreshToken("{refresh token}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -675,7 +705,8 @@ public DelegationRequest delegationWithIdToken(@NonNull String idTok
* {@literal}Override
* public void onFailure(AuthenticationException error) {}
* });
- *
+ *
+ * {@code
* client.delegationWithIdToken("{id token}", "{app type, e.g. firebase}")
* .start(new BaseCallback>() {
* {@literal}Override
@@ -701,7 +733,8 @@ public DelegationRequest delegationWithRefreshToken(@NonNull String
* {@literal}Override
* public void onFailure(AuthenticationException error) {}
* });
- *
+ *
+ * {@code
* client.passwordlessWithEmail("{email}", PasswordlessType.CODE, "{passwordless connection name}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -728,10 +762,12 @@ public DelegationRequest> delegationWithIdToken(@NonNull Str
* {@literal}Override
* public void onFailure(AuthenticationException error) {}
* });
- *
+ *
+ * {@code
* client.passwordlessWithEmail("{email}", PasswordlessType.CODE)
* .start(new BaseCallback() {
* {@literal}Override
@@ -759,10 +796,11 @@ public ParameterizableRequest passwordlessWithEma
* {@literal}Override
* public void onFailure(AuthenticationException error) {}
* });
- *
+ *
+ * {@code
* client.passwordlessWithSms("{phone number}", PasswordlessType.CODE, "{passwordless connection name}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -782,10 +821,12 @@ public ParameterizableRequest passwordlessWithEma
* {@literal}Override
* public void onFailure(AuthenticationException error) {}
* });
- *
+ *
+ * {@code
* client.passwordlessWithSms("{phone number}", PasswordlessType.CODE)
* .start(new BaseCallback() {
* {@literal}Override
@@ -812,10 +854,11 @@ public ParameterizableRequest passwordlessWithSMS
* {@literal}Override
* public void onFailure(AuthenticationException error) {}
* });
- *
+ *
+ * {@code
* client.delegation()
* .addParameter("api_type", "firebase")
* .start(new BaseCallback>() {
@@ -837,7 +881,8 @@ public ParameterizableRequest passwordlessWithSMS
* {@literal}Override
* public void onFailure(AuthenticationException error) {}
* });
- * {@code
+ *
+ * {@code
* AuthenticationAPIClient client = new AuthenticationAPIClient(new Auth0("clientId", "domain"));
* client
* .token("code", "redirect_uri")
* .setCodeVerifier("code_verifier")
* .start(new Callback {...});
- * }
- *
+ * }
+ *
* For the rest of clients, clients who can safely keep a {@literal client_secret}, you need to provide it instead like:
- *
- * {@code
+ *
+ * {@code
* AuthenticationAPIClient client = new AuthenticationAPIClient(new Auth0("clientId", "domain"));
* client
* .token("code", "redirect_uri")
* .start(new Callback {...});
- * }
+ * }
+ *
*
* @param authorizationCode the authorization code received from the /authorize call.
* @param redirectUri the uri sent to /authorize as the 'redirect_uri'.
diff --git a/auth0/src/main/java/com/auth0/android/authentication/ParameterBuilder.java b/auth0/src/main/java/com/auth0/android/authentication/ParameterBuilder.java
index 29827558e..feb265adc 100755
--- a/auth0/src/main/java/com/auth0/android/authentication/ParameterBuilder.java
+++ b/auth0/src/main/java/com/auth0/android/authentication/ParameterBuilder.java
@@ -32,15 +32,16 @@
/**
* Builder for Auth0 Authentication API parameters
- *
* You can build your parameters like this
- *
- * Map parameters = ParameterBuilder.newBuilder()
- * .setClientId("{CLIENT_ID}")
- * .setConnection("{CONNECTION}")
- * .set("{PARAMETER_NAME}", "{PARAMETER_VALUE}")
- * .asDictionary();
- *
+ * {@code
+ * Map parameters = ParameterBuilder.newBuilder()
+ * .setClientId("{CLIENT_ID}")
+ * .setConnection("{CONNECTION}")
+ * .set("{PARAMETER_NAME}", "{PARAMETER_VALUE}")
+ * .asDictionary();
+ * }
+ *
*
* @see ParameterBuilder#newBuilder()
* @see ParameterBuilder#newAuthenticationBuilder()
diff --git a/auth0/src/main/java/com/auth0/android/management/UsersAPIClient.java b/auth0/src/main/java/com/auth0/android/management/UsersAPIClient.java
index 0f860ea51..517bc9674 100755
--- a/auth0/src/main/java/com/auth0/android/management/UsersAPIClient.java
+++ b/auth0/src/main/java/com/auth0/android/management/UsersAPIClient.java
@@ -49,11 +49,12 @@
/**
* API client for Auth0 Management API.
- *
- *
+ *
+ * {@code
* Auth0 auth0 = new Auth0("your_client_id", "your_domain");
* UsersAPIClient client = new UsersAPIClient(auth0);
- *
+ *
+ * {@code
* client.link("{auth0 primary user id}", "{user secondary token}")
* .start(new BaseCallback>() {
* {@literal}Override
@@ -144,7 +146,8 @@ public void setUserAgent(String userAgent) {
* {@literal}Override
* public void onFailure(ManagementException error) {}
* });
- *
+ *
+ * {@code
* client.unlink("{auth0 primary user id}", {auth0 secondary user id}, "{secondary provider}")
* .start(new BaseCallback>() {
* {@literal}Override
@@ -182,7 +186,8 @@ public Request, ManagementException> link(String primaryUserI
* {@literal}Override
* public void onFailure(ManagementException error) {}
* });
- *
+ *
+ * {@code
* client.updateMetadata("{user id}", "{user metadata}")
* .start(new BaseCallback() {
* {@literal}Override
@@ -218,7 +224,8 @@ public Request, ManagementException> unlink(String primaryUse
* {@literal}Override
* public void onFailure(ManagementException error) {}
* });
- *