wearable/companion/WatchFaceCompanion.html

<!DOCTYPE html>
<html devsite>
<head>


    <meta name="top_category" value="develop" />

    <meta name="subcategory" value="reference" />


      <meta name="book_path" value="/reference/android/support/wearable/_book.yaml" />


<title>WatchFaceCompanion</title>


</head>

<body class="gc-documentation develop reference api apilevel-">
<div id="doc-api-level" class="" style="display:none"></div>


<div id="naMessage"></div>

<div id="api-info-block">
<div class="api-level">


</div>


<div class="sum-details-links">

Summary:


  <a href="#constants">Constants</a>


  &#124; <a href="#inhmethods">Inherited Methods</a>

&#124; <a href="#" onclick="return toggleAllClassInherited()" id="toggleAllClassInherited">[Expand All]</a>

</div><!-- end sum-details-links -->
</div><!-- end api-info-block -->

<div class="api apilevel-" id="jd-content">

<!-- ======== START OF CLASS DATA ======== -->

<h1 class="api-title">WatchFaceCompanion</h1>
<p>
<code class="api-signature">
  public

  final

  class
  WatchFaceCompanion
</code>
<br>


<code class="api-signature">

    extends Object


</code>

<code class="api-signature">


</code>

</p><table class="jd-inheritance-table">


  <tr>

    <td colspan="2" class="jd-inheritance-class-cell">java.lang.Object
    </td>
  </tr>


  <tr>

      <td class="jd-inheritance-space">&nbsp;&nbsp;&nbsp;&#x21b3;</td>

    <td colspan="1" class="jd-inheritance-class-cell">android.support.wearable.companion.WatchFaceCompanion
    </td>
  </tr>


</table>


<br><hr>


  <p>Constants for use by watch face configuration activities.

 <p>To register a configuration activity for a watch face, add a <code>&lt;meta-data&gt;</code>
 entry to the watch face component in its Android Manifest file with an intent action to be
 fired to start the activity. The following meta-data will register the
 <code>com.example.watchface.CONFIG_DIGITAL</code> action to be started when configuring a watch
 face on the wearable device:

 <pre class="prettyprint">
 &lt;meta-data
     android:name="com.google.android.wearable.watchface.wearableConfigurationAction"
     android:value="com.example.watchface.CONFIG_DIGITAL" /&gt;</pre>

 <p>To register a configuration activity to be started on a companion phone,
 add the following alternative meta-data entry to the watch face component:

 <pre class="prettyprint">
 &lt;meta-data
     android:name="com.google.android.wearable.watchface.companionConfigurationAction"
     android:value="com.example.watchface.CONFIG_DIGITAL" /&gt;</pre>

 <p>The activity should have an intent filter which lists the action specified in the
 meta-data block above, in addition to the two categories present in the
 following example:

 <pre class="prettyprint">
 &lt;activity android:name=".MyWatchFaceConfigActivity"&gt;
     &lt;intent-filter&gt;
         &lt;action android:name="com.example.watchface.CONFIG_DIGITAL" /&gt;
         &lt;category android:name="com.google.android.wearable.watchface.category.WEARABLE_CONFIGURATION" /&gt;
         &lt;category android:name="android.intent.category.DEFAULT" /&gt;
     &lt;/intent-filter&gt;
 &lt;/activity&gt;</pre>

 <p>For phone side configuration activities, substitute the category
 <code>com.google.android.wearable.watchface.category.COMPANION_CONFIGURATION</code> for
 <code>com.google.android.wearable.watchface.category.WEARABLE_CONFIGURATION</code>.
</p>


<h2 class="api-section">Summary</h2>


<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<table id="constants" class="responsive constants">
<tr><th colspan="2"><h3>Constants</h3></th></tr>


    <tr class="api apilevel-" >
        <td><code>String</code></td>
        <td width="100%">
          <code><a href="/reference/android/support/wearable/companion/WatchFaceCompanion.html#EXTRA_PEER_ID">EXTRA_PEER_ID</a></code>
          <p>The key for <code><a href="/reference/java/lang/String.html">String</a></code> extra specifying the ID of the currently connected device in the
 phone-side config activity launch <code><a href="/reference/android/content/Intent.html">Intent</a></code>.


</p>
        </td>
    </tr>


    <tr class="api apilevel-" >
        <td><code>String</code></td>
        <td width="100%">
          <code><a href="/reference/android/support/wearable/companion/WatchFaceCompanion.html#EXTRA_WATCH_FACE_COMPONENT">EXTRA_WATCH_FACE_COMPONENT</a></code>
          <p>The key for <code><a href="/reference/java/lang/String.html">String</a></code> extra specifying a <code><a href="/reference/android/content/ComponentName.html">ComponentName</a></code> of the
 watch face being configured in the config activity launch <code><a href="/reference/android/content/Intent.html">Intent</a></code>.


</p>
        </td>
    </tr>


</table>


<!-- ========== METHOD SUMMARY =========== -->
<table id="inhmethods" class="methods inhtable">
<tr><th><h3>Inherited methods</h3></th></tr>


<tr class="api apilevel-" >
<td colspan="2">

  <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.lang.Object" class="jd-expando-trigger closed"
          ><img height="34" id="inherited-methods-java.lang.Object-trigger"
          src="/assets/images/styles/disclosure_down.png"
          class="jd-expando-trigger-img" /></a>From
class
<code>

    java.lang.Object

</code>
<div id="inherited-methods-java.lang.Object">
  <div id="inherited-methods-java.lang.Object-list"
        class="jd-inheritedlinks">
  </div>
  <div id="inherited-methods-java.lang.Object-summary" style="display: none;">
    <table class="jd-sumtable-expando responsive">


  <tr class="api apilevel-" >


    <td><code>


        Object</code>
    </td>

    <td width="100%">
      <code>
      clone()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      equals(Object arg0)
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      finalize()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        Class&lt;?&gt;</code>
    </td>

    <td width="100%">
      <code>
      getClass()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        int</code>
    </td>

    <td width="100%">
      <code>
      hashCode()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      notify()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      notifyAll()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        String</code>
    </td>

    <td width="100%">
      <code>
      toString()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      wait(long arg0, int arg1)
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      wait(long arg0)
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      wait()
      </code>

    </td>
  </tr>


    </table>
  </div>
</div>
</td></tr>


</table>


<!-- XML Attributes -->


<!-- Enum Values -->


<!-- Constants -->


<!-- ========= ENUM CONSTANTS DETAIL ======== -->
<h2 class="api-section">Constants</h2>


<A NAME="EXTRA_PEER_ID"></A>

<div class="api apilevel-">
    <h3 class="api-name">EXTRA_PEER_ID</h3>
    <div class="api-level">


    </div>
<pre class="api-signature no-pretty-print">
String EXTRA_PEER_ID</pre>


  <p>The key for <code><a href="/reference/java/lang/String.html">String</a></code> extra specifying the ID of the currently connected device in the
 phone-side config activity launch <code><a href="/reference/android/content/Intent.html">Intent</a></code>.
</p>


      <p>Constant Value:

          "android.support.wearable.watchface.extra.PEER_ID"


</div>


<A NAME="EXTRA_WATCH_FACE_COMPONENT"></A>

<div class="api apilevel-">
    <h3 class="api-name">EXTRA_WATCH_FACE_COMPONENT</h3>
    <div class="api-level">


    </div>
<pre class="api-signature no-pretty-print">
String EXTRA_WATCH_FACE_COMPONENT</pre>


  <p>The key for <code><a href="/reference/java/lang/String.html">String</a></code> extra specifying a <code><a href="/reference/android/content/ComponentName.html">ComponentName</a></code> of the
 watch face being configured in the config activity launch <code><a href="/reference/android/content/Intent.html">Intent</a></code>.
</p>


      <p>Constant Value:

          "android.support.wearable.watchface.extra.WATCH_FACE_COMPONENT"


</div>


<!-- Fields -->


<!-- Public ctors -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- Protected ctors -->


<!-- ========= METHOD DETAIL ======== -->
<!-- Public methdos -->


<!-- ========= METHOD DETAIL ======== -->


<!-- ========= END OF CLASS DATA ========= -->

</div><!-- end jd-content -->


<div class="data-reference-resources-wrapper">

  <ul data-reference-resources>


    <li><h2>Classes</h2>
      <ul>
          <li class="selected api apilevel-"><a href="/reference/android/support/wearable/companion/WatchFaceCompanion.html">WatchFaceCompanion</a></li>
      </ul>
    </li>


  </ul>

</div>


</body>
</html>