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

Commit 882ecced authored by Dirk Dougherty's avatar Dirk Dougherty
Browse files

Doc change: refresh GCM reference docs. 

Change-Id: I4f79e27b9d761cb8967fb90ff8df5438e43cd39c
parent 218120e0

docs/html/gcm_navtree_data.js

+1 −1
Original line number Diff line number Diff line 
var GCM_NAVTREE_DATA =

[ [ "com.google.android.gcm", "reference/com/google/android/gcm/package-summary.html", [ [ "Classes", null, [ [ "GCMBaseIntentService", "reference/com/google/android/gcm/GCMBaseIntentService.html", null, null ], [ "GCMBroadcastReceiver", "reference/com/google/android/gcm/GCMBroadcastReceiver.html", null, null ], [ "GCMConstants", "reference/com/google/android/gcm/GCMConstants.html", null, null ], [ "GCMRegistrar", "reference/com/google/android/gcm/GCMRegistrar.html", null, null ] ]

, null ] ]

, null ], [ "com.google.android.gcm.server", "reference/com/google/android/gcm/server/package-summary.html", [ [ "Classes", null, [ [ "Constants", "reference/com/google/android/gcm/server/Constants.html", null, null ], [ "Message", "reference/com/google/android/gcm/server/Message.html", null, null ], [ "Message.Builder", "reference/com/google/android/gcm/server/Message.Builder.html", null, null ], [ "MulticastResult", "reference/com/google/android/gcm/server/MulticastResult.html", null, null ], [ "Result", "reference/com/google/android/gcm/server/Result.html", null, null ], [ "Sender", "reference/com/google/android/gcm/server/Sender.html", null, null ] ]

, null ], [ "com.google.android.gcm.server", "reference/com/google/android/gcm/server/package-summary.html", [ [ "Classes", null, [ [ "Constants", "reference/com/google/android/gcm/server/Constants.html", null, null ], [ "Message", "reference/com/google/android/gcm/server/Message.html", null, null ], [ "Message.Builder", "reference/com/google/android/gcm/server/Message.Builder.html", null, null ], [ "MulticastResult", "reference/com/google/android/gcm/server/MulticastResult.html", null, null ], [ "MulticastResult.Builder", "reference/com/google/android/gcm/server/MulticastResult.Builder.html", null, null ], [ "Result", "reference/com/google/android/gcm/server/Result.html", null, null ], [ "Result.Builder", "reference/com/google/android/gcm/server/Result.Builder.html", null, null ], [ "Sender", "reference/com/google/android/gcm/server/Sender.html", null, null ] ]

, null ], [ "Exceptions", null, [ [ "InvalidRequestException", "reference/com/google/android/gcm/server/InvalidRequestException.html", null, null ] ]

, null ] ]

, null ] ]

docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html

+252 −120

File changed.

Preview size limit exceeded, changes collapsed.

docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html

+8 −4
Original line number Diff line number Diff line
@@ -746,19 +746,23 @@ Summary: 




<div class="jd-descr">

<p>

  <p class="caution"><strong>

      This class is deprecated.</strong><br/>

    Please use the <a href=

 "http://developer.android.com/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html">

 <code>GoogleCloudMessaging</code></a> API instead.



  </p>



<h2>Class Overview</h2>

<div style="background-color:#fffdeb;width:100%;margin-bottom:1em;padding:.5em;"><strong>DEPRECATED.</strong> Please use the <a href=

"http://developer.android.com/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html"><code>GoogleCloudMessaging</code></a> API instead.</div>

<p itemprop="articleBody"><code><a href="/reference/android/content/BroadcastReceiver.html">BroadcastReceiver</a></code> that receives GCM messages and delivers them to

 an application-specific <code><a href="/reference/com/google/android/gcm/GCMBaseIntentService.html">GCMBaseIntentService</a></code> subclass.

 <p>

 By default, the <code><a href="/reference/com/google/android/gcm/GCMBaseIntentService.html">GCMBaseIntentService</a></code> class belongs to the application

 main package and is named

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#DEFAULT_INTENT_SERVICE_CLASS_NAME">DEFAULT_INTENT_SERVICE_CLASS_NAME</a></code>. To use a new class,

 the <code><a href="/reference/com/google/android/gcm/GCMBroadcastReceiver.html#getGCMIntentServiceClassName(android.content.Context)">getGCMIntentServiceClassName(Context)</a></code> must be overridden.

</p>

 the <code><a href="/reference/com/google/android/gcm/GCMBroadcastReceiver.html#getGCMIntentServiceClassName(android.content.Context)">getGCMIntentServiceClassName(Context)</a></code> must be overridden.</p>

docs/html/reference/com/google/android/gcm/GCMConstants.html

+54 −32
Original line number Diff line number Diff line
@@ -719,13 +719,17 @@ Summary: 




<div class="jd-descr">

<p>

  <p class="caution"><strong>

      This class is deprecated.</strong><br/>

    Please use the <a href=

 "http://developer.android.com/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html">

 <code>GoogleCloudMessaging</code></a> API instead.



  </p>



<h2>Class Overview</h2>

<div style="background-color:#fffdeb;width:100%;margin-bottom:1em;padding:.5em;"><strong>DEPRECATED.</strong> Please use the <a href=

"http://developer.android.com/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html"><code>GoogleCloudMessaging</code></a> API instead.</div>

<p itemprop="articleBody">Constants used by the GCM library.

</p>

<p itemprop="articleBody">Constants used by the GCM library.</p>
@@ -823,47 +827,55 @@ Summary: 
    <tr class=" api apilevel-" >

        <td class="jd-typecol">String</td>

        <td class="jd-linkcol"><a href="/reference/com/google/android/gcm/GCMConstants.html#EXTRA_APPLICATION_PENDING_INTENT">EXTRA_APPLICATION_PENDING_INTENT</a></td>

        <td class="jd-descrcol" width="100%">Extra used on <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_TO_GCM_REGISTRATION">.INTENT_TO_GCM_REGISTRATION</a></code> to get the

 application info.</td>

        <td class="jd-descrcol" width="100%">Extra used on

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_TO_GCM_REGISTRATION">com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION</a></code>

 to get the application info.</td>

    </tr>

    

    

    <tr class="alt-color api apilevel-" >

        <td class="jd-typecol">String</td>

        <td class="jd-linkcol"><a href="/reference/com/google/android/gcm/GCMConstants.html#EXTRA_ERROR">EXTRA_ERROR</a></td>

        <td class="jd-descrcol" width="100%">Extra used on <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_REGISTRATION_CALLBACK">.INTENT_FROM_GCM_REGISTRATION_CALLBACK</a></code> to indicate

 an error when the registration fails.</td>

        <td class="jd-descrcol" width="100%">Extra used on

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_REGISTRATION_CALLBACK">com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK</a></code>

 to indicate an error when the registration fails.</td>

    </tr>

    

    

    <tr class=" api apilevel-" >

        <td class="jd-typecol">String</td>

        <td class="jd-linkcol"><a href="/reference/com/google/android/gcm/GCMConstants.html#EXTRA_FROM">EXTRA_FROM</a></td>

        <td class="jd-descrcol" width="100%">Extra used on <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_MESSAGE">.INTENT_FROM_GCM_MESSAGE</a></code> to indicate which

 sender (Google API project id) sent the message.</td>

        <td class="jd-descrcol" width="100%">Extra used on

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_MESSAGE">com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE</a></code>

 to indicate which sender (Google API project id) sent the message.</td>

    </tr>

    

    

    <tr class="alt-color api apilevel-" >

        <td class="jd-typecol">String</td>

        <td class="jd-linkcol"><a href="/reference/com/google/android/gcm/GCMConstants.html#EXTRA_REGISTRATION_ID">EXTRA_REGISTRATION_ID</a></td>

        <td class="jd-descrcol" width="100%">Extra used on <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_REGISTRATION_CALLBACK">.INTENT_FROM_GCM_REGISTRATION_CALLBACK</a></code> to indicate

 the registration id when the registration succeeds.</td>

        <td class="jd-descrcol" width="100%">Extra used on

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_REGISTRATION_CALLBACK">com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK</a></code>

 to indicate the registration id when the registration succeeds.</td>

    </tr>

    

    

    <tr class=" api apilevel-" >

        <td class="jd-typecol">String</td>

        <td class="jd-linkcol"><a href="/reference/com/google/android/gcm/GCMConstants.html#EXTRA_SENDER">EXTRA_SENDER</a></td>

        <td class="jd-descrcol" width="100%">Extra used on <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_TO_GCM_REGISTRATION">.INTENT_TO_GCM_REGISTRATION</a></code> to indicate which

 senders (Google API project ids) can send messages to the application.</td>

        <td class="jd-descrcol" width="100%">Extra used on

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_TO_GCM_REGISTRATION">com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION</a></code>

 to indicate which senders (Google API project ids) can send messages to

 the application.</td>

    </tr>

    

    

    <tr class="alt-color api apilevel-" >

        <td class="jd-typecol">String</td>

        <td class="jd-linkcol"><a href="/reference/com/google/android/gcm/GCMConstants.html#EXTRA_SPECIAL_MESSAGE">EXTRA_SPECIAL_MESSAGE</a></td>

        <td class="jd-descrcol" width="100%">Type of message present in the <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_MESSAGE">.INTENT_FROM_GCM_MESSAGE</a></code> intent.</td>

        <td class="jd-descrcol" width="100%">Type of message present in the

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_MESSAGE">com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE</a></code>

 intent.</td>

    </tr>
@@ -877,8 +889,9 @@ Summary: 
    <tr class="alt-color api apilevel-" >

        <td class="jd-typecol">String</td>

        <td class="jd-linkcol"><a href="/reference/com/google/android/gcm/GCMConstants.html#EXTRA_UNREGISTERED">EXTRA_UNREGISTERED</a></td>

        <td class="jd-descrcol" width="100%">Extra used on <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_REGISTRATION_CALLBACK">.INTENT_FROM_GCM_REGISTRATION_CALLBACK</a></code> to indicate

 that the application has been unregistered.</td>

        <td class="jd-descrcol" width="100%">Extra used on

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_REGISTRATION_CALLBACK">com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK</a></code>

 to indicate that the application has been unregistered.</td>

    </tr>
@@ -1487,8 +1500,9 @@ From class 
      </div>

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

      

  <div class="jd-tagdata jd-tagdescr"><p>Extra used on <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_TO_GCM_REGISTRATION">.INTENT_TO_GCM_REGISTRATION</a></code> to get the

 application info.

  <div class="jd-tagdata jd-tagdescr"><p>Extra used on

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_TO_GCM_REGISTRATION">com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION</a></code>

 to get the application info.

</p></div>
@@ -1526,9 +1540,10 @@ From class 
      </div>

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

      

  <div class="jd-tagdata jd-tagdescr"><p>Extra used on <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_REGISTRATION_CALLBACK">.INTENT_FROM_GCM_REGISTRATION_CALLBACK</a></code> to indicate

 an error when the registration fails. See constants starting with ERROR_

 for possible values.

  <div class="jd-tagdata jd-tagdescr"><p>Extra used on

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_REGISTRATION_CALLBACK">com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK</a></code>

 to indicate an error when the registration fails.

 See constants starting with ERROR_ for possible values.

</p></div>
@@ -1566,8 +1581,9 @@ From class 
      </div>

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

      

  <div class="jd-tagdata jd-tagdescr"><p>Extra used on <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_MESSAGE">.INTENT_FROM_GCM_MESSAGE</a></code> to indicate which

 sender (Google API project id) sent the message.

  <div class="jd-tagdata jd-tagdescr"><p>Extra used on

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_MESSAGE">com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE</a></code>

 to indicate which sender (Google API project id) sent the message.

</p></div>
@@ -1605,8 +1621,9 @@ From class 
      </div>

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

      

  <div class="jd-tagdata jd-tagdescr"><p>Extra used on <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_REGISTRATION_CALLBACK">.INTENT_FROM_GCM_REGISTRATION_CALLBACK</a></code> to indicate

 the registration id when the registration succeeds.

  <div class="jd-tagdata jd-tagdescr"><p>Extra used on

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_REGISTRATION_CALLBACK">com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK</a></code>

 to indicate the registration id when the registration succeeds.

</p></div>
@@ -1644,8 +1661,10 @@ From class 
      </div>

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

      

  <div class="jd-tagdata jd-tagdescr"><p>Extra used on <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_TO_GCM_REGISTRATION">.INTENT_TO_GCM_REGISTRATION</a></code> to indicate which

 senders (Google API project ids) can send messages to the application.

  <div class="jd-tagdata jd-tagdescr"><p>Extra used on

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_TO_GCM_REGISTRATION">com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION</a></code>

 to indicate which senders (Google API project ids) can send messages to

 the application.

</p></div>
@@ -1683,7 +1702,9 @@ From class 
      </div>

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

      

  <div class="jd-tagdata jd-tagdescr"><p>Type of message present in the <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_MESSAGE">.INTENT_FROM_GCM_MESSAGE</a></code> intent.

  <div class="jd-tagdata jd-tagdescr"><p>Type of message present in the

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_MESSAGE">com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE</a></code>

 intent.

 This extra is only set for special messages sent from GCM, not for

 messages originated from the application.

</p></div>
@@ -1725,7 +1746,7 @@ From class 
      

  <div class="jd-tagdata jd-tagdescr"><p>Number of messages deleted by the server because the device was idle.

 Present only on messages of special type

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#VALUE_DELETED_MESSAGES">.VALUE_DELETED_MESSAGES</a></code>

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#VALUE_DELETED_MESSAGES">com.google.android.gcm.GCMConstants.VALUE_DELETED_MESSAGES</a></code>

</p></div>
@@ -1763,8 +1784,9 @@ From class 
      </div>

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

      

  <div class="jd-tagdata jd-tagdescr"><p>Extra used on <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_REGISTRATION_CALLBACK">.INTENT_FROM_GCM_REGISTRATION_CALLBACK</a></code> to indicate

 that the application has been unregistered.

  <div class="jd-tagdata jd-tagdescr"><p>Extra used on

 <code><a href="/reference/com/google/android/gcm/GCMConstants.html#INTENT_FROM_GCM_REGISTRATION_CALLBACK">com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK</a></code>

 to indicate that the application has been unregistered.

</p></div>

docs/html/reference/com/google/android/gcm/GCMRegistrar.html

+8 −4
Original line number Diff line number Diff line
@@ -722,16 +722,20 @@ Summary: 




<div class="jd-descr">

<p>

  <p class="caution"><strong>

      This class is deprecated.</strong><br/>

    Please use the <a href=

 "http://developer.android.com/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html">

 <code>GoogleCloudMessaging</code></a> API instead.



  </p>



<h2>Class Overview</h2>

<div style="background-color:#fffdeb;width:100%;margin-bottom:1em;padding:.5em;"><strong>DEPRECATED.</strong> Please use the <a href=

"http://developer.android.com/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html"><code>GoogleCloudMessaging</code></a> API instead.</div>

<p itemprop="articleBody">Utilities for device registration.

 <p>

 <strong>Note:</strong> this class uses a private <code><a href="/reference/android/content/SharedPreferences.html">SharedPreferences</a></code>

 object to keep track of the registration token.

</p>

 object to keep track of the registration token.</p>