Merge pull request auth0#5027 from jeffreylees/lock-android-reorg

Lock-Android docs updates

Author: mpaktiti

articles/libraries/lock-android/_includes/_next-steps.md

@@ -2,7 +2,7 @@
 
 * [Lock v1 Configuration](/libraries/lock-android/v1/configuration)
 * [Lock v1 Use Your Own UI](/libraries/lock-android/v1/use-your-own-ui)
-* [Lock v1 Error Messages](/libraries/lock-android/v1/error-messages)
+* [Auth0 Error Messages](/libraries/error-messages)
 * [Lock v1 Native Social Authentication](/libraries/lock-android/v1/native-social-authentication)
 * [Lock v1 Magic Links](/libraries/lock-android/v1/passwordless-magic-link)
 * [Lock v1 Refresh Tokens](/libraries/lock-android/v1/refresh-jwt-tokens)

articles/libraries/lock-android/v1/configuration.md

@@ -1,15 +1,17 @@
 ---
+toc: true
+title: Lock for Android v1 Configuration
 description: Configuration options and methods for Lock for Android v1
 ---
-## Lock v1 Configuration
+# Lock Android: Configuration
 
 <%= include('../_includes/_lock-version') %>
 
 These are options that can be used to configure Lock for Android v1 to your project's needs.
 
-### Lock
+## Lock
 
-#### Lock Constants
+### Lock Constants
 
 ```java
 public static final String AUTHENTICATION_ACTION;
@@ -41,7 +43,7 @@ public static final String CANCEL_ACTION;
 
 Action sent when the user change its password
 
-#### Lock Properties
+### Lock Properties
 
 ```java
 public boolean shouldUseWebView();
@@ -99,7 +101,7 @@ public boolean isFullscreen();
 
 If Lock's activities should be displayed in Fullscreen. Default is `false`
 
-#### Lock Methods
+### Lock Methods
 
 ```java
 public void setProvider(String serviceName, IdentityProvider provider);
@@ -113,11 +115,11 @@ public void resetAllProviders();
 
 Removes all session information the Identity Provider handlers might have.
 
-### Lock.Builder
+## Lock.Builder
 
 A simple builder to help you create and configure Lock in your application.
 
-#### Lock.Builder Constants
+### Lock.Builder Constants
 
 ```java
 public static final String CLIENT_ID_KEY = "com.auth0.lock.client-id";
@@ -143,7 +145,7 @@ public static final String CONFIGURATION_URL_KEY = "com.auth0.lock.configuration
 
 Key value used by Lock to search in your application's meta-data for configuration Url.
 
-#### Lock.Builder Methods
+### Lock.Builder Methods
 
 ```java
 public Builder clientId(String clientId);

articles/libraries/lock-android/v1/delegation-api.md

@@ -1,5 +1,6 @@
 ---
-toc_title: Delegation API
+toc: true
+title: Lock for Android v1 Delegation
 description: Integrate with third-party apps with the delegation API.
 ---
 # Lock Android: Delegation API

articles/libraries/lock-android/v1/error-messages.md

@@ -1,12 +1,11 @@
 ---
 section: libraries
 toc: true
-toc_title: Lock for Android v1
 title: Lock for Android v1
 description: A widget that provides a frictionless login and signup experience for your native Android apps.
 mobileimg: media/articles/libraries/lock-android.png
 ---
-# Lock for Android
+# Lock Android: Getting Started
 
 <%= include('../_includes/_lock-version') %>
 
@@ -109,9 +108,7 @@ android {
 }
 ```
 
-## Usage
-
-### Email/Password, Enterprise & Social authentication
+## Authentication with Lock
 
 `LockActivity` will handle Email/Password, Enterprise & Social authentication based on your Application's connections enabled in your Auth0's Dashboard.
 
@@ -164,90 +161,6 @@ And you'll see our native login screen
 By default all social authentication will be done using an external browser, if you want native integration please check this [wiki page](/libraries/lock-android/native-social-authentication).
 :::
 
-### Passwordless
-
-`LockPasswordlessActivity` authenticates users by sending them an Email or SMS (similar to how WhatsApp authenticates you). In order to be able to authenticate the user, your application must have the SMS/Email connection enabled and configured in your [dashboard](${manage_url}/#/connections/passwordless).
-
-`LockPasswordlessActivity` is not included in `com.auth0:lock:aar` as it's part of the library `lock-passwordless`, but you can add it with this line in your `build.gradle`:
-
-```gradle
-compile 'com.auth0.android:lock-passwordless:1.+'
-```
-
-Then in your `AndroidManifest.xml` register the following activities:
-
-```xml
-    <!--Auth0 Lock Passwordless-->
-    <activity
-      android:name="com.auth0.lock.passwordless.LockPasswordlessActivity"
-      android:theme="@style/Lock.Theme"
-      android:label="@string/app_name"
-      android:screenOrientation="portrait"
-      android:launchMode="singleTask"/>
-
-    <activity android:name="com.auth0.lock.passwordless.CountryCodeActivity"
-      android:theme="@style/Lock.Theme"/>
-<!--Auth0 Lock Passwordless End-->
-```
-
-Just like `LockActivity`, when a user authenticates successfully, `LockPasswordlessActivity` will send an `Action` using `LocalBroadcastManager` and then finish itself (by calling `finish()`). The activity that is interested in receiving this `Action` (in this case the one that will show Lock) needs to register a listener in the `LocalBroadcastManager`:
-
-```java
-// This activity will show Lock
-public class HomeActivity extends Activity {
-  private LocalBroadcastManager broadcastManager;
-
-  private BroadcastReceiver authenticationReceiver = new BroadcastReceiver() {
-    @Override
-    public void onReceive(Context context, Intent intent) {
-      UserProfile profile = intent.getParcelableExtra(Lock.AUTHENTICATION_ACTION_PROFILE_PARAMETER);
-      Token token = intent.getParcelableExtra(Lock.AUTHENTICATION_ACTION_TOKEN_PARAMETER);
-      Log.i(TAG, "User " + profile.getName() + " logged in");
-    }
-  };
-
-  @Override
-  protected void onCreate(Bundle savedInstanceState) {
-    super.onCreate(savedInstanceState);
-    //Customize your activity
-
-    broadcastManager = LocalBroadcastManager.getInstance(this);
-    broadcastManager.registerReceiver(authenticationReceiver, new IntentFilter(Lock.AUTHENTICATION_ACTION));
-  }
-
-  @Override
-  protected void onDestroy() {
-    super.onDestroy();
-    broadcastManager.unregisterReceiver(authenticationReceiver);
-  }
-}
-```
-
-Then just start `LockPasswordlessActivity` specifying the Passwordless type you want to use, so for **Email**
-
-```java
-LockPasswordlessActivity.showFrom(MyActivity.this, LockPasswordlessActivity.MODE_EMAIL_CODE);
-```
-
-or just for **SMS**
-
-```java
-LockPasswordlessActivity.showFrom(MyActivity.this, LockPasswordlessActivity.MODE_SMS_CODE);
-```
-
-and you'll see the **SMS** login screen
-
-![Lock Screenshot](/media/articles/libraries/lock-android/Lock-SMS-Android-Screenshot.png)
-
-Passworless scenarios and types:
-
-| Channel \ Mode  | Code  | Magic Link      |
-| :-----: |:---------------:| :--------------: |
-| SMS   | `LockPasswordlessActivity.MODE_SMS_CODE`   | `LockPasswordlessActivity.MODE_SMS_LINK`   |
-| Email | `LockPasswordlessActivity.MODE_EMAIL_CODE` | `LockPasswordlessActivity.MODE_EMAIL_LINK` |
-
-You can find more information about Magic Links [here](/libraries/lock-android/passwordless-magic-link).
-
 ## Proguard
 
 In the [proguard directory](https://github.com/auth0/Lock.Android/tree/master/proguard) you can find the *Proguard* configuration for Lock and its dependencies.

articles/libraries/lock-android/v1/index.md

@@ -0,0 +1,36 @@
+---
+section: libraries
+title: Lock Android v1 Internationalization
+description: Internationalization support in Lock for Android
+---
+# Lock Android: Internationalization
+
+<%= include('../_includes/_lock-version') %>
+
+By default, **Lock.Android** displays all text in English. If you wish to display text in another language, you may provide a `strings.xml` file and define values to be used for the various text items that Lock might display.
+
+Android asks the device what _locale_ was configured by the user and tries to fetch the list of localized texts for that language. For this to work, the developer needs to add each translation file into the app by using a special folder naming convention as per Android standards. More information can be found in the [Android developer docs](https://developer.android.com/training/basics/supporting-devices/languages.html).
+
+Some of the default values provided by Lock include:
+
+```html
+<resources>
+  <string name="sms_login_btn_text">Login SMS</string>
+  <string name="no_login_text">Login not found</string>
+  ...
+</resources>
+```
+
+By providing your own `strings.xml` file, these values can be adjusted as such:
+
+```html
+<resources>
+  <string name="sms_login_btn_text">Login with SMS</string>
+  <string name="no_login_text">This user was not found!</string>
+  ...
+</resources>
+```
+
+## Lock String Values
+
+For a full list of the names used by Lock, see the [default strings.xml file](https://github.com/auth0/Lock.Android/blob/v1/app/src/main/res/values/strings.xml) in the Lock.Android repository.

articles/libraries/lock-android/v1/internationalization.md

@@ -1,5 +1,5 @@
 ---
-toc_title: Native Social Authentication
+title: Lock Android v1 Native Social Authentication
 description: How to implement native social authentication with Lock Android
 ---
 # Lock Android: Native Social Authentication

articles/libraries/lock-android/v1/native-social-authentication.md

@@ -1,15 +1,17 @@
 ---
-toc_title: Passwordless with Magic Link
+title: Lock Android v1 Passwordless with Magic Link
 description: Passwordless with Magic Link with Lock Android
 ---
-# Lock Android: Passwordless with Magic Link
+# Lock Android: Passwordless Magic link
 
 <%= include('../_includes/_lock-version') %>
 
 ::: warning
 Passwordless on native platforms is disabled by default for new tenants as of 8 June 2017. If you would like this feature enabled, please contact support to discuss your use case. See [Client Grant Types](/clients/client-grant-types) for more information. Alternatively, you can use Lock Passwordless on Auth0's [Hosted Login Page](/hosted-pages/login).
 :::
 
+## Passwordless Authentication with Magic Link
+
 In order to avoid asking the user to input the one-time password sent for passwordless authentication in Android apps, we introduced the ability to send a link that the user can tap to login without any code input involved.
 
 These links include the same code that would be used in the traditional passwordless flow, but with the correct configuration they will be handled automatically by the Android system and our application will log in the users effortlessly by relying on **Android App Links**.
@@ -28,7 +30,7 @@ The links will work in all versions of Android, but the dialog asking the user w
 
 In this article we'll show how Auth0 helps you set up your app to use app links to log in.
 
-## Auth0 account configuration
+### Auth0 account configuration
 
 Auth0 will generate the [Digital Asset Links](https://developers.google.com/digital-asset-links/) file automatically, all you need to do is configure the required parameters, some via API and others in your [dashboard](${manage_url}/#/connections/passwordless). We'll show you how to do it.
 
@@ -74,9 +76,11 @@ In the *id* field we must introduce the *client_id* of our Auth0 App, and the *b
 Don't forget to change the body to use your package name and keystore fingerprint!
 :::
 
+### Connection Configuration
+
 Next we'll have to configure either the SMS or Email connection. This is available from the dashboard, so we'll show how to do it from there.
 
-### SMS
+#### SMS
 
 In case we'll use a passwordless connection via SMS, we'll need to update the SMS message template from the [dashboard](${manage_url}/#/connections/passwordless).
 
@@ -94,7 +98,7 @@ Your verification code is: {{ code }}
 We assume that you have the SMS connection correctly configured, including the Twilio account. If you haven't, please do so.
 :::
 
-### Email
+#### Email
 
 Otherwise, if we'll use a passwordless connection via Email, we'll need to make sure the template is **HTML + Liquid** and that the email body contains *somewhere* a conditional like this:
 
@@ -106,9 +110,9 @@ Your verification code is: {{ code }}
 {% endif %}
 ```
 
-## Application configuration
+### Application configuration
 
-Now that we have the Auth0 client configured, before we start with the android configuration we must follow the instructions and set up Lock.Android and LockPasswordlessActivity as seen in the [passwordless docs](/libraries/lock-android#passwordless).
+Now that we have the Auth0 client configured, before we start with the Android configuration we must follow the instructions and set up Lock.Android and LockPasswordlessActivity as seen in the [passwordless docs](/libraries/lock-android#passwordless).
 
 Now, in order to use App Links, there is an additional configuration step we must follow. We must declare an intent filter in the `AndroidManifest.xml`, inside the `LockPasswordlessActivity` activity tag. This filter will allow the app lo handle the links we'll send by Email or SMS.
 
@@ -149,7 +153,7 @@ As can be seen, it's a regular *intent-filter*, with the exception of the `andro
 
 Also notice that in case we'll only use one passwordless method (SMS or Email) you could delete the other intent filter (see the last segment of the pathPrefix: `/email` or `/sms`).
 
-## Usage
+### Usage
 
 As you should already know, `LockPasswordlessActivity` authenticates users by sending them an Email or SMS, in this case we'll send them a link instead of a code. The only difference w.r.t. the regular passwordless is that we now explicitly indicate that we will use magic/app links. This is accomplished using the appropiate mode.