Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a32c4376 authored by Scott Main's avatar Scott Main
Browse files

update to wear docs. 

includes javadoc changes from Id95383d18f9a679927f462822335dce8890fa414
and html doc changes from patch set 9 from I949011be5abfb5190dc5716ce935d1555ff1b2ad

Change-Id: I035b8db9b266e0af16fe30b3f30846608a3b69a5
parent ace69017

docs/html/reference/android/preview/support/v4/app/NotificationManagerCompat.html

+60 −4
Original line number Original line Diff line number Diff line
@@ -1031,6 +1031,16 @@ From class 
    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>Cancel a previously shown notification.</p></div>

  <div class="jd-tagdata jd-tagdescr"><p>Cancel a previously shown notification.</p></div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Parameters</h5>

      <table class="jd-tagtable">

        <tr>

          <th>id</td>

          <td>the ID of the notification

</td>

        </tr>

      </table>

  </div>





    </div>

    </div>

</div>

</div>
@@ -1060,6 +1070,20 @@ From class 
    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>Cancel a previously shown notification.</p></div>

  <div class="jd-tagdata jd-tagdescr"><p>Cancel a previously shown notification.</p></div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Parameters</h5>

      <table class="jd-tagtable">

        <tr>

          <th>tag</td>

          <td>the string identifier of the notification.</td>

        </tr>

        <tr>

          <th>id</td>

          <td>the ID of the notification

</td>

        </tr>

      </table>

  </div>





    </div>

    </div>

</div>

</div>
@@ -1178,6 +1202,20 @@ From class 
    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>Post a notification to be shown in the status bar, stream, etc.</p></div>

  <div class="jd-tagdata jd-tagdescr"><p>Post a notification to be shown in the status bar, stream, etc.</p></div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Parameters</h5>

      <table class="jd-tagtable">

        <tr>

          <th>id</td>

          <td>the ID of the notification</td>

        </tr>

        <tr>

          <th>notification</td>

          <td>the notification to post to the system

</td>

        </tr>

      </table>

  </div>





    </div>

    </div>

</div>

</div>
@@ -1207,6 +1245,24 @@ From class 
    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>Post a notification to be shown in the status bar, stream, etc.</p></div>

  <div class="jd-tagdata jd-tagdescr"><p>Post a notification to be shown in the status bar, stream, etc.</p></div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Parameters</h5>

      <table class="jd-tagtable">

        <tr>

          <th>tag</td>

          <td>the string identifier for a notification. Can be <code>null</code>.</td>

        </tr>

        <tr>

          <th>id</td>

          <td>the ID of the notification. The pair (tag, id) must be unique within your app.</td>

        </tr>

        <tr>

          <th>notification</td>

          <td>the notification to post to the system

</td>

        </tr>

      </table>

  </div>





    </div>

    </div>

</div>

</div>

docs/html/reference/android/preview/support/wearable/notifications/RemoteInput.Builder.html

+56 −11
Original line number Original line Diff line number Diff line
@@ -886,11 +886,14 @@ From class 
      <table class="jd-tagtable">

      <table class="jd-tagtable">

        <tr>

        <tr>

          <th>returnKey</td>

          <th>returnKey</td>

          <td>the extras key to be set with input collected from the user

          <td>the intent extras key that refers to the input collected from the user</td>

         when the intent is sent.

</td>

        </tr>

        </tr>

      </table>

      </table>

  </div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Returns</h5>

      <ul class="nolist"><li>this object for method chaining

</li></ul>

  </div>

  </div>





    </div>

    </div>
@@ -966,10 +969,24 @@ From class 
      </div>

      </div>

    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>Specifies whether the user can provide arbitrary values.  The

  <div class="jd-tagdata jd-tagdescr"><p>Specifies whether the user can provide arbitrary values.</p></div>

 default is <code>true</code>.  If this is set to <code>false</code>, a

  <div class="jd-tagdata">

 non-null non-empty value should be passed to <code><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.Builder.html#setChoices(java.lang.String[])">setChoices(String[])</a></code>.

      <h5 class="jd-tagtitle">Parameters</h5>

</p></div>

      <table class="jd-tagtable">

        <tr>

          <th>allowFreeFormInput</td>

          <td>The default is <code>true</code>.

         If you specify <code>false</code>, you must

         provide a non-null and non-empty array to <code><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.Builder.html#setChoices(java.lang.String[])">setChoices(String[])</a></code> or

         an <code><a href="http://developer.android.com/reference/java/lang/IllegalArgumentException.html">IllegalArgumentException</a></code> is thrown.</td>

        </tr>

      </table>

  </div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Returns</h5>

      <ul class="nolist"><li>this object for method chaining

</li></ul>

  </div>





    </div>

    </div>

</div>

</div>
@@ -998,8 +1015,23 @@ From class 
      </div>

      </div>

    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>Specifies choices available to the user to satisfy this input.

  <div class="jd-tagdata jd-tagdescr"><p>Specifies choices available to the user to satisfy this input.</p></div>

</p></div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Parameters</h5>

      <table class="jd-tagtable">

        <tr>

          <th>choices</td>

          <td>an array of pre-defined choices for users input.

        You must provide a non-null and non-empty array if

        you set <code><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html#allowFreeFormInput">allowFreeFormInput</a></code> to <code>false</code>.</td>

        </tr>

      </table>

  </div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Returns</h5>

      <ul class="nolist"><li>this object for method chaining

</li></ul>

  </div>





    </div>

    </div>

</div>

</div>
@@ -1028,8 +1060,21 @@ From class 
      </div>

      </div>

    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>Set a label to be displayed to the user when collecting this input.

  <div class="jd-tagdata jd-tagdescr"><p>Set a label to be displayed to the user when collecting this input.</p></div>

</p></div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Parameters</h5>

      <table class="jd-tagtable">

        <tr>

          <th>label</td>

          <td>The label to show to users when they input a response.</td>

        </tr>

      </table>

  </div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Returns</h5>

      <ul class="nolist"><li>this object for method chaining

</li></ul>

  </div>





    </div>

    </div>

</div>

</div>

docs/html/reference/android/preview/support/wearable/notifications/RemoteInput.html

+30 −26
Original line number Original line Diff line number Diff line
@@ -467,22 +467,27 @@ Summary: 








<h2>Class Overview</h2>

<h2>Class Overview</h2>

<p itemprop="articleBody">A RemoteInput specifies a response to be collected from the user as part of an intent being

<p itemprop="articleBody">A <code>RemoteInput</code> object collects a response from users and sets the

 sent. For example, when used with a notification Action, a response may be collected

 response as an intent extra inside the <code><a href="http://developer.android.com/reference/android/app/PendingIntent.html">PendingIntent</a></code> that is sent.

 when the user triggers the action, and the results sent as data along with the action's

 Always use <code><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.Builder.html">RemoteInput.Builder</a></code> to create instances of this class.

 PendingIntent. The result value is set in the extras of the triggered Intent with the key

 <p class="note"> See

 <code><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html#returnKey">returnKey</a></code>.

 <a href="/wear/notifications/remote-input.html">Receiving Voice Input from



 a Notification</a> for more information on how to use this class.

 <p>Use the builder class <code><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.Builder.html">RemoteInput.Builder</a></code> to create this object.





 <p>The following example adds a <code>RemoteInput</code> to a <code><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html">WearableNotifications.Action</a></code>,

 <p>Example which adds a RemoteInput to an Action:

 sets the intent extra key as <code>quick_reply</code>, and sets the label as <code>Quick Reply</code>.

 Users are prompted to input a response when they trigger the action. The results are sent as an

 intent extra with the key of <code><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html#returnKey">returnKey</a></code> in the action's

 <code><a href="http://developer.android.com/reference/android/app/PendingIntent.html">PendingIntent</a></code>.





 <pre class="prettyprint">

 <pre class="prettyprint">

 public static final String EXTRA_QUICK_REPLY_TEXT = "quick_reply";

 WearableNotifications.Action action = new WearableNotifications.Action.Builder(

 WearableNotifications.Action action = new WearableNotifications.Action.Builder(

         R.drawable.reply, &quot;Reply&quot;, actionIntent)

         R.drawable.reply, &quot;Reply&quot;, actionIntent)

         .addRemoteInput(new RemoteInput.Builder(EXTRA_QUICK_REPLY_TEXT)

         <b>.addRemoteInput(new RemoteInput.Builder(EXTRA_QUICK_REPLY_TEXT)

                 .setLabel("Quick reply").build())

                 .setLabel("Quick reply").build()</b>)

         .build();</pre>

         .build();</pre>



</p>

</p>
@@ -619,8 +624,8 @@ android.os.Parcelable 
          final

          final

          boolean</nobr></td>

          boolean</nobr></td>

          <td class="jd-linkcol"><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html#allowFreeFormInput">allowFreeFormInput</a></td>

          <td class="jd-linkcol"><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html#allowFreeFormInput">allowFreeFormInput</a></td>

          <td class="jd-descrcol" width="100%">Indicates whether or not the user may provide an arbitrary value for

          <td class="jd-descrcol" width="100%">Indicates whether or not users can provide an arbitrary value for

 this input.</td>

 input.</td>

      </tr>

      </tr>
@@ -631,7 +636,7 @@ android.os.Parcelable 
          final

          final

          <a href="http://developer.android.com/reference/java/lang/String.html">String[]</a></nobr></td>

          <a href="http://developer.android.com/reference/java/lang/String.html">String[]</a></nobr></td>

          <td class="jd-linkcol"><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html#choices">choices</a></td>

          <td class="jd-linkcol"><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html#choices">choices</a></td>

          <td class="jd-descrcol" width="100%">The choices available to the user.</td>

          <td class="jd-descrcol" width="100%">Possible input choices.</td>

      </tr>

      </tr>
@@ -642,7 +647,7 @@ android.os.Parcelable 
          final

          final

          <a href="http://developer.android.com/reference/java/lang/String.html">String</a></nobr></td>

          <a href="http://developer.android.com/reference/java/lang/String.html">String</a></nobr></td>

          <td class="jd-linkcol"><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html#label">label</a></td>

          <td class="jd-linkcol"><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html#label">label</a></td>

          <td class="jd-descrcol" width="100%">The label to be displayed to the user when collecting this input.</td>

          <td class="jd-descrcol" width="100%">The label to display to users when collecting this input.</td>

      </tr>

      </tr>
@@ -653,8 +658,7 @@ android.os.Parcelable 
          final

          final

          <a href="http://developer.android.com/reference/java/lang/String.html">String</a></nobr></td>

          <a href="http://developer.android.com/reference/java/lang/String.html">String</a></nobr></td>

          <td class="jd-linkcol"><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html#returnKey">returnKey</a></td>

          <td class="jd-linkcol"><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html#returnKey">returnKey</a></td>

          <td class="jd-descrcol" width="100%">The extras key to be populated with input from the user when the

          <td class="jd-descrcol" width="100%">The lookup key for the intent extra that the response is set in.</td>

 intent is sent.</td>

      </tr>

      </tr>
@@ -1062,10 +1066,10 @@ From interface 
      </div>

      </div>

    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>Indicates whether or not the user may provide an arbitrary value for

  <div class="jd-tagdata jd-tagdescr"><p>Indicates whether or not users can provide an arbitrary value for

 this input.  If set to false, then the user should select one of the

 input. If you set this to <code>false</code>, users must select one of the

 provided choices.  It is an error to set this to <code>false</code> and

 provided <code><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html#choices">choices</a></code>. An <code><a href="http://developer.android.com/reference/java/lang/IllegalArgumentException.html">IllegalArgumentException</a></code> is thrown

 not provide <code><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html#choices">choices</a></code>.

 if you set this to false and <code><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html#choices">choices</a></code> is <code>null</code> or empty.

</p></div>

</p></div>
@@ -1094,8 +1098,8 @@ From interface 
      </div>

      </div>

    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>The choices available to the user.  May be null if there are no choices

  <div class="jd-tagdata jd-tagdescr"><p>Possible input choices. This can be <code>null</code>

 to present to the user.

 if there are no choices to present.

</p></div>

</p></div>
@@ -1124,7 +1128,7 @@ From interface 
      </div>

      </div>

    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>The label to be displayed to the user when collecting this input.

  <div class="jd-tagdata jd-tagdescr"><p>The label to display to users when collecting this input.

</p></div>

</p></div>
@@ -1153,8 +1157,8 @@ From interface 
      </div>

      </div>

    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>The extras key to be populated with input from the user when the

  <div class="jd-tagdata jd-tagdescr"><p>The lookup key for the intent extra that the response is set in. This is populated

 intent is sent.

 when the <code><a href="http://developer.android.com/reference/android/app/PendingIntent.html">PendingIntent</a></code> is sent.

</p></div>

</p></div>

docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.Builder.html

+42 −17
Original line number Original line Diff line number Diff line
@@ -448,15 +448,6 @@ Summary: 




<h2>Class Overview</h2>

<h2>Class Overview</h2>

<p itemprop="articleBody">Builder class for <code><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html">WearableNotifications.Action</a></code> objects.

<p itemprop="articleBody">Builder class for <code><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html">WearableNotifications.Action</a></code> objects.



 <p>Example:



 <pre class="prettyprint">

 WearableNotifications.Builder builder = new WearableNotifications.Builder(mContext)

         .addAction(new WearableNotifications.Action.Builder(

                 R.drawable.navigate, &quot;Navigate&quot, pendingIntent)

                 .build());

 Notification notif = builder.build();</pre>

</p>

</p>
@@ -525,7 +516,7 @@ Summary: 
        <td class="jd-linkcol" width="100%"><nobr>

        <td class="jd-linkcol" width="100%"><nobr>

        <span class="sympad"><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.Builder.html#WearableNotifications.Action.Builder(int, java.lang.CharSequence, android.app.PendingIntent)">WearableNotifications.Action.Builder</a></span>(int icon, <a href="http://developer.android.com/reference/java/lang/CharSequence.html">CharSequence</a> title, <a href="http://developer.android.com/reference/android/app/PendingIntent.html">PendingIntent</a> intent)</nobr>

        <span class="sympad"><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.Builder.html#WearableNotifications.Action.Builder(int, java.lang.CharSequence, android.app.PendingIntent)">WearableNotifications.Action.Builder</a></span>(int icon, <a href="http://developer.android.com/reference/java/lang/CharSequence.html">CharSequence</a> title, <a href="http://developer.android.com/reference/android/app/PendingIntent.html">PendingIntent</a> intent)</nobr>

        

        

        <div class="jd-descrdiv">Construct a new builder for an <code><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html">WearableNotifications.Action</a></code> object.</div>

        <div class="jd-descrdiv">Construct a new builder for <code><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html">WearableNotifications.Action</a></code> object.</div>

  

  

  </td></tr>

  </td></tr>
@@ -872,8 +863,25 @@ From class 
      </div>

      </div>

    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>Construct a new builder for an <code><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html">WearableNotifications.Action</a></code> object.

  <div class="jd-tagdata jd-tagdescr"><p>Construct a new builder for <code><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html">WearableNotifications.Action</a></code> object.</p></div>

</p></div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Parameters</h5>

      <table class="jd-tagtable">

        <tr>

          <th>icon</td>

          <td>icon to show for this action</td>

        </tr>

        <tr>

          <th>title</td>

          <td>the title of the action</td>

        </tr>

        <tr>

          <th>intent</td>

          <td>the <code><a href="http://developer.android.com/reference/android/app/PendingIntent.html">PendingIntent</a></code> to fire when users trigger this action

</td>

        </tr>

      </table>

  </div>





    </div>

    </div>

</div>

</div>
@@ -918,9 +926,22 @@ From class 
    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>Add an input to be collected from the user when this action is sent.

  <div class="jd-tagdata jd-tagdescr"><p>Add an input to be collected from the user when this action is sent.

 Response values are sent as extras to this Action's pending intent when

 Response values are sent as extras to this action's pending intent when

 sent.

 sent.</p></div>

</p></div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Parameters</h5>

      <table class="jd-tagtable">

        <tr>

          <th>remoteInput</td>

          <td>a <code><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html">RemoteInput</a></code> to add to the action</td>

        </tr>

      </table>

  </div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Returns</h5>

      <ul class="nolist"><li>this object for method chaining

</li></ul>

  </div>





    </div>

    </div>

</div>

</div>
@@ -950,8 +971,12 @@ From class 
    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>Combine all of the options that have been set and return a new <code><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html">WearableNotifications.Action</a></code>

  <div class="jd-tagdata jd-tagdescr"><p>Combine all of the options that have been set and return a new <code><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html">WearableNotifications.Action</a></code>

 object.

 object.</p></div>

</p></div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Returns</h5>

      <ul class="nolist"><li>the built action

</li></ul>

  </div>





    </div>

    </div>

</div>

</div>

docs/html/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.html

+9 −8
Original line number Original line Diff line number Diff line
@@ -474,14 +474,11 @@ Summary: 








<h2>Class Overview</h2>

<h2>Class Overview</h2>

<p itemprop="articleBody">Subclass of <code><a href="/reference/android/support/v4/app/NotificationCompat.Action.html">NotificationCompat.Action</a></code> which adds support for additional

<p itemprop="articleBody">Subclass of <code><a href="/reference/android/support/v4/app/NotificationCompat.Action.html">NotificationCompat.Action</a></code> that adds additional

 wearable extensions.

 wearable extensions for actions.



 <p>Always use the <code><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.Builder.html">WearableNotifications.Action.Builder</a></code> to build instances of this class and call

 <p>To create a new Action, use the <code><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Action.Builder.html">WearableNotifications.Action.Builder</a></code> class and then call

 <code><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Builder.html#addAction(android.preview.support.wearable.notifications.WearableNotifications.Action)">addAction(WearableNotifications.Action)</a></code> to add the action to a notification.

 <code><a href="/reference/android/preview/support/wearable/notifications/WearableNotifications.Builder.html#addAction(android.preview.support.wearable.notifications.WearableNotifications.Action)">addAction(WearableNotifications.Action)</a></code> to add the action to a notification.





 <p>Example:



 <pre class="prettyprint">

 <pre class="prettyprint">

 WearableNotifications.Builder builder = new WearableNotifications.Builder(mContext)

 WearableNotifications.Builder builder = new WearableNotifications.Builder(mContext)

         .addAction(new WearableNotifications.Action.Builder(

         .addAction(new WearableNotifications.Action.Builder(
@@ -991,8 +988,12 @@ From class 
      </div>

      </div>

    <div class="jd-details-descr">

    <div class="jd-details-descr">

      

      

  <div class="jd-tagdata jd-tagdescr"><p>Get a list of inputs to be collected from the user when this action is sent.

  <div class="jd-tagdata jd-tagdescr"><p>Get a list of inputs to be collected from the user when this action is sent.</p></div>

</p></div>

  <div class="jd-tagdata">

      <h5 class="jd-tagtitle">Returns</h5>

      <ul class="nolist"><li>the array of <code><a href="/reference/android/preview/support/wearable/notifications/RemoteInput.html">RemoteInput</a></code> objects associated with this action

</li></ul>

  </div>





    </div>

    </div>

</div>

</div>