From 882ecced5e0aa7c38f3be774a81bdd5831989b69 Mon Sep 17 00:00:00 2001 From: Dirk Dougherty Date: Thu, 1 Aug 2013 15:54:07 -0700 Subject: Doc change: refresh GCM reference docs. Change-Id: I4f79e27b9d761cb8967fb90ff8df5438e43cd39c --- .../google/android/gcm/GCMBaseIntentService.html | 372 ++++-- .../google/android/gcm/GCMBroadcastReceiver.html | 12 +- .../com/google/android/gcm/GCMConstants.html | 86 +- .../com/google/android/gcm/GCMRegistrar.html | 12 +- .../com/google/android/gcm/package-summary.html | 36 +- .../com/google/android/gcm/server/Constants.html | 94 +- .../google/android/gcm/server/Message.Builder.html | 96 ++ .../com/google/android/gcm/server/Message.html | 102 +- .../gcm/server/MulticastResult.Builder.html | 1288 +++++++++++++++++++ .../google/android/gcm/server/MulticastResult.html | 25 +- .../google/android/gcm/server/Result.Builder.html | 1333 ++++++++++++++++++++ .../com/google/android/gcm/server/Result.html | 25 +- .../google/android/gcm/server/package-summary.html | 14 + 13 files changed, 3326 insertions(+), 169 deletions(-) create mode 100644 docs/html/reference/com/google/android/gcm/server/MulticastResult.Builder.html create mode 100644 docs/html/reference/com/google/android/gcm/server/Result.Builder.html (limited to 'docs/html/reference/com/google') diff --git a/docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html b/docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html index fba48d4..5ef2947 100644 --- a/docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html +++ b/docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html @@ -847,13 +847,16 @@ Summary:
+

+

+ This class is deprecated.
+ Please use the + GoogleCloudMessaging API instead. +

Class Overview

- -
DEPRECATED. Please use the GoogleCloudMessaging API instead.
-

Skeleton for application-specific IntentServices responsible for handling communication from Google Cloud Messaging service.

@@ -862,8 +865,7 @@ Summary: operations, they should spawn new threads, otherwise the worker thread will be blocked.

- Subclasses must provide a public no-arg constructor. -

+ Subclasses must provide a public no-arg constructor.

@@ -911,7 +913,7 @@ Summary: String TAG - + Old TAG used for logging. @@ -1066,364 +1068,364 @@ android.content.Context String - AUDIO_SERVICE + APP_OPS_SERVICE String - BACKUP_SERVICE + AUDIO_SERVICE + String + BACKUP_SERVICE + + + + + int BIND_ABOVE_CLIENT - + int BIND_ADJUST_WITH_ACTIVITY - + int BIND_ALLOW_OOM_MANAGEMENT - + int BIND_AUTO_CREATE - + int BIND_DEBUG_UNBIND - + int BIND_IMPORTANT - + int BIND_NOT_FOREGROUND - + int BIND_NOT_VISIBLE - + int BIND_VISIBLE - + int BIND_WAIVE_PRIORITY - + String BLUETOOTH_SERVICE - + String CLIPBOARD_SERVICE - + String CONNECTIVITY_SERVICE - + int CONTEXT_IGNORE_SECURITY - + int CONTEXT_INCLUDE_CODE - + int CONTEXT_RESTRICTED - + String COUNTRY_DETECTOR - + String DEVICE_POLICY_SERVICE - + String DISPLAY_SERVICE - + String DOWNLOAD_SERVICE - + String DROPBOX_SERVICE - + String INPUT_METHOD_SERVICE - + String INPUT_SERVICE - + String KEYGUARD_SERVICE - + String LAYOUT_INFLATER_SERVICE - + String LOCATION_SERVICE - + String MEDIA_ROUTER_SERVICE - + int MODE_APPEND - + int MODE_ENABLE_WRITE_AHEAD_LOGGING - + int MODE_MULTI_PROCESS - + int MODE_PRIVATE - + int MODE_WORLD_READABLE - + int MODE_WORLD_WRITEABLE - - String - NETWORKMANAGEMENT_SERVICE - - - - String - NETWORK_POLICY_SERVICE + NETWORKMANAGEMENT_SERVICE String - NETWORK_STATS_SERVICE + NETWORK_POLICY_SERVICE String - NFC_SERVICE + NETWORK_STATS_SERVICE String - NOTIFICATION_SERVICE + NFC_SERVICE String - NSD_SERVICE + NOTIFICATION_SERVICE String - POWER_SERVICE + NSD_SERVICE String - SCHEDULING_POLICY_SERVICE + POWER_SERVICE String - SEARCH_SERVICE + SCHEDULING_POLICY_SERVICE String - SENSOR_SERVICE + SEARCH_SERVICE String - SERIAL_SERVICE + SENSOR_SERVICE String - SIP_SERVICE + SERIAL_SERVICE String - STATUS_BAR_SERVICE + SIP_SERVICE String - STORAGE_SERVICE + STATUS_BAR_SERVICE String - TELEPHONY_SERVICE + STORAGE_SERVICE String - TEXT_SERVICES_MANAGER_SERVICE + TELEPHONY_SERVICE String - THROTTLE_SERVICE + TEXT_SERVICES_MANAGER_SERVICE @@ -2352,7 +2354,7 @@ From class boolean - bindService(Intent arg0, ServiceConnection arg1, int arg2, int arg3) + bindServiceAsUser(Intent arg0, ServiceConnection arg1, int arg2, UserHandle arg3) @@ -2797,6 +2799,22 @@ From class + String + + + getBasePackageName() + + + + + + + + + + + + File @@ -2806,7 +2824,7 @@ From class - + @@ -2822,7 +2840,7 @@ From class - + @@ -2838,7 +2856,7 @@ From class - + @@ -2854,7 +2872,7 @@ From class - + @@ -2870,7 +2888,7 @@ From class - + @@ -2886,7 +2904,7 @@ From class - + @@ -2902,7 +2920,7 @@ From class - + @@ -2918,7 +2936,7 @@ From class - + @@ -2934,7 +2952,7 @@ From class - + @@ -2950,7 +2968,7 @@ From class - + @@ -2966,7 +2984,7 @@ From class - + @@ -2982,7 +3000,7 @@ From class - + @@ -2998,7 +3016,7 @@ From class - + @@ -3014,7 +3032,7 @@ From class - + @@ -3030,7 +3048,7 @@ From class - + @@ -3046,7 +3064,7 @@ From class - + @@ -3062,7 +3080,7 @@ From class - + @@ -3078,7 +3096,7 @@ From class - + @@ -3094,7 +3112,7 @@ From class - + @@ -3110,7 +3128,7 @@ From class - + @@ -3126,7 +3144,7 @@ From class - + @@ -3142,6 +3160,22 @@ From class + + + + + + + + int + + + getUserId() + + + + + @@ -3424,7 +3458,7 @@ From class void - sendBroadcast(Intent arg0) + sendBroadcast(Intent arg0, String arg1, int arg2) @@ -3440,7 +3474,7 @@ From class void - sendBroadcastAsUser(Intent arg0, UserHandle arg1) + sendBroadcast(Intent arg0) @@ -3456,7 +3490,7 @@ From class void - sendBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2) + sendBroadcastAsUser(Intent arg0, UserHandle arg1) @@ -3472,7 +3506,7 @@ From class void - sendOrderedBroadcast(Intent arg0, String arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6) + sendBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2) @@ -3488,12 +3522,44 @@ From class void + sendOrderedBroadcast(Intent arg0, String arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6) + + + + + + + + + + + + + void + + sendOrderedBroadcast(Intent arg0, String arg1) + + + + + + + + void + + + sendOrderedBroadcast(Intent arg0, String arg1, int arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7) + + + + + @@ -3930,7 +3996,7 @@ From class boolean - bindService(Intent arg0, ServiceConnection arg1, int arg2, int arg3) + bindServiceAsUser(Intent arg0, ServiceConnection arg1, int arg2, UserHandle arg3) @@ -4359,6 +4425,22 @@ From class + String + + + getBasePackageName() + + + + + + + + abstract + + + + File @@ -4368,7 +4450,7 @@ From class - + abstract @@ -4384,7 +4466,7 @@ From class - + abstract @@ -4400,7 +4482,7 @@ From class - + abstract @@ -4416,7 +4498,7 @@ From class - + abstract @@ -4432,7 +4514,7 @@ From class - + abstract @@ -4448,7 +4530,7 @@ From class - + abstract @@ -4464,7 +4546,7 @@ From class - + abstract @@ -4480,7 +4562,7 @@ From class - + abstract @@ -4496,7 +4578,7 @@ From class - + abstract @@ -4512,7 +4594,7 @@ From class - + abstract @@ -4528,7 +4610,7 @@ From class - + abstract @@ -4544,7 +4626,7 @@ From class - + abstract @@ -4560,7 +4642,7 @@ From class - + abstract @@ -4576,7 +4658,7 @@ From class - + abstract @@ -4592,7 +4674,7 @@ From class - + abstract @@ -4608,7 +4690,7 @@ From class - + abstract @@ -4624,7 +4706,7 @@ From class - + abstract @@ -4640,7 +4722,7 @@ From class - + abstract @@ -4656,7 +4738,7 @@ From class - + @@ -4672,7 +4754,7 @@ From class - + @@ -4688,7 +4770,7 @@ From class - + abstract @@ -4704,7 +4786,7 @@ From class - + @@ -4720,7 +4802,7 @@ From class - + abstract @@ -4736,7 +4818,7 @@ From class - + @@ -4752,6 +4834,22 @@ From class + + + abstract + + + + + int + + + getUserId() + + + + + abstract @@ -5114,7 +5212,7 @@ From class void - sendBroadcast(Intent arg0) + sendBroadcast(Intent arg0, String arg1, int arg2) @@ -5130,7 +5228,7 @@ From class void - sendBroadcastAsUser(Intent arg0, UserHandle arg1) + sendBroadcast(Intent arg0) @@ -5146,7 +5244,7 @@ From class void - sendBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2) + sendBroadcastAsUser(Intent arg0, UserHandle arg1) @@ -5162,7 +5260,7 @@ From class void - sendOrderedBroadcast(Intent arg0, String arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6) + sendBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2) @@ -5178,12 +5276,44 @@ From class void + sendOrderedBroadcast(Intent arg0, String arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6) + + + + + + + + abstract + + + + + void + + sendOrderedBroadcast(Intent arg0, String arg1) + + + abstract + + + + + void + + + sendOrderedBroadcast(Intent arg0, String arg1, int arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7) + + + + + abstract @@ -5940,7 +6070,9 @@ From interface
-

+

Old TAG used for logging. Marked as deprecated since it should have + been private at first place. +

diff --git a/docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html b/docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html index e75f046..38e68f4 100644 --- a/docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html +++ b/docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html @@ -746,19 +746,23 @@ Summary:
+

+

+ This class is deprecated.
+ Please use the + GoogleCloudMessaging API instead. +

Class Overview

-
DEPRECATED. Please use the GoogleCloudMessaging API instead.

BroadcastReceiver that receives GCM messages and delivers them to an application-specific GCMBaseIntentService subclass.

By default, the GCMBaseIntentService class belongs to the application main package and is named DEFAULT_INTENT_SERVICE_CLASS_NAME. To use a new class, - the getGCMIntentServiceClassName(Context) must be overridden. -

+ the getGCMIntentServiceClassName(Context) must be overridden.

diff --git a/docs/html/reference/com/google/android/gcm/GCMConstants.html b/docs/html/reference/com/google/android/gcm/GCMConstants.html index 0c9d6cd..097a24f 100644 --- a/docs/html/reference/com/google/android/gcm/GCMConstants.html +++ b/docs/html/reference/com/google/android/gcm/GCMConstants.html @@ -719,13 +719,17 @@ Summary:
+

+

+ This class is deprecated.
+ Please use the + GoogleCloudMessaging API instead. +

Class Overview

-
DEPRECATED. Please use the GoogleCloudMessaging API instead.
-

Constants used by the GCM library. -

+

Constants used by the GCM library.

@@ -823,47 +827,55 @@ Summary: String EXTRA_APPLICATION_PENDING_INTENT - Extra used on .INTENT_TO_GCM_REGISTRATION to get the - application info. + Extra used on + com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION + to get the application info. String EXTRA_ERROR - Extra used on .INTENT_FROM_GCM_REGISTRATION_CALLBACK to indicate - an error when the registration fails. + Extra used on + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK + to indicate an error when the registration fails. String EXTRA_FROM - Extra used on .INTENT_FROM_GCM_MESSAGE to indicate which - sender (Google API project id) sent the message. + Extra used on + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE + to indicate which sender (Google API project id) sent the message. String EXTRA_REGISTRATION_ID - Extra used on .INTENT_FROM_GCM_REGISTRATION_CALLBACK to indicate - the registration id when the registration succeeds. + Extra used on + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK + to indicate the registration id when the registration succeeds. String EXTRA_SENDER - Extra used on .INTENT_TO_GCM_REGISTRATION to indicate which - senders (Google API project ids) can send messages to the application. + Extra used on + com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION + to indicate which senders (Google API project ids) can send messages to + the application. String EXTRA_SPECIAL_MESSAGE - Type of message present in the .INTENT_FROM_GCM_MESSAGE intent. + Type of message present in the + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE + intent. @@ -877,8 +889,9 @@ Summary: String EXTRA_UNREGISTERED - Extra used on .INTENT_FROM_GCM_REGISTRATION_CALLBACK to indicate - that the application has been unregistered. + Extra used on + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK + to indicate that the application has been unregistered. @@ -1487,8 +1500,9 @@ From class
-

Extra used on .INTENT_TO_GCM_REGISTRATION to get the - application info. +

Extra used on + com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION + to get the application info.

@@ -1526,9 +1540,10 @@ From class
-

Extra used on .INTENT_FROM_GCM_REGISTRATION_CALLBACK to indicate - an error when the registration fails. See constants starting with ERROR_ - for possible values. +

Extra used on + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK + to indicate an error when the registration fails. + See constants starting with ERROR_ for possible values.

@@ -1566,8 +1581,9 @@ From class
-

Extra used on .INTENT_FROM_GCM_MESSAGE to indicate which - sender (Google API project id) sent the message. +

Extra used on + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE + to indicate which sender (Google API project id) sent the message.

@@ -1605,8 +1621,9 @@ From class
-

Extra used on .INTENT_FROM_GCM_REGISTRATION_CALLBACK to indicate - the registration id when the registration succeeds. +

Extra used on + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK + to indicate the registration id when the registration succeeds.

@@ -1644,8 +1661,10 @@ From class
-

Extra used on .INTENT_TO_GCM_REGISTRATION to indicate which - senders (Google API project ids) can send messages to the application. +

Extra used on + com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION + to indicate which senders (Google API project ids) can send messages to + the application.

@@ -1683,7 +1702,9 @@ From class
-

Type of message present in the .INTENT_FROM_GCM_MESSAGE intent. +

Type of message present in the + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE + intent. This extra is only set for special messages sent from GCM, not for messages originated from the application.

@@ -1725,7 +1746,7 @@ From class

Number of messages deleted by the server because the device was idle. Present only on messages of special type - .VALUE_DELETED_MESSAGES + com.google.android.gcm.GCMConstants.VALUE_DELETED_MESSAGES

@@ -1763,8 +1784,9 @@ From class
-

Extra used on .INTENT_FROM_GCM_REGISTRATION_CALLBACK to indicate - that the application has been unregistered. +

Extra used on + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK + to indicate that the application has been unregistered.

diff --git a/docs/html/reference/com/google/android/gcm/GCMRegistrar.html b/docs/html/reference/com/google/android/gcm/GCMRegistrar.html index 643260e..89f7646 100644 --- a/docs/html/reference/com/google/android/gcm/GCMRegistrar.html +++ b/docs/html/reference/com/google/android/gcm/GCMRegistrar.html @@ -722,16 +722,20 @@ Summary:
+

+

+ This class is deprecated.
+ Please use the + GoogleCloudMessaging API instead. +

Class Overview

-
DEPRECATED. Please use the GoogleCloudMessaging API instead.

Utilities for device registration.

Note: this class uses a private SharedPreferences - object to keep track of the registration token. -

+ object to keep track of the registration token.

diff --git a/docs/html/reference/com/google/android/gcm/package-summary.html b/docs/html/reference/com/google/android/gcm/package-summary.html index 7ddea71..d46d1d7 100644 --- a/docs/html/reference/com/google/android/gcm/package-summary.html +++ b/docs/html/reference/com/google/android/gcm/package-summary.html @@ -640,6 +640,12 @@ onkeyup="return search_changed(event, false, '/')" />
+
+

DEPRECATED — please use the GoogleCloudMessaging API instead of this client helper library — see GCM Client for more information.

+ + +
+ @@ -651,22 +657,42 @@ onkeyup="return search_changed(event, false, '/')" />

Classes

- +
- + - + - + - +
GCMBaseIntentServiceDEPRECATED.  + This class is deprecated. + Please use the + GoogleCloudMessaging API instead. + 
GCMBroadcastReceiverDEPRECATED.  + This class is deprecated. + Please use the + GoogleCloudMessaging API instead. + 
GCMConstantsDEPRECATED.  + This class is deprecated. + Please use the + GoogleCloudMessaging API instead. + 
GCMRegistrarDEPRECATED.  + This class is deprecated. + Please use the + GoogleCloudMessaging API instead. + 
diff --git a/docs/html/reference/com/google/android/gcm/server/Constants.html b/docs/html/reference/com/google/android/gcm/server/Constants.html index 48fb894..def0254 100644 --- a/docs/html/reference/com/google/android/gcm/server/Constants.html +++ b/docs/html/reference/com/google/android/gcm/server/Constants.html @@ -935,18 +935,33 @@ Summary: String + PARAM_DRY_RUN + HTTP parameter for telling gcm to validate the message without actually sending it. + + + + + String PARAM_PAYLOAD_PREFIX Prefix to HTTP parameter used to pass key-values in the message payload. - + String PARAM_REGISTRATION_ID HTTP parameter for registration id. + + String + PARAM_RESTRICTED_PACKAGE_NAME + 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. + + + String PARAM_TIME_TO_LIVE @@ -2121,6 +2136,44 @@ From class + + +
+

+ + public + static + final + String + + PARAM_DRY_RUN +

+
+ + + + +
+
+ +

HTTP parameter for telling gcm to validate the message without actually sending it. +

+ + +
+ Constant Value: + + + "dry_run" + + +
+ +
+
+ + +
@@ -2197,6 +2250,45 @@ From class + + +
+

+ + public + static + final + String + + PARAM_RESTRICTED_PACKAGE_NAME +

+
+ + + + +
+
+ +

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. +

+ + +
+ Constant Value: + + + "restricted_package_name" + + +
+ +
+
+ + +
diff --git a/docs/html/reference/com/google/android/gcm/server/Message.Builder.html b/docs/html/reference/com/google/android/gcm/server/Message.Builder.html index 5bc68e5..99b4337 100644 --- a/docs/html/reference/com/google/android/gcm/server/Message.Builder.html +++ b/docs/html/reference/com/google/android/gcm/server/Message.Builder.html @@ -887,6 +887,42 @@ Summary: Message.Builder + dryRun(boolean value) + +
Sets the dryRun property (default value is false).
+ + + + + + + + + + + + + Message.Builder + + + restrictedPackageName(String value) + +
Sets the restrictedPackageName property.
+ + + + + + + + + + + + + Message.Builder + + timeToLive(int value)
Sets the time to live, in seconds.
@@ -1307,6 +1343,66 @@ From class
+ + +
+

+ + public + + + + + Message.Builder + + dryRun + (boolean value) +

+
+
+ + + +
+
+ +

Sets the dryRun property (default value is false). +

+ +
+
+ + + + +
+

+ + public + + + + + Message.Builder + + restrictedPackageName + (String value) +

+
+
+ + + +
+
+ +

Sets the restrictedPackageName property. +

+ +
+
+ +
diff --git a/docs/html/reference/com/google/android/gcm/server/Message.html b/docs/html/reference/com/google/android/gcm/server/Message.html index d894aff..6531360 100644 --- a/docs/html/reference/com/google/android/gcm/server/Message.html +++ b/docs/html/reference/com/google/android/gcm/server/Message.html @@ -752,6 +752,8 @@ Summary: .collapseKey(collapseKey) .timeToLive(3) .delayWhileIdle(true) + .dryRun(true) + .restrictedPackageName(restrictedPackageName) .build(); @@ -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 + + + getRestrictedPackageName() + +
Gets the restricted package name.
+ + + + + + + + + + + + Integer @@ -899,7 +921,7 @@ Summary: - + @@ -917,6 +939,24 @@ Summary: + + + + + + + + Boolean + + + isDryRun() + +
Gets the dryRun flag.
+ + + + + @@ -1252,6 +1292,36 @@ From class
+ + +
+

+ + public + + + + + String + + getRestrictedPackageName + () +

+
+
+ + + +
+
+ +

Gets the restricted package name. +

+ +
+
+ +
@@ -1312,6 +1382,36 @@ From class
+ + +
+

+ + public + + + + + Boolean + + isDryRun + () +

+
+
+ + + +
+
+ +

Gets the dryRun flag. +

+ +
+
+ +
diff --git a/docs/html/reference/com/google/android/gcm/server/MulticastResult.Builder.html b/docs/html/reference/com/google/android/gcm/server/MulticastResult.Builder.html new file mode 100644 index 0000000..e400a43 --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/server/MulticastResult.Builder.html @@ -0,0 +1,1288 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +MulticastResult.Builder | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +
+ +
+ + + + + + + + + + + +
+ +Summary: + + + + + + + + + + Ctors + + + + + | Methods + + + + + | Inherited Methods + +| [Expand All] + +
+
+ + + + +
+
+ + + + +
+ public + static + final + + class +

MulticastResult.Builder

+ + + + + extends Object
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + +
java.lang.Object
   ↳com.google.android.gcm.server.MulticastResult.Builder
+ + + + + + + +
+ + + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Constructors
+ + + + + + + + MulticastResult.Builder(int success, int failure, int canonicalIds, long multicastId) + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + + + MulticastResult.Builder + + addResult(Result result) + +
+ + + + + + MulticastResult + + build() + +
+ + + + + + MulticastResult.Builder + + retryMulticastIds(List<Long> retryMulticastIds) + +
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + java.lang.Object + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Constructors

+ + + + + +
+

+ + public + + + + + + + MulticastResult.Builder + (int success, int failure, int canonicalIds, long multicastId) +

+
+
+ + + +
+
+ +

+ +
+
+ + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + public + + + + + MulticastResult.Builder + + addResult + (Result result) +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + public + + + + + MulticastResult + + build + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + public + + + + + MulticastResult.Builder + + retryMulticastIds + (List<Long> retryMulticastIds) +

+
+
+ + + +
+
+ +

+ +
+
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + + diff --git a/docs/html/reference/com/google/android/gcm/server/MulticastResult.html b/docs/html/reference/com/google/android/gcm/server/MulticastResult.html index 4735d75..ceeccd1 100644 --- a/docs/html/reference/com/google/android/gcm/server/MulticastResult.html +++ b/docs/html/reference/com/google/android/gcm/server/MulticastResult.html @@ -641,6 +641,9 @@ onkeyup="return search_changed(event, false, '/')" /> Summary: + Nested Classes + + @@ -651,7 +654,7 @@ Summary: - Methods + | Methods @@ -763,6 +766,26 @@ Summary: + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gcm/server/Result.Builder.html b/docs/html/reference/com/google/android/gcm/server/Result.Builder.html new file mode 100644 index 0000000..035d2bf --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/server/Result.Builder.html @@ -0,0 +1,1333 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Result.Builder | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +
+ +
+ + + + + + + + + + + +
+ +Summary: + + + + + + + + + + Ctors + + + + + | Methods + + + + + | Inherited Methods + +| [Expand All] + +
+
+ + + + +
+
+ + + + +
+ public + static + final + + class +

Result.Builder

+ + + + + extends Object
+ + + + + + + + + +
+ +
+ +
+
Nested Classes
+ + + + + classMulticastResult.Builder 
+ + + + + + + + + + + + + + + + +
java.lang.Object
   ↳com.google.android.gcm.server.Result.Builder
+ + + + + + + +
+ + + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Constructors
+ + + + + + + + Result.Builder() + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + + + Result + + build() + +
+ + + + + + Result.Builder + + canonicalRegistrationId(String value) + +
+ + + + + + Result.Builder + + errorCode(String value) + +
+ + + + + + Result.Builder + + messageId(String value) + +
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + java.lang.Object + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Constructors

+ + + + + +
+

+ + public + + + + + + + Result.Builder + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + public + + + + + Result + + build + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + public + + + + + Result.Builder + + canonicalRegistrationId + (String value) +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + public + + + + + Result.Builder + + errorCode + (String value) +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + public + + + + + Result.Builder + + messageId + (String value) +

+
+
+ + + +
+
+ +

+ +
+
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + + diff --git a/docs/html/reference/com/google/android/gcm/server/Result.html b/docs/html/reference/com/google/android/gcm/server/Result.html index bea3d39..bf004d1 100644 --- a/docs/html/reference/com/google/android/gcm/server/Result.html +++ b/docs/html/reference/com/google/android/gcm/server/Result.html @@ -641,6 +641,9 @@ onkeyup="return search_changed(event, false, '/')" /> Summary: + Nested Classes + + @@ -651,7 +654,7 @@ Summary: - Methods + | Methods @@ -786,6 +789,26 @@ Summary: + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gcm/server/package-summary.html b/docs/html/reference/com/google/android/gcm/server/package-summary.html index d4041ff..773c0b5 100644 --- a/docs/html/reference/com/google/android/gcm/server/package-summary.html +++ b/docs/html/reference/com/google/android/gcm/server/package-summary.html @@ -640,6 +640,12 @@ onkeyup="return search_changed(event, false, '/')" />
+
+

Helper library for GCM HTTP server operations — see GCM Server for more information.

+ + +
+ @@ -669,9 +675,17 @@ onkeyup="return search_changed(event, false, '/')" />
+ + + + + + + + -- cgit v1.1
Nested Classes
+ + + + + classResult.Builder 
Result of a GCM multicast message request . 
MulticastResult.Builder 
Result Result of a GCM message request that returned HTTP status code 200. 
Result.Builder 
Sender Helper class to send messages to the GCM service using an API Key.