Create digital document

shortcuts.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample shortcuts.xml -->
<shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
  <capability android:name="actions.intent.CREATE_DIGITAL_DOCUMENT">
    <intent
      android:action="android.intent.action.VIEW"
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <!-- Eg. name = "Product Requirement Document" -->
      <parameter
        android:name="digitalDocument.name"
        android:key="name"/>
      <!-- Eg. articleBody = "article text" -->
      <parameter
        android:name="digitalDocument.articleBody"
        android:key="articleBody"/>
      <!-- Eg. description = "New Document" -->
      <parameter
        android:name="digitalDocument.description"
        android:key="description"/>
      <!-- Eg. disambiguatingDescription = "Document" -->
      <parameter
        android:name="digitalDocument.disambiguatingDescription"
        android:key="disambiguatingDescription"/>
    </intent>
  </capability>
</shortcuts>
      

actions.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.CREATE_DIGITAL_DOCUMENT">
    <fulfillment urlTemplate="myapp://custom-deeplink{?name,articleBody,description,disambiguatingDescription}">
      <!-- e.g. name = "Product Requirement Document" -->
      <!-- (Optional) Require a field eg.name for fulfillment with required="true" -->
      <parameter-mapping urlParameter="name" intentParameter="digitalDocument.name" required="true" />
      <!-- e.g. articleBody = "article text" -->
      <parameter-mapping urlParameter="articleBody" intentParameter="digitalDocument.articleBody" />
      <!-- e.g. description = "New Document" -->
      <parameter-mapping urlParameter="description" intentParameter="digitalDocument.description" />
      <!-- e.g. disambiguatingDescription = "Document" -->
      <parameter-mapping urlParameter="disambiguatingDescription" intentParameter="digitalDocument.disambiguatingDescription" />
    </fulfillment>

    <!-- Provide a fallback fulfillment with no required parameters. For example, to your app search or router deeplink -->
    <fulfillment urlTemplate="myapp://deeplink" />
  </action>
</actions>

shortcuts.xml

digitalDocument.disambiguatingDescription is an intent parameter that supports inline inventory. By defining a <shortcut> for digitalDocument.disambiguatingDescription, you can uniquely identify entities that are of interest to your app or restrict fulfillment to the set of supported entities.

In the following example, when the user query matches the disambiguatingDescription_one shortcut, Assistant provides the associated shorcut identifier, ID_ONE, as the URL parameter disambiguatingDescription to fulfillment.

If there is no inventory match, the text value received in the query for digitalDocument.disambiguatingDescription is passed as-is.

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample shortcuts.xml -->
<shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
  <capability android:name="actions.intent.CREATE_DIGITAL_DOCUMENT">
    <intent
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <parameter
        android:name="digitalDocument.name"
        android:key="name"/>
      <parameter
        android:name="digitalDocument.articleBody"
        android:key="articleBody"/>
      <parameter
        android:name="digitalDocument.description"
        android:key="description"/>
      <parameter
        android:name="digitalDocument.disambiguatingDescription"
        android:key="disambiguatingDescription"/>
    </intent>
    </capability>
    <!-- Short and long labels must be @string resource. -->
    <shortcut
      android:shortcutId="ID_ONE"
      android:shortcutShortLabel="@string/shortcut_short_label"
      android:shortcutLongLabel="@string/shortcut_long_label">
      <capability-binding android:key="actions.intent.CREATE_DIGITAL_DOCUMENT">
        <parameter-binding
          android:value="disambiguatingDescription"
          android:key="digitalDocument.disambiguatingDescription"/>
      </capability-binding>
    </shortcut>
</shortcuts>
      

actions.xml

digitalDocument.disambiguatingDescription is an intent parameter that supports inline inventory. By defining an <entity-set> for digitalDocument.disambiguatingDescription, you can uniquely identify entities that are of interest to your app or restrict fulfillment to the set of supported entities.

In the following example, when the user query matches the disambiguatingDescription_one entity, Assistant provides the associated identifier, ID_ONE, as the URL parameter disambiguatingDescription to fulfillment.

If there is no inventory match, the text value received in the query for digitalDocument.disambiguatingDescription is passed as-is.

<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.CREATE_DIGITAL_DOCUMENT">
    <fulfillment urlTemplate="myapp://deeplink{?disambiguatingDescription}" >
      <!-- disambiguatingDescription = "ID_ONE" or "ID_TWO"  -->
      <!-- If no inventory match, disambiguatingDescription is a text value, such as "Document" -->
      <!-- (Optional) Use entityMatchRequired="true" to require inventory match for fulfillment -->
      <parameter-mapping urlParameter="disambiguatingDescription" intentParameter="digitalDocument.disambiguatingDescription" />
    </fulfillment>

    <!-- Define parameters with inventories here -->
    <parameter name="digitalDocument.disambiguatingDescription">
      <entity-set-reference entitySetId="disambiguatingDescriptionEntitySet"/>
    </parameter>
  </action>

  <entity-set entitySetId="disambiguatingDescriptionEntitySet">
  <!-- Provide an identifier per entity -->
    <entity identifier="ID_ONE" name="disambiguatingDescription_one" alternateName="@array/disambiguatingDescription_one_synonyms"/>
    <entity identifier="ID_TWO" name="disambiguatingDescription_two" alternateName="@array/disambiguatingDescription_two_synonyms"/>
  </entity-set>
</actions>

The url attribute associated with the entity can be used to determine the fulfillment URL if there is an inventory match. In the following example, when the user query matches the disambiguatingDescription_one entity, Assistant provides myapp://deeplink/one as the fulfillment URL.

  <?xml version="1.0" encoding="utf-8"?>
  <!-- This is a sample actions.xml -->
  <actions>
    <action intentName="actions.intent.CREATE_DIGITAL_DOCUMENT">
      <!-- Use url from inventory match for deep link fulfillment -->
      <fulfillment urlTemplate="{@url}" />

      <!-- Provide a fallback fulfillment with no required parameters. For example, to your app search or router deeplink -->
      <fulfillment urlTemplate="myapp://deeplink" />

      <!-- Define parameters with inventories here -->
      <parameter name="digitalDocument.disambiguatingDescription">
        <entity-set-reference entitySetId="disambiguatingDescriptionEntitySet"/>
      </parameter>
    </action>

    <entity-set entitySetId="disambiguatingDescriptionEntitySet">
      <!-- Provide a URL per entity -->
      <entity url="myapp://deeplink/one" name="disambiguatingDescription_one" alternateName="@array/disambiguatingDescription_one_synonyms"/>
      <entity url="myapp://deeplink/two" name="disambiguatingDescription_two" alternateName="@array/disambiguatingDescription_two_synonyms"/>
    </entity-set>
  </actions>