From 4779ffa728d9eb316c5fd30798d39950adf89fb5 Mon Sep 17 00:00:00 2001 From: Robert Ly Date: Sun, 2 Dec 2012 17:24:48 -0800 Subject: [PATCH] docs: add javadocs for gcm Change-Id: I6c4c0990f1a9eec51cc2bf0fd857607b90ac184e --- .../android/gcm/GCMBaseIntentService.html | 6 +- .../android/gcm/GCMBroadcastReceiver.html | 6 +- .../com/google/android/gcm/GCMConstants.html | 36 +- .../com/google/android/gcm/GCMRegistrar.html | 12 +- .../google/android/gcm/package-summary.html | 6 +- .../google/android/gcm/server/Constants.html | 6 +- .../gcm/server/InvalidRequestException.html | 6 +- .../android/gcm/server/Message.Builder.html | 6 +- .../google/android/gcm/server/Message.html | 6 +- .../android/gcm/server/MulticastResult.html | 6 +- .../android/gcm/server/Result.Builder.html | 1271 ----------------- .../com/google/android/gcm/server/Result.html | 6 +- .../com/google/android/gcm/server/Sender.html | 6 +- .../android/gcm/server/package-summary.html | 6 +- docs/html/reference/gms-packages.html | 4 +- 15 files changed, 60 insertions(+), 1329 deletions(-) delete mode 100644 docs/html/reference/com/google/android/gcm/server/Result.Builder.html diff --git a/docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html b/docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html index 618381f0fe16e..29950966b43be 100644 --- a/docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html +++ b/docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html @@ -408,13 +408,13 @@ onkeyup="return search_changed(event, false, '/')" /> Security and Design
  • - Testing
    In-app Billing     + Testing In-app Billing
  • Administering In-app Billing
  • - In-app Billing Reference + Reference
    • @@ -5547,7 +5547,7 @@ From interface
    - Android  r - 30 Nov 2012 16:06 + Android  r — 02 Dec 2012 17:05
    diff --git a/docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html b/docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html index 2b831a1dfcecf..9e8cc56253a72 100644 --- a/docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html +++ b/docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html @@ -408,13 +408,13 @@ onkeyup="return search_changed(event, false, '/')" /> Security and Design
  • - Testing
    In-app Billing     + Testing In-app Billing
  • Administering In-app Billing
  • - In-app Billing Reference + Reference
    • @@ -1481,7 +1481,7 @@ From class
    - Android  r - 30 Nov 2012 16:06 + Android  r — 02 Dec 2012 17:05
    diff --git a/docs/html/reference/com/google/android/gcm/GCMConstants.html b/docs/html/reference/com/google/android/gcm/GCMConstants.html index 53e4112f5e588..a33ba730335fc 100644 --- a/docs/html/reference/com/google/android/gcm/GCMConstants.html +++ b/docs/html/reference/com/google/android/gcm/GCMConstants.html @@ -408,13 +408,13 @@ onkeyup="return search_changed(event, false, '/')" /> Security and Design
  • - Testing
    In-app Billing     + Testing In-app Billing
  • Administering In-app Billing
  • - In-app Billing Reference + Reference
    • @@ -726,7 +726,7 @@ Summary: String EXTRA_APPLICATION_PENDING_INTENT Extra used on - com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION + com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION to get the application info. @@ -735,7 +735,7 @@ Summary: String EXTRA_ERROR Extra used on - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK to indicate an error when the registration fails. @@ -744,7 +744,7 @@ Summary: String EXTRA_FROM Extra used on - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE to indicate which sender (Google API project id) sent the message. @@ -753,7 +753,7 @@ Summary: String EXTRA_REGISTRATION_ID Extra used on - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK to indicate the registration id when the registration succeeds. @@ -762,7 +762,7 @@ Summary: String EXTRA_SENDER Extra used on - com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION + com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION to indicate which senders (Google API project ids) can send messages to the application. @@ -772,7 +772,7 @@ Summary: String EXTRA_SPECIAL_MESSAGE Type of message present in the - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE intent. @@ -788,7 +788,7 @@ Summary: String EXTRA_UNREGISTERED Extra used on - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK to indicate that the application has been unregistered. @@ -1399,7 +1399,7 @@ From class

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

    @@ -1439,7 +1439,7 @@ From class

    Extra used on - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK + 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.

    @@ -1480,7 +1480,7 @@ From class

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

    @@ -1520,7 +1520,7 @@ From class

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

    @@ -1560,7 +1560,7 @@ From class

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

    @@ -1601,7 +1601,7 @@ From class

    Type of message present in the - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE + 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. @@ -1644,7 +1644,7 @@ From class

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

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

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

    @@ -2006,7 +2006,7 @@ From class
    - Android  r - 30 Nov 2012 16:06 + Android  r — 02 Dec 2012 17:05
    diff --git a/docs/html/reference/com/google/android/gcm/GCMRegistrar.html b/docs/html/reference/com/google/android/gcm/GCMRegistrar.html index 33a512615f88b..60cac95b11968 100644 --- a/docs/html/reference/com/google/android/gcm/GCMRegistrar.html +++ b/docs/html/reference/com/google/android/gcm/GCMRegistrar.html @@ -408,13 +408,13 @@ onkeyup="return search_changed(event, false, '/')" /> Security and Design
  • - Testing
    In-app Billing     + Testing In-app Billing
  • Administering In-app Billing
  • - In-app Billing Reference + Reference
    • @@ -1299,12 +1299,12 @@ From class
  • It defines at least one BroadcastReceiver with category PACKAGE_NAME.
  • The BroadcastReceiver(s) uses the - com.google.android.gcm.GCMConstants.PERMISSION_GCM_INTENTS + com.google.android.gcm.GCMConstants.PERMISSION_GCM_INTENTS permission.
  • The BroadcastReceiver(s) handles the 2 GCM intents - (com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE + (com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE and - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK). + com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK). ...where PACKAGE_NAME is the application package.

    @@ -1685,7 +1685,7 @@ From class

    • - Android  r - 30 Nov 2012 16:06 + Android  r — 02 Dec 2012 17:05
    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 46450e9a2cb42..a9cc8948dcced 100644 --- a/docs/html/reference/com/google/android/gcm/package-summary.html +++ b/docs/html/reference/com/google/android/gcm/package-summary.html @@ -409,13 +409,13 @@ onkeyup="return search_changed(event, false, '/')" /> Security and Design
  • - Testing
    In-app Billing     + Testing In-app Billing
  • Administering In-app Billing
  • - In-app Billing Reference + Reference
    • @@ -600,7 +600,7 @@ onkeyup="return search_changed(event, false, '/')" />
    - Android  r - 30 Nov 2012 16:06 + Android  r — 02 Dec 2012 17:05
    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 f8f1ce25f5ace..033a7c9609c18 100644 --- a/docs/html/reference/com/google/android/gcm/server/Constants.html +++ b/docs/html/reference/com/google/android/gcm/server/Constants.html @@ -408,13 +408,13 @@ onkeyup="return search_changed(event, false, '/')" /> Security and Design
  • - Testing
    In-app Billing     + Testing In-app Billing
  • Administering In-app Billing
  • - In-app Billing Reference + Reference
    • @@ -2291,7 +2291,7 @@ From class
    - Android  r - 30 Nov 2012 16:06 + Android  r — 02 Dec 2012 17:05
    diff --git a/docs/html/reference/com/google/android/gcm/server/InvalidRequestException.html b/docs/html/reference/com/google/android/gcm/server/InvalidRequestException.html index 1b3b138f0ed20..cd48dff92e5f9 100644 --- a/docs/html/reference/com/google/android/gcm/server/InvalidRequestException.html +++ b/docs/html/reference/com/google/android/gcm/server/InvalidRequestException.html @@ -408,13 +408,13 @@ onkeyup="return search_changed(event, false, '/')" /> Security and Design
  • - Testing
    In-app Billing     + Testing In-app Billing
  • Administering In-app Billing
  • - In-app Billing Reference + Reference
    • @@ -1451,7 +1451,7 @@ From class
    - Android  r - 30 Nov 2012 16:06 + Android  r — 02 Dec 2012 17:05
    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 dd1f6a6fb4389..66cb9308623fb 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 @@ -408,13 +408,13 @@ onkeyup="return search_changed(event, false, '/')" /> Security and Design
  • - Testing
    In-app Billing     + Testing In-app Billing
  • Administering In-app Billing
  • - In-app Billing Reference + Reference
    • @@ -1263,7 +1263,7 @@ From class
    - Android  r - 30 Nov 2012 16:06 + Android  r — 02 Dec 2012 17:05
    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 eb53eedf18c38..766650d0e38ce 100644 --- a/docs/html/reference/com/google/android/gcm/server/Message.html +++ b/docs/html/reference/com/google/android/gcm/server/Message.html @@ -408,13 +408,13 @@ onkeyup="return search_changed(event, false, '/')" /> Security and Design
  • - Testing
    In-app Billing     + Testing In-app Billing
  • Administering In-app Billing
  • - In-app Billing Reference + Reference
    • @@ -1267,7 +1267,7 @@ From class
    - Android  r - 30 Nov 2012 16:06 + Android  r — 02 Dec 2012 17:05
    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 716dc979e21ba..5c3ecd48cf031 100644 --- a/docs/html/reference/com/google/android/gcm/server/MulticastResult.html +++ b/docs/html/reference/com/google/android/gcm/server/MulticastResult.html @@ -408,13 +408,13 @@ onkeyup="return search_changed(event, false, '/')" /> Security and Design
  • - Testing
    In-app Billing     + Testing In-app Billing
  • Administering In-app Billing
  • - In-app Billing Reference + Reference
    • @@ -1361,7 +1361,7 @@ From class
    - Android  r - 30 Nov 2012 16:06 + Android  r — 02 Dec 2012 17:05
    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 deleted file mode 100644 index 79f458166e81d..0000000000000 --- a/docs/html/reference/com/google/android/gcm/server/Result.Builder.html +++ /dev/null @@ -1,1271 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Result.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - - - - - - -
    - -
    - - - - - - - - - - - -
    - -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
    -
    - - - - -
    -
    - - - - -
    - public - static - final - - class -

    Result.Builder

    - - - - - extends Object
    - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - -
    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 3063f942e3dc2..e469e14cfcad8 100644 --- a/docs/html/reference/com/google/android/gcm/server/Result.html +++ b/docs/html/reference/com/google/android/gcm/server/Result.html @@ -408,13 +408,13 @@ onkeyup="return search_changed(event, false, '/')" /> Security and Design
  • - Testing
    In-app Billing     + Testing In-app Billing
  • Administering In-app Billing
  • - In-app Billing Reference + Reference
    • @@ -1190,7 +1190,7 @@ From class
    - Android  r - 30 Nov 2012 16:06 + Android  r — 02 Dec 2012 17:05
    diff --git a/docs/html/reference/com/google/android/gcm/server/Sender.html b/docs/html/reference/com/google/android/gcm/server/Sender.html index 897fbfe88f288..e9f7311edbf8f 100644 --- a/docs/html/reference/com/google/android/gcm/server/Sender.html +++ b/docs/html/reference/com/google/android/gcm/server/Sender.html @@ -408,13 +408,13 @@ onkeyup="return search_changed(event, false, '/')" /> Security and Design
  • - Testing
    In-app Billing     + Testing In-app Billing
  • Administering In-app Billing
  • - In-app Billing Reference + Reference
    • @@ -2077,7 +2077,7 @@ From class
    - Android  r - 30 Nov 2012 16:06 + Android  r — 02 Dec 2012 17:05
    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 50c257111553b..05abef7ce4af3 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 @@ -409,13 +409,13 @@ onkeyup="return search_changed(event, false, '/')" /> Security and Design
  • - Testing
    In-app Billing     + Testing In-app Billing
  • Administering In-app Billing
  • - In-app Billing Reference + Reference
    • @@ -617,7 +617,7 @@ onkeyup="return search_changed(event, false, '/')" />
    - Android  r - 30 Nov 2012 16:06 + Android  r — 02 Dec 2012 17:05
    diff --git a/docs/html/reference/gms-packages.html b/docs/html/reference/gms-packages.html index 880c45849d5f5..650a2e4922529 100644 --- a/docs/html/reference/gms-packages.html +++ b/docs/html/reference/gms-packages.html @@ -530,7 +530,9 @@ onkeyup="return search_changed(event, false, '/')" />
    -

    +

    Contains the classes for accessing the services provided in the Google Play services platform. See +the Setup guide on how to configure the SDK that contains +these classes.