From fee9e562b8ed90db9bb4fdfc938371e8dceaf2e5 Mon Sep 17 00:00:00 2001 From: Cheryl Potter Date: Tue, 25 Aug 2015 16:19:30 -0700 Subject: [PATCH] docs: fixed code issues, and did a quick edit of text b/23365659 Change-Id: Id1abdbe4eac98a85567bcca64f6ef069bf18f613 --- docs/html/preview/features/app-linking.jd | 128 +++++++++++----------- 1 file changed, 64 insertions(+), 64 deletions(-) diff --git a/docs/html/preview/features/app-linking.jd b/docs/html/preview/features/app-linking.jd index b8fb3008e0144..d603c9658b72c 100644 --- a/docs/html/preview/features/app-linking.jd +++ b/docs/html/preview/features/app-linking.jd @@ -18,26 +18,26 @@ page.keywords=applinking, deeplinks, intents

- The M Developer Preview introduces a new option for handling web site links, allowing clicked - links to go directly to the website's official app, instead of asking the user to chose how to - handle the link. This feature saves the user time and helps developers deliver a better + The M Developer Preview introduces a new option for handling website links. It allows clicked + links to go directly to the website's official app — instead of asking the user to choose + how to handle the link. This feature saves users' time and helps developers deliver a better experience. Users can also select whether an app should always open specific types of links - automatically or prompt the user each time. + automatically, or prompt each time.

Handling links automatically requires the cooperation of app developers and website owners. Developers must configure their apps to declare connections with websites and request - verification. Website owners can publish a - Digital Asset Links file + verification. Website owners should publish a Digital Asset Links file to allow Android to verify the association of apps with their sites. The general steps for creating verified app links are as follows:

    -
  1. Create intent filters within your app for your website URLs
  2. -
  3. Configure your app to request verification of app links
  4. -
  5. Publish a Digital Asset Links JSON file on your websites
  6. +
  7. Create intent filters within your app for your website URLs.
  8. +
  9. Configure your app to request verification of app links.
  10. +
  11. Publish a Digital Asset Links JSON file on your websites.
  12. +
  13. Test that the Android system can verify your app.

Understanding URL Request Handling

@@ -45,35 +45,36 @@ page.keywords=applinking, deeplinks, intents

The app links feature allows your app to become the default handler for your website URLs, as long as the user has not already chosen an app to handle that URL pattern. When a web URI intent - is invoked through a clicked link or programatic request, the Android system determines what app - is used to handle the intent. The system use these criteria, in order, to determine how to handle + is invoked through a clicked link or programmatic request, the Android system determines what app + is used to handle the intent. The system uses these criteria, in order, to determine how to handle the request:

  1. - User has set app link associations: If the user has designated an app to - handle app links, the system passes the web URI request to that app. Users set this association - by opening Settings > Apps > Configure apps (gear icon) > App links, - then selecting an app to use and configuring it's App links property to the + The user has set up a matching app link association. If the user has designated + an app to handle app links, the system passes the web URI request to that app. The user sets + this association by opening + Settings > Apps > Configure apps (gear icon) > App links, and + then selecting an app to use and configuring its App links property to the Open in this app option.
  2. - No association set by user and a single supporting app: If the user - has not set a preference that matches the web URI request, and there is only one app declaring - support for the intent’s URI pattern, the system passes the request to that app. + The user has not set up an association, and there is a single supporting app. + If the user has not set a preference that matches the web URI request, and there is only one app + declaring support for the intent’s URI pattern, the system passes the request to that app.
  3. - No association set by user and multiple supporting apps: If there is - no explicit user preference and there are multiple apps declaring support for the web URI - pattern, the system prompts the user to select one of the available apps + The user has not set up an association, and there are multiple supporting apps. + If there is no explicit user preference and there are multiple apps declaring support for the + web URI pattern, the system prompts the user to select one of the available apps.

- In case #2 (no user setting and no other app handlers), if an app is newly installed and verified + In the second case, if an app is newly installed and verified as a handler for this type of link, the system sets it as the default handler. In the other two cases, the system behavior is the same, regardless of the presence of a verified app link handler. @@ -85,7 +86,7 @@ page.keywords=applinking, deeplinks, intents

App links are based on the Intent framework, which enables apps to handle requests from the system or other apps. Multiple apps may - declare matching web link URI patterns in their intent filters. When a user clicks on a web link + declare matching web link URI patterns in their intent filters. When a user clicks a web link that does not have a default launch handler, the platform selects an app to handle the request, based on the criteria described in the previous section.

@@ -110,15 +111,15 @@ page.keywords=applinking, deeplinks, intents

- As shown in the example above, intent filters for app links must declare an {@code android:scheme} - value of either {@code http} or {@code https}, or both. The filter should not declare - any other schemes. The filter must also include the {@code android.intent.action.VIEW}; and + As shown in this example, intent filters for app links must declare an {@code android:scheme} + value of {@code http}, {@code https}, or both. The filter should not declare + any other schemes. The filter must also include the {@code android.intent.action.VIEW} and {@code android.intent.category.BROWSABLE} category names.

- This manifest declaration defines the connection between your app and a website. However, in - order to have the system treat your app as the default handler for a set of URLs, you must + This manifest declaration defines the connection between your app and a website. However, + to have the system treat your app as the default handler for a set of URLs, you must also request that the system verify this connection, which is explained in the next section.

@@ -126,15 +127,15 @@ page.keywords=applinking, deeplinks, intents

Request App Links Verification

- In addition to declaring an association between your app and a web site using intent filters, + In addition to declaring an association between your app and a website by using intent filters, your app must also request automatic verification with an additional manifest declaration. When - this declaration is set, the Android system attempts to verify your app after it is installed. + this declaration is set, the Android system attempts to verify your app after it's installed. If the verification succeeds, and the user has not set a preference for your website URLs, the system automatically routes those URL requests to your app.

- The system performs app link verifications by comparing the host names in the data elements of + The system performs app link verifications by comparing the hostnames in the data elements of the app’s intent filters against the Digital Asset Links files ({@code assetlinks.json}) hosted on the respective web domains. To enable the system to verify a host, make sure that your intent filter declarations include the {@code android.intent.action.VIEW} intent action and {@code @@ -155,7 +156,7 @@ page.keywords=applinking, deeplinks, intents <intent-filter android:autoVerify="true"> <action android:name="android.intent.action.VIEW" /> - <category android:name="android.intent.category.DEFAULT"gt; + <category android:name="android.intent.category.DEFAULT" /> <category android:name="android.intent.category.BROWSABLE" /> <data android:scheme="http" android:host="www.android.com" /> <data android:scheme="https" android:host="www.android.com" /> @@ -166,7 +167,7 @@ page.keywords=applinking, deeplinks, intents

When the {@code android:autoVerify} attribute is set, the system attempts to verify all hosts - associated with web URI’s in all of your app's intent filters when the app is installed. The + associated with web URIs in all of your app's intent filters when the app is installed. The system treats your app as the default handler for the specified URI pattern only if it successfully verifies all app link patterns declared in your manifest.

@@ -175,8 +176,8 @@ page.keywords=applinking, deeplinks, intents

Supporting app linking for multiple hosts

- The system must be able to verify each host specified in the app’s web URI intent filters’ data - elements against the Digital Asset Links files hosted on the respective web domains. If any + The system must be able to verify each host specified in the data elements of the app’s web URI + intent filters against the Digital Asset Links files hosted on the respective web domains. If any verification fails, the app is not verified to be a default handler for any of the web URL patterns defined in its intent filters. For example, an app with the following intent filters would fail verification if an {@code assetlinks.json} file were not found at both @@ -187,7 +188,7 @@ page.keywords=applinking, deeplinks, intents

 <application>
 
-  <activity android:name=”MainActivity”>
+  <activity android:name="MainActivity">
     <intent-filter android:autoVerify="true">
       <action android:name="android.intent.action.VIEW" />
       <category android:name="android.intent.category.DEFAULT" />
@@ -196,7 +197,7 @@ page.keywords=applinking, deeplinks, intents
       <data android:scheme="https" android:host="www.domain1.com" />
     </intent-filter>
   </activity>
-  <activity android:name=”SecondActivity”>
+  <activity android:name="SecondActivity">
     <intent-filter>
       <action android:name="android.intent.action.VIEW" />
       <category android:name="android.intent.category.DEFAULT" />
@@ -205,7 +206,7 @@ page.keywords=applinking, deeplinks, intents
     </intent-filter>
   </activity>
 
-</application
+</application>
 
@@ -214,7 +215,7 @@ page.keywords=applinking, deeplinks, intents

The Digital Asset Links protocol treats subdomains as unique, separate hosts. If your intent filter lists both the {@code www.example.com} and {@code mobile.example.com} subdomains as - schemes, you must host separate {@code assetlink.json} file on each subdomain. For example, an + schemes, you must host a separate {@code assetlink.json} file on each subdomain. For example, an app with the following intent filter declaration would pass verification only if the website owner published valid {@code assetlinks.json} files at both {@code https://www.example.com/.well-known/assetlinks.json} and @@ -223,7 +224,7 @@ page.keywords=applinking, deeplinks, intents

 <application>
-  <activity android:name=”MainActivity”>
+  <activity android:name="MainActivity">
     <intent-filter android:autoVerify="true">
       <action android:name="android.intent.action.VIEW" />
       <category android:name="android.intent.category.DEFAULT" />
@@ -250,20 +251,20 @@ page.keywords=applinking, deeplinks, intents
 
 

Important: With M Preview 3 and the Android 6.0 (API level 23) release, the JSON - file is verified via the encrypted HTTPS protocol. Make sure that your hosted file can be + file is verified through the encrypted HTTPS protocol. Make sure that your hosted file can be accessed over an HTTPS connection, regardless of whether your app's intent filter declares an - {@code android:scheme} setting of {@code http}, {@code https} or both. + {@code android:scheme} setting of {@code http}, {@code https}, or both.

- A Digital Asset Links JSON file indicates the Android apps that are associated with the web site. + A Digital Asset Links JSON file indicates the Android apps that are associated with the website. The JSON file identifies associated apps with the following fields:

-

This listing indicates the what apps are associated with what domains for that user, as - described below:

+

This listing indicates the apps associated with domains for that user:

- Note:It is possible for a user to change the app link settings for an app + Note: It's possible for a user to change the app link settings for an app before the verification operation has completed. If this - situation occurs, you may see a false positive for a successful verification, even though + situation occurs, you may see a false positive for a successful verification, even if verification has failed. However, the user has already explicitly enabled the app to open supported links without asking. In this case, no dialog is shown and the link goes directly to your app, but only because explicit user preferences take precedence. @@ -503,14 +503,14 @@ Status: always : 200000002

For app link verification to succeed, the system must be able to verify your app with all of - the websites referenced in your app’s intent filters, that meet the criteria for app links. - The following example manifest snippet shows app configuration with several app links defined: + the websites referenced in your app’s intent filters that meet the criteria for app links. + The following example manifest snippet shows an app configuration with several app links defined:

   <application>
 
-      <activity android:name=”MainActivity”>
+      <activity android:name="MainActivity">
           <intent-filter android:autoVerify="true">
               <action android:name="android.intent.action.VIEW" />
               <category android:name="android.intent.category.DEFAULT" />
@@ -525,7 +525,7 @@ Status: always : 200000002
           </intent-filter>
       </activity>
 
-      <activity android:name=”SecondActivity”>
+      <activity android:name="SecondActivity">
           <intent-filter>
               <action android:name="android.intent.action.VIEW" />
               <category android:name="android.intent.category.DEFAULT" />
@@ -534,7 +534,7 @@ Status: always : 200000002
           </intent-filter>
       </activity>
 
-      <activity android:name=”ThirdActivity”>
+      <activity android:name="ThirdActivity">
         <intent-filter>
             <action android:name="android.intent.action.VIEW" />
             <category android:name="android.intent.category.DEFAULT" />
@@ -551,7 +551,7 @@ Status: always : 200000002
 

- The list of hosts that the platform would attempt to verify from the above manifest is: + The list of hosts that the platform would attempt to verify from this manifest is:

@@ -562,7 +562,7 @@ Status: always : 200000002
 

- The list of hosts that the platform would not attempt to verify from the above manifest is: + The list of hosts that the platform would not attempt to verify based on the manifest is: