am b6cb0437: Merge "Doc change: refresh GCM reference docs." into jb-mr2-docs

* commit 'b6cb0437ef0677aa4b58bb76a77dd4fdae8258e0':
  Doc change: refresh GCM reference docs.
This commit is contained in:
Dirk Dougherty
2013-08-02 17:38:31 -07:00
committed by Android Git Automerger
16 changed files with 3341 additions and 184 deletions

View File

@@ -1,7 +1,7 @@
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 ] ]

View File

@@ -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>

View File

@@ -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>

View File

@@ -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>

View File

@@ -640,6 +640,12 @@ onkeyup="return search_changed(event, false, '/')" />
<div id="jd-content" class="api apilevel-">
<div class="jd-descr">
<p><strong>DEPRECATED</strong> &mdash; please use the <a href="/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html">GoogleCloudMessaging</a> API instead of this client helper library &mdash; see <a href="/google/gcm/client.html">GCM Client</a> for more information.</p>
</div>
@@ -651,22 +657,42 @@ onkeyup="return search_changed(event, false, '/')" />
<h2>Classes</h2>
<div class="jd-sumtable">
<table class="jd-sumtable-expando">
<table class="jd-sumtable-expando">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="/reference/com/google/android/gcm/GCMBaseIntentService.html">GCMBaseIntentService</a></td>
<td class="jd-descrcol" width="100%">DEPRECATED.&nbsp;</td>
<td class="jd-descrcol" width="100%"><em>
This class is deprecated.
Please use the <a href=
"http://developer.android.com/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html">
<code>GoogleCloudMessaging</code></a> API instead.
</em>&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="/reference/com/google/android/gcm/GCMBroadcastReceiver.html">GCMBroadcastReceiver</a></td>
<td class="jd-descrcol" width="100%">DEPRECATED.&nbsp;</td>
<td class="jd-descrcol" width="100%"><em>
This class is deprecated.
Please use the <a href=
"http://developer.android.com/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html">
<code>GoogleCloudMessaging</code></a> API instead.
</em>&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="/reference/com/google/android/gcm/GCMConstants.html">GCMConstants</a></td>
<td class="jd-descrcol" width="100%">DEPRECATED.&nbsp;</td>
<td class="jd-descrcol" width="100%"><em>
This class is deprecated.
Please use the <a href=
"http://developer.android.com/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html">
<code>GoogleCloudMessaging</code></a> API instead.
</em>&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="/reference/com/google/android/gcm/GCMRegistrar.html">GCMRegistrar</a></td>
<td class="jd-descrcol" width="100%">DEPRECATED.&nbsp;</td>
<td class="jd-descrcol" width="100%"><em>
This class is deprecated.
Please use the <a href=
"http://developer.android.com/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html">
<code>GoogleCloudMessaging</code></a> API instead.
</em>&nbsp;</td>
</tr>
</table>
</div>

View File

@@ -935,18 +935,33 @@ Summary:
<tr class=" api apilevel-" >
<td class="jd-typecol">String</td>
<td class="jd-linkcol"><a href="/reference/com/google/android/gcm/server/Constants.html#PARAM_PAYLOAD_PREFIX">PARAM_PAYLOAD_PREFIX</a></td>
<td class="jd-descrcol" width="100%">Prefix to HTTP parameter used to pass key-values in the message payload.</td>
<td class="jd-linkcol"><a href="/reference/com/google/android/gcm/server/Constants.html#PARAM_DRY_RUN">PARAM_DRY_RUN</a></td>
<td class="jd-descrcol" width="100%">HTTP parameter for telling gcm to validate the message without actually sending it.</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/server/Constants.html#PARAM_PAYLOAD_PREFIX">PARAM_PAYLOAD_PREFIX</a></td>
<td class="jd-descrcol" width="100%">Prefix to HTTP parameter used to pass key-values in the message payload.</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-typecol">String</td>
<td class="jd-linkcol"><a href="/reference/com/google/android/gcm/server/Constants.html#PARAM_REGISTRATION_ID">PARAM_REGISTRATION_ID</a></td>
<td class="jd-descrcol" width="100%">HTTP parameter for registration id.</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/server/Constants.html#PARAM_RESTRICTED_PACKAGE_NAME">PARAM_RESTRICTED_PACKAGE_NAME</a></td>
<td class="jd-descrcol" width="100%">HTTP parameter for package name that can be used to restrict message delivery by matching
against the package name used to generate the registration id.</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-typecol">String</td>
<td class="jd-linkcol"><a href="/reference/com/google/android/gcm/server/Constants.html#PARAM_TIME_TO_LIVE">PARAM_TIME_TO_LIVE</a></td>
@@ -2121,6 +2136,44 @@ From class
<A NAME="PARAM_DRY_RUN"></A>
<div class="jd-details api apilevel-">
<h4 class="jd-details-title">
<span class="normal">
public
static
final
String
</span>
PARAM_DRY_RUN
</h4>
<div class="api-level">
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>HTTP parameter for telling gcm to validate the message without actually sending it.
</p></div>
<div class="jd-tagdata">
<span class="jd-tagtitle">Constant Value: </span>
<span>
"dry_run"
</span>
</div>
</div>
</div>
<A NAME="PARAM_PAYLOAD_PREFIX"></A>
<div class="jd-details api apilevel-">
@@ -2197,6 +2250,45 @@ From class
<A NAME="PARAM_RESTRICTED_PACKAGE_NAME"></A>
<div class="jd-details api apilevel-">
<h4 class="jd-details-title">
<span class="normal">
public
static
final
String
</span>
PARAM_RESTRICTED_PACKAGE_NAME
</h4>
<div class="api-level">
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>HTTP parameter for package name that can be used to restrict message delivery by matching
against the package name used to generate the registration id.
</p></div>
<div class="jd-tagdata">
<span class="jd-tagtitle">Constant Value: </span>
<span>
"restricted_package_name"
</span>
</div>
</div>
</div>
<A NAME="PARAM_TIME_TO_LIVE"></A>
<div class="jd-details api apilevel-">

View File

@@ -884,6 +884,42 @@ Summary:
<a href="/reference/com/google/android/gcm/server/Message.Builder.html">Message.Builder</a></nobr>
</td>
<td class="jd-linkcol" width="100%"><nobr>
<span class="sympad"><a href="/reference/com/google/android/gcm/server/Message.Builder.html#dryRun(boolean)">dryRun</a></span>(boolean value)</nobr>
<div class="jd-descrdiv">Sets the dryRun property (default value is false).</div>
</td></tr>
<tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
<a href="/reference/com/google/android/gcm/server/Message.Builder.html">Message.Builder</a></nobr>
</td>
<td class="jd-linkcol" width="100%"><nobr>
<span class="sympad"><a href="/reference/com/google/android/gcm/server/Message.Builder.html#restrictedPackageName(java.lang.String)">restrictedPackageName</a></span>(String value)</nobr>
<div class="jd-descrdiv">Sets the restrictedPackageName property.</div>
</td></tr>
<tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
<a href="/reference/com/google/android/gcm/server/Message.Builder.html">Message.Builder</a></nobr>
</td>
<td class="jd-linkcol" width="100%"><nobr>
@@ -1307,6 +1343,66 @@ From class
</div>
<A NAME="dryRun(boolean)"></A>
<div class="jd-details api apilevel-">
<h4 class="jd-details-title">
<span class="normal">
public
<a href="/reference/com/google/android/gcm/server/Message.Builder.html">Message.Builder</a>
</span>
<span class="sympad">dryRun</span>
<span class="normal">(boolean value)</span>
</h4>
<div class="api-level">
<div></div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Sets the dryRun property (default value is false).
</p></div>
</div>
</div>
<A NAME="restrictedPackageName(java.lang.String)"></A>
<div class="jd-details api apilevel-">
<h4 class="jd-details-title">
<span class="normal">
public
<a href="/reference/com/google/android/gcm/server/Message.Builder.html">Message.Builder</a>
</span>
<span class="sympad">restrictedPackageName</span>
<span class="normal">(String value)</span>
</h4>
<div class="api-level">
<div></div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Sets the restrictedPackageName property.
</p></div>
</div>
</div>
<A NAME="timeToLive(int)"></A>
<div class="jd-details api apilevel-">

View File

@@ -752,6 +752,8 @@ Summary:
.collapseKey(collapseKey)
.timeToLive(3)
.delayWhileIdle(true)
.dryRun(true)
.restrictedPackageName(restrictedPackageName)
.build();
</pre></code>
@@ -761,6 +763,8 @@ Summary:
.collapseKey(collapseKey)
.timeToLive(3)
.delayWhileIdle(true)
.dryRun(true)
.restrictedPackageName(restrictedPackageName)
.addData("key1", "value1")
.addData("key2", "value2")
.build();
@@ -888,6 +892,24 @@ Summary:
String</nobr>
</td>
<td class="jd-linkcol" width="100%"><nobr>
<span class="sympad"><a href="/reference/com/google/android/gcm/server/Message.html#getRestrictedPackageName()">getRestrictedPackageName</a></span>()</nobr>
<div class="jd-descrdiv">Gets the restricted package name.</div>
</td></tr>
<tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
Integer</nobr>
</td>
<td class="jd-linkcol" width="100%"><nobr>
@@ -899,6 +921,24 @@ Summary:
<tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
Boolean</nobr>
</td>
<td class="jd-linkcol" width="100%"><nobr>
<span class="sympad"><a href="/reference/com/google/android/gcm/server/Message.html#isDelayWhileIdle()">isDelayWhileIdle</a></span>()</nobr>
<div class="jd-descrdiv">Gets the delayWhileIdle flag.</div>
</td></tr>
<tr class=" api apilevel-" >
<td class="jd-typecol"><nobr>
@@ -909,9 +949,9 @@ Summary:
Boolean</nobr>
</td>
<td class="jd-linkcol" width="100%"><nobr>
<span class="sympad"><a href="/reference/com/google/android/gcm/server/Message.html#isDelayWhileIdle()">isDelayWhileIdle</a></span>()</nobr>
<span class="sympad"><a href="/reference/com/google/android/gcm/server/Message.html#isDryRun()">isDryRun</a></span>()</nobr>
<div class="jd-descrdiv">Gets the delayWhileIdle flag.</div>
<div class="jd-descrdiv">Gets the dryRun flag.</div>
</td></tr>
@@ -1252,6 +1292,36 @@ From class
</div>
<A NAME="getRestrictedPackageName()"></A>
<div class="jd-details api apilevel-">
<h4 class="jd-details-title">
<span class="normal">
public
String
</span>
<span class="sympad">getRestrictedPackageName</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div></div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Gets the restricted package name.
</p></div>
</div>
</div>
<A NAME="getTimeToLive()"></A>
<div class="jd-details api apilevel-">
@@ -1312,6 +1382,36 @@ From class
</div>
<A NAME="isDryRun()"></A>
<div class="jd-details api apilevel-">
<h4 class="jd-details-title">
<span class="normal">
public
Boolean
</span>
<span class="sympad">isDryRun</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div></div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Gets the dryRun flag.
</p></div>
</div>
</div>
<A NAME="toString()"></A>
<div class="jd-details api apilevel-">

File diff suppressed because it is too large Load Diff

View File

@@ -641,6 +641,8 @@ onkeyup="return search_changed(event, false, '/')" />
Summary:
<a href="#nestedclasses">Nested Classes</a>
@@ -651,7 +653,8 @@ Summary:
<a href="#pubmethods">Methods</a>
&#124; <a href="#pubmethods">Methods</a>
@@ -763,6 +766,26 @@ Summary:
<!-- ======== NESTED CLASS SUMMARY ======== -->
<table id="nestedclasses" class="jd-sumtable"><tr><th colspan="12">Nested Classes</th></tr>
<tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
class</nobr></td>
<td class="jd-linkcol"><a href="/reference/com/google/android/gcm/server/MulticastResult.Builder.html">MulticastResult.Builder</a></td>
<td class="jd-descrcol" width="100%">&nbsp;</td>
</tr>

File diff suppressed because it is too large Load Diff

View File

@@ -641,6 +641,8 @@ onkeyup="return search_changed(event, false, '/')" />
Summary:
<a href="#nestedclasses">Nested Classes</a>
@@ -651,7 +653,8 @@ Summary:
<a href="#pubmethods">Methods</a>
&#124; <a href="#pubmethods">Methods</a>
@@ -786,6 +789,26 @@ Summary:
<!-- ======== NESTED CLASS SUMMARY ======== -->
<table id="nestedclasses" class="jd-sumtable"><tr><th colspan="12">Nested Classes</th></tr>
<tr class="alt-color api apilevel-" >
<td class="jd-typecol"><nobr>
class</nobr></td>
<td class="jd-linkcol"><a href="/reference/com/google/android/gcm/server/Result.Builder.html">Result.Builder</a></td>
<td class="jd-descrcol" width="100%">&nbsp;</td>
</tr>

View File

@@ -640,6 +640,12 @@ onkeyup="return search_changed(event, false, '/')" />
<div id="jd-content" class="api apilevel-">
<div class="jd-descr">
<p>Helper library for GCM HTTP server operations &mdash; see <a href="/google/gcm/server.html">GCM Server</a> for more information.</p>
</div>
@@ -669,9 +675,17 @@ onkeyup="return search_changed(event, false, '/')" />
<td class="jd-descrcol" width="100%">Result of a GCM multicast message request .&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="/reference/com/google/android/gcm/server/MulticastResult.Builder.html">MulticastResult.Builder</a></td>
<td class="jd-descrcol" width="100%">&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="/reference/com/google/android/gcm/server/Result.html">Result</a></td>
<td class="jd-descrcol" width="100%">Result of a GCM message request that returned HTTP status code 200.&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="/reference/com/google/android/gcm/server/Result.Builder.html">Result.Builder</a></td>
<td class="jd-descrcol" width="100%">&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="/reference/com/google/android/gcm/server/Sender.html">Sender</a></td>
<td class="jd-descrcol" width="100%">Helper class to send messages to the GCM service using an API Key.&nbsp;</td>

View File

@@ -632,22 +632,20 @@ onkeyup="return search_changed(event, false, '/')" />
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol">
<a href="/reference/com/google/android/gcm/package-summary.html">com.google.android.gcm</a></td>
<td class="jd-descrcol" width="100%"><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 of this client helper library. See <a href="http://developer.android.com/google/gcm/client.html">GCM Client</a> for more information.</td>
<td class="jd-descrcol" width="100%"><p><strong>DEPRECATED</strong> &mdash; please use the <a href="/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html">GoogleCloudMessaging</a> API instead of this client helper library &mdash; see <a href="/google/gcm/client.html">GCM Client</a> for more information.</td>
</tr>
<tr class=" api apilevel-" >
<tr class=" api apilevel-" >
<td class="jd-linkcol">
<a href="/reference/com/google/android/gcm/server/package-summary.html">com.google.android.gcm.server</a></td>
<td class="jd-descrcol" width="100%">Helper library for GCM HTTP server operations. See <a href="http://developer.android.com/google/gcm/server.html">GCM Server</a> for more information.</td>
<td class="jd-descrcol" width="100%"><p>Helper library for GCM HTTP server operations &mdash; see <a href="/google/gcm/server.html">GCM Server</a> for more information.</td>
</tr>
</table>
<div id="footer" class="wrap" >

View File

@@ -1,16 +1,18 @@
var GCM_DATA = [
{ id:0, label:"com.google.android.gcm", link:"reference/com/google/android/gcm/package-summary.html", type:"package", deprecated:"false" },
{ id:1, label:"com.google.android.gcm.GCMBaseIntentService", link:"reference/com/google/android/gcm/GCMBaseIntentService.html", type:"class", deprecated:"false" },
{ id:2, label:"com.google.android.gcm.GCMBroadcastReceiver", link:"reference/com/google/android/gcm/GCMBroadcastReceiver.html", type:"class", deprecated:"false" },
{ id:3, label:"com.google.android.gcm.GCMConstants", link:"reference/com/google/android/gcm/GCMConstants.html", type:"class", deprecated:"false" },
{ id:4, label:"com.google.android.gcm.GCMRegistrar", link:"reference/com/google/android/gcm/GCMRegistrar.html", type:"class", deprecated:"false" },
{ id:1, label:"com.google.android.gcm.GCMBaseIntentService", link:"reference/com/google/android/gcm/GCMBaseIntentService.html", type:"class", deprecated:"true" },
{ id:2, label:"com.google.android.gcm.GCMBroadcastReceiver", link:"reference/com/google/android/gcm/GCMBroadcastReceiver.html", type:"class", deprecated:"true" },
{ id:3, label:"com.google.android.gcm.GCMConstants", link:"reference/com/google/android/gcm/GCMConstants.html", type:"class", deprecated:"true" },
{ id:4, label:"com.google.android.gcm.GCMRegistrar", link:"reference/com/google/android/gcm/GCMRegistrar.html", type:"class", deprecated:"true" },
{ id:5, label:"com.google.android.gcm.server", link:"reference/com/google/android/gcm/server/package-summary.html", type:"package", deprecated:"false" },
{ id:6, label:"com.google.android.gcm.server.Constants", link:"reference/com/google/android/gcm/server/Constants.html", type:"class", deprecated:"false" },
{ id:7, label:"com.google.android.gcm.server.InvalidRequestException", link:"reference/com/google/android/gcm/server/InvalidRequestException.html", type:"class", deprecated:"false" },
{ id:8, label:"com.google.android.gcm.server.Message", link:"reference/com/google/android/gcm/server/Message.html", type:"class", deprecated:"false" },
{ id:9, label:"com.google.android.gcm.server.Message.Builder", link:"reference/com/google/android/gcm/server/Message.Builder.html", type:"class", deprecated:"false" },
{ id:10, label:"com.google.android.gcm.server.MulticastResult", link:"reference/com/google/android/gcm/server/MulticastResult.html", type:"class", deprecated:"false" },
{ id:11, label:"com.google.android.gcm.server.Result", link:"reference/com/google/android/gcm/server/Result.html", type:"class", deprecated:"false" },
{ id:12, label:"com.google.android.gcm.server.Sender", link:"reference/com/google/android/gcm/server/Sender.html", type:"class", deprecated:"false" }
{ id:11, label:"com.google.android.gcm.server.MulticastResult.Builder", link:"reference/com/google/android/gcm/server/MulticastResult.Builder.html", type:"class", deprecated:"false" },
{ id:12, label:"com.google.android.gcm.server.Result", link:"reference/com/google/android/gcm/server/Result.html", type:"class", deprecated:"false" },
{ id:13, label:"com.google.android.gcm.server.Result.Builder", link:"reference/com/google/android/gcm/server/Result.Builder.html", type:"class", deprecated:"false" },
{ id:14, label:"com.google.android.gcm.server.Sender", link:"reference/com/google/android/gcm/server/Sender.html", type:"class", deprecated:"false" }
];