Skeleton for application-specific IntentServices responsible for
+ handling communication from Google Cloud Messaging service.
+
+ The abstract methods in this class are called from its worker thread, and
+ hence should run in a limited amount of time. If they execute long
+ operations, they should spawn new threads, otherwise the worker thread will
+ be blocked.
+
+ Subclasses must provide a public no-arg constructor.
+
+
+ public
+ static
+ final
+ String
+
+ ERROR_SERVICE_NOT_AVAILABLE
+
+
+
+
+
+
+
+
+
+
The device can't read the response, or there was a 500/503 from the
+ server that can be retried later. The application should use exponential
+ back off and retry.
+
+
+ public
+ static
+ final
+ String
+
+ EXTRA_APPLICATION_PENDING_INTENT
+
+
+
+
+
+
+
+
+
+
Extra used on {@value #INTENT_TO_GCM_REGISTRATION} to get the
+ application info.
+
+
+
+
+ Constant Value:
+
+
+ "app"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ EXTRA_ERROR
+
+
+
+
+
+
+
+
+
+
Extra used on {@value #INTENT_FROM_GCM_REGISTRATION_CALLBACK} to indicate
+ an error when the registration fails. See constants starting with ERROR_
+ for possible values.
+
+
+
+
+ Constant Value:
+
+
+ "error"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ EXTRA_FROM
+
+
+
+
+
+
+
+
+
+
Extra used on {@value #INTENT_FROM_GCM_MESSAGE} to indicate which
+ sender (Google API project id) sent the message.
+
+
+
+
+ Constant Value:
+
+
+ "from"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ EXTRA_REGISTRATION_ID
+
+
+
+
+
+
+
+
+
+
Extra used on {@value #INTENT_FROM_GCM_REGISTRATION_CALLBACK} to indicate
+ the registration id when the registration succeeds.
+
+
+
+
+ Constant Value:
+
+
+ "registration_id"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ EXTRA_SENDER
+
+
+
+
+
+
+
+
+
+
Extra used on {@value #INTENT_TO_GCM_REGISTRATION} to indicate which
+ senders (Google API project ids) can send messages to the application.
+
+
+
+
+ Constant Value:
+
+
+ "sender"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ EXTRA_SPECIAL_MESSAGE
+
+
+
+
+
+
+
+
+
+
Type of message present in the {@value #INTENT_FROM_GCM_MESSAGE} intent.
+ This extra is only set for special messages sent from GCM, not for
+ messages originated from the application.
+
+
+
+
+ Constant Value:
+
+
+ "message_type"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ EXTRA_TOTAL_DELETED
+
+
+
+
+
+
+
+
+
+
Number of messages deleted by the server because the device was idle.
+ Present only on messages of special type
+ {@value #VALUE_DELETED_MESSAGES}
+
+
+
+
+ Constant Value:
+
+
+ "total_deleted"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ EXTRA_UNREGISTERED
+
+
+
+
+
+
+
+
+
+
Extra used on {@value #INTENT_FROM_GCM_REGISTRATION_CALLBACK} to indicate
+ that the application has been unregistered.
+
+
+
+
+ Constant Value:
+
+
+ "unregistered"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ INTENT_FROM_GCM_LIBRARY_RETRY
+
+
+
+
+
+
+
+
+
+
Intent used by the GCM library to indicate that the registration call
+ should be retried.
+
Checks that the application manifest is properly configured.
+
+ A proper configuration means:
+
+
It creates a custom permission called
+ PACKAGE_NAME.permission.C2D_MESSAGE.
+
It defines at least one BroadcastReceiver with category
+ PACKAGE_NAME.
+
The BroadcastReceiver(s) uses the
+ {@value com.google.android.gcm.GCMConstants#PERMISSION_GCM_INTENTS}
+ permission.
+
The BroadcastReceiver(s) handles the 2 GCM intents
+ ({@value com.google.android.gcm.GCMConstants#INTENT_FROM_GCM_MESSAGE}
+ and
+ {@value com.google.android.gcm.GCMConstants#INTENT_FROM_GCM_REGISTRATION_CALLBACK}).
+
+ ...where PACKAGE_NAME is the application package.
+
+ This method should be used during development time to verify that the
+ manifest is properly set up, but it doesn't need to be called once the
+ application is deployed to the users' devices.
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.
+
+ public
+ static
+ final
+ String
+
+ ERROR_INTERNAL_SERVER_ERROR
+
+
+
+
+
+
+
+
+
+
A particular message could not be sent because the GCM servers encountered
+ an error. Used only on JSON requests, as in plain text requests internal
+ errors are indicated by a 500 response.
+
+
+ public
+ static
+ final
+ String
+
+ ERROR_NOT_REGISTERED
+
+
+
+
+
+
+
+
+
+
The user has uninstalled the application or turned off notifications.
+ Sender should stop sending messages to this device and delete the
+ registration_id. The client needs to re-register with the GCM servers to
+ receive notifications again.
+
+
+
+
+ Constant Value:
+
+
+ "NotRegistered"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ ERROR_QUOTA_EXCEEDED
+
+
+
+
+
+
+
+
+
+
Too many messages sent by the sender. Retry after a while.
+
+
+
+
+ Constant Value:
+
+
+ "QuotaExceeded"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ ERROR_UNAVAILABLE
+
+
+
+
+
+
+
+
+
+
A particular message could not be sent because the GCM servers were not
+ available. Used only on JSON requests, as in plain text requests
+ unavailability is indicated by a 503 response.
+
+
+
+
+ Constant Value:
+
+
+ "Unavailable"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ GCM_SEND_ENDPOINT
+
+
+ public
+ static
+ final
+ String
+
+ JSON_CANONICAL_IDS
+
+
+
+
+
+
+
+
+
+
JSON-only field representing the number of messages with a canonical
+ registration id.
+
+
+
+
+ Constant Value:
+
+
+ "canonical_ids"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ JSON_ERROR
+
+
+
+
+
+
+
+
+
+
JSON-only field representing the error field of an individual request.
+
+
+
+
+ Constant Value:
+
+
+ "error"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ JSON_FAILURE
+
+
+
+
+
+
+
+
+
+
JSON-only field representing the number of failed messages.
+
+
+
+
+ Constant Value:
+
+
+ "failure"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ JSON_MESSAGE_ID
+
+
+
+
+
+
+
+
+
+
JSON-only field sent by GCM when a message was successfully sent.
+
+
+
+
+ Constant Value:
+
+
+ "message_id"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ JSON_MULTICAST_ID
+
+
+
+
+
+
+
+
+
+
JSON-only field representing the id of the multicast request.
+
+
+
+
+ Constant Value:
+
+
+ "multicast_id"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ JSON_PAYLOAD
+
+
+
+
+
+
+
+
+
+
JSON-only field representing the payload data.
+
+
+
+
+ Constant Value:
+
+
+ "data"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ JSON_REGISTRATION_IDS
+
+
+
+
+
+
+
+
+
+
JSON-only field representing the registration ids.
+
+
+
+
+ Constant Value:
+
+
+ "registration_ids"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ JSON_RESULTS
+
+
+
+
+
+
+
+
+
+
JSON-only field representing the result of each individual request.
+
+
+
+
+ Constant Value:
+
+
+ "results"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ JSON_SUCCESS
+
+
+
+
+
+
+
+
+
+
JSON-only field representing the number of successful messages.
+
+
+
+
+ Constant Value:
+
+
+ "success"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ PARAM_COLLAPSE_KEY
+
+
+
+
+
+
+
+
+
+
HTTP parameter for collapse key.
+
+
+
+
+ Constant Value:
+
+
+ "collapse_key"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ PARAM_DELAY_WHILE_IDLE
+
+
+
+
+
+
+
+
+
+
HTTP parameter for delaying the message delivery if the device is idle.
+
+
+
+
+ Constant Value:
+
+
+ "delay_while_idle"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ PARAM_DRY_RUN
+
+
+
+
+
+
+
+
+
+
HTTP parameter for telling gcm to validate the message without actually sending it.
+
+
+
+
+ Constant Value:
+
+
+ "dry_run"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ PARAM_PAYLOAD_PREFIX
+
+
+
+
+
+
+
+
+
+
Prefix to HTTP parameter used to pass key-values in the message payload.
+
+
+
+
+ Constant Value:
+
+
+ "data."
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ String
+
+ PARAM_REGISTRATION_ID
+
+
+
+
+
+
+
+
+
+
HTTP parameter for registration id.
+
+
+
+
+ Constant Value:
+
+
+ "registration_id"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+ There are cases when a request is accept and the message successfully
+ created, but GCM has a canonical registration id for that device. In this
+ case, the server should update the registration id to avoid rejected requests
+ in the future.
+
+
+ In a nutshell, the workflow to handle a result is:
+
+ - Call getMessageId():
+ - null means error, call getErrorCodeName()
+ - non-null means the message was created:
+ - Call getCanonicalRegistrationId()
+ - if it returns null, do nothing.
+ - otherwise, update the server datastore with the new id.
+
Sends a message to many devices, retrying in case of unavailability.
+
+
+ Note: this method uses exponential back-off to retry in
+ case of service unavailability and hence could block the calling thread
+ for many seconds.
+
+
Parameters
+
+
+
message
+
message to be sent.
+
+
+
regIds
+
registration id of the devices that will receive
+ the message.
+
+
+
retries
+
number of retries in case of service unavailability errors.
+
+ public
+
+
+
+
+ Result
+
+ send
+ (Message message, String registrationId, int retries)
+
+
+
+
+
+
+
+
+
+
Sends a message to one device, retrying in case of unavailability.
+
+
+ Note: this method uses exponential back-off to retry in
+ case of service unavailability and hence could block the calling thread
+ for many seconds.
+
+
Parameters
+
+
+
message
+
message to be sent, including the device's registration id.
+
+
+
registrationId
+
device where the message will be sent.
+
+
+
retries
+
number of retries in case of service unavailability errors.
+
+
+
+
+
Returns
+
result of the request (see its javadoc for more details).
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ cameraTargetLat
+
+
+
+
+
+
+
+
+
+
Must be a floating point value, such as "1.2".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ cameraTargetLng
+
+
+
+
+
+
+
+
+
+
Must be a floating point value, such as "1.2".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ cameraTilt
+
+
+
+
+
+
+
+
+
+
Must be a floating point value, such as "1.2".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ cameraZoom
+
+
+
+
+
+
+
+
+
+
Must be a floating point value, such as "1.2".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ mapType
+
+
+
+
+
+
+
+
+
+
Must be one of the following constant values.
+
+
+
+
+
Constant
Value
Description
+
none
0
+
normal
1
+
satellite
2
+
terrain
3
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ uiCompass
+
+
+
+
+
+
+
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ uiRotateGestures
+
+
+
+
+
+
+
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ uiScrollGestures
+
+
+
+
+
+
+
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ uiTiltGestures
+
+
+
+
+
+
+
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ uiZoomControls
+
+
+
+
+
+
+
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ uiZoomGestures
+
+
+
+
+
+
+
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ useViewLifecycle
+
+
+
+
+
+
+
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ zOrderOnTop
+
+
+
+
+
+
+
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+ public
+ static
+
+ int
+
+ common_google_play_services_enable_button
+
+
+
+
+
+
+
+
+
+
Button in confirmation dialog to enable Google Play services. Clicking it
+ will direct user to application settings of Google Play services where they
+ can enable it [CHAR LIMIT=30]
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ common_google_play_services_enable_text
+
+
+
+
+
+
+
+
+
+
Message in confirmation dialog informing user they need to enable
+ Google Play services in application settings [CHAR LIMIT=NONE]
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ common_google_play_services_enable_title
+
+
+
+
+
+
+
+
+
+
Title of confirmation dialog informing user they need to enable
+ Google Play services in application settings [CHAR LIMIT=40]
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ common_google_play_services_install_button
+
+
+
+
+
+
+
+
+
+
Button in confirmation dialog for installing Google Play services [CHAR LIMIT=30]
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ common_google_play_services_install_text_phone
+
+
+
+
+
+
+
+
+
+
(For phones) Message in confirmation dialog informing user that
+ they need to install Google Play services (from Play Store) [CHAR LIMIT=NONE]
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ common_google_play_services_install_text_tablet
+
+
+
+
+
+
+
+
+
+
(For tablets) Message in confirmation dialog informing user that
+ they need to install Google Play services (from Play Store) [CHAR LIMIT=NONE]
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ common_google_play_services_install_title
+
+
+
+
+
+
+
+
+
+
Title of confirmation dialog informing user that they need to install
+ Google Play services (from Play Store) [CHAR LIMIT=40]
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ common_google_play_services_unknown_issue
+
+
+
+
+
+
+
+
+
+
Message in confirmation dialog informing user there is an unknow issue in Google Player
+ services [CHAR LIMIT=NONE]
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ common_google_play_services_update_button
+
+
+
+
+
+
+
+
+
+
Button in confirmation dialog for updating Google Play services [CHAR LIMIT=20]
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ common_google_play_services_update_text
+
+
+
+
+
+
+
+
+
+
Message in confirmation dialog informing user that they need to update
+ Google Play services (from Play Store) [CHAR LIMIT=NONE]
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+
+ int
+
+ common_google_play_services_update_title
+
+
+
+
+
+
+
+
+
+
Title of confirmation dialog informing user that they need to update
+ Google Play services (from Play Store) [CHAR LIMIT=40]
+
+
+ public
+ static
+ final
+ int
+
+ MapAttrs_cameraBearing
+
+
+
+
+
+
+
+
+
+
This symbol is the offset where the cameraBearing
+ attribute's value can be found in the MapAttrs array.
+
+
+
Must be a floating point value, such as "1.2".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+ Constant Value:
+
+
+ 1
+ (0x00000001)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ int
+
+ MapAttrs_cameraTargetLat
+
+
+
+
+
+
+
+
+
+
This symbol is the offset where the cameraTargetLat
+ attribute's value can be found in the MapAttrs array.
+
+
+
Must be a floating point value, such as "1.2".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+ Constant Value:
+
+
+ 2
+ (0x00000002)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ int
+
+ MapAttrs_cameraTargetLng
+
+
+
+
+
+
+
+
+
+
This symbol is the offset where the cameraTargetLng
+ attribute's value can be found in the MapAttrs array.
+
+
+
Must be a floating point value, such as "1.2".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+ Constant Value:
+
+
+ 3
+ (0x00000003)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ int
+
+ MapAttrs_cameraTilt
+
+
+
+
+
+
+
+
+
+
This symbol is the offset where the cameraTilt
+ attribute's value can be found in the MapAttrs array.
+
+
+
Must be a floating point value, such as "1.2".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+ Constant Value:
+
+
+ 4
+ (0x00000004)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ int
+
+ MapAttrs_cameraZoom
+
+
+
+
+
+
+
+
+
+
This symbol is the offset where the cameraZoom
+ attribute's value can be found in the MapAttrs array.
+
+
+
Must be a floating point value, such as "1.2".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+ Constant Value:
+
+
+ 5
+ (0x00000005)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ int
+
+ MapAttrs_mapType
+
+
+
+
+
+
+
+
+
+
This symbol is the offset where the mapType
+ attribute's value can be found in the MapAttrs array.
+
+
+
Must be one of the following constant values.
+
+
+
+
+
Constant
Value
Description
+
none
0
+
normal
1
+
satellite
2
+
terrain
3
+
+
+
+
+ Constant Value:
+
+
+ 0
+ (0x00000000)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ int
+
+ MapAttrs_uiCompass
+
+
+
+
+
+
+
+
+
+
This symbol is the offset where the uiCompass
+ attribute's value can be found in the MapAttrs array.
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+ Constant Value:
+
+
+ 6
+ (0x00000006)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ int
+
+ MapAttrs_uiRotateGestures
+
+
+
+
+
+
+
+
+
+
This symbol is the offset where the uiRotateGestures
+ attribute's value can be found in the MapAttrs array.
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+ Constant Value:
+
+
+ 7
+ (0x00000007)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ int
+
+ MapAttrs_uiScrollGestures
+
+
+
+
+
+
+
+
+
+
This symbol is the offset where the uiScrollGestures
+ attribute's value can be found in the MapAttrs array.
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+ Constant Value:
+
+
+ 8
+ (0x00000008)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ int
+
+ MapAttrs_uiTiltGestures
+
+
+
+
+
+
+
+
+
+
This symbol is the offset where the uiTiltGestures
+ attribute's value can be found in the MapAttrs array.
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+ Constant Value:
+
+
+ 9
+ (0x00000009)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ int
+
+ MapAttrs_uiZoomControls
+
+
+
+
+
+
+
+
+
+
This symbol is the offset where the uiZoomControls
+ attribute's value can be found in the MapAttrs array.
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+ Constant Value:
+
+
+ 10
+ (0x0000000a)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ int
+
+ MapAttrs_uiZoomGestures
+
+
+
+
+
+
+
+
+
+
This symbol is the offset where the uiZoomGestures
+ attribute's value can be found in the MapAttrs array.
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+ Constant Value:
+
+
+ 11
+ (0x0000000b)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ int
+
+ MapAttrs_useViewLifecycle
+
+
+
+
+
+
+
+
+
+
This symbol is the offset where the useViewLifecycle
+ attribute's value can be found in the MapAttrs array.
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+ Constant Value:
+
+
+ 12
+ (0x0000000c)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ int
+
+ MapAttrs_zOrderOnTop
+
+
+
+
+
+
+
+
+
+
This symbol is the offset where the zOrderOnTop
+ attribute's value can be found in the MapAttrs array.
+
+
+
Must be a boolean value, either "true" or "false".
+
This may also be a reference to a resource (in the form
+"@[package:]type:name") or
+theme attribute (in the form
+"?[package:][type:]name")
+containing a value of this type.
+
+
+
+ Constant Value:
+
+
+ 13
+ (0x0000000d)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Fields
+
+
+
+
+
+
+
+
+
+ public
+ static
+ final
+ int[]
+
+ MapAttrs
+
UserRecoverableNotifiedException signals that there was a Google authentication error which can
+ be recovered with user action and has been handled by publishing a notification for the user
+ to act on.
GooglePlayServicesAvailabilityExceptions are special instances of
+ UserRecoverableAuthExceptions which are thrown when the expected Google Play services app
+ is not available for some reason.
+
+
+
+
+
+
+
+
+
+
+
Class Overview
+
GoogleAuthExceptions signal Google authentication errors. In contrast to
+ IOExceptions, GoogleAuthExceptions imply that authentication shouldn't
+ simply be retried.
+
GoogleAuthUtil provides static utility methods to acquire and invalidate
+ authentication tokens.
+
+
+ public void onCreate {
+ // onCreate is called on the main thread, so you must do the work in
+ // a background thread, which AsyncTask makes easy to do.
+ getAndUseAuthTokenInAsyncTask();
+ }
+
+ ...
+
+ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
+ if (requestCode == MY_ACTIVITYS_AUTH_REQUEST_CODE) {
+ if (resultCode == RESULT_OK) {
+ getAndUseAuthTokenInAsyncTask();
+ }
+ }
+ }
+
+ // Example of how to use the GoogleAuthUtil in a blocking, non-main thread context
+ void getAndUseAuthTokenBlocking() {
+ try {
+ // Retrieve a token for the given account and scope. It will always return either
+ // a non-empty String or throw an exception.
+ final String token = GoogleAuthUtil.getToken(Context, String, String)(context, email, scope);
+ // Do work with token.
+ ...
+ if (server indicates token is invalid) {
+ // invalidate the token that we found is bad so that GoogleAuthUtil won't
+ // return it next time (it may have cached it)
+ GoogleAuthUtil.invalidateToken(Context, String)(context, token);
+ // consider retrying getAndUseTokenBlocking() once more
+ return;
+ }
+ return;
+ } catch (GooglePlayServicesAvailabilityException playEx) {
+ Dialog alert = GooglePlayServicesUtil.getErrorDialog(
+ playEx.getConnectionStatusCode(),
+ this,
+ MY_ACTIVITYS_AUTH_REQUEST_CODE);
+ ...
+ } catch (UserRecoverableAuthException userAuthEx) {
+ // Start the user recoverable action using the intent returned by
+ // getIntent()
+ myActivity.startActivityForResult(
+ userAuthEx.getIntent(),
+ MY_ACTIVITYS_AUTH_REQUEST_CODE);
+ return;
+ } catch (IOException transientEx) {
+ // network or server error, the call is expected to succeed if you try again later.
+ // Don't attempt to call again immediately - the request is likely to
+ // fail, you'll hit quotas or back-off.
+ ...
+ return;
+ } catch (GoogleAuthException authEx) {
+ // Failure. The call is not expected to ever succeed so it should not be
+ // retried.
+ ...
+ return;
+ }
+ }
+
+ // Example of how to use AsyncTask to call blocking code on a background thread.
+ void getAndUseAuthTokenInAsyncTask() {
+ AsyncTask task = new AsyncTask() {
+ @Override
+ protected Void doInBackground(Void... params) {
+ getAndUseAuthTokenBlocking();
+ }
+ };
+ task.execute((Void)null);
+ }
+
Authenticates the user and returns a valid Google authentication token,
+ or throws an exception if there was an error getting a token.
+
+ The exception thrown depends upon the underlying error and support for
+ recovery. IOExceptions will be thrown if the underlying error
+ might be solved by some intelligent retry strategy. Alternatively,
+ GoogleAuthExceptions represent a broad class of
+ Exceptions that cannot be recovered from programmatically. Some
+ may be fatal errors stemming from implementation errors while others may
+ require user intervention. UserRecoverableAuthExceptions are
+ GoogleAuthExceptions that provide Intents which can be used to
+ initiate any user intervention required to fix the underlying error. For
+ example, a UserRecoverableAuthExceptions intent might lead to a request
+ for a user's consent or present the user with a device policy manager
+ download screen. GooglePlayServicesAvailabilityExceptions are
+ UserRecoverableAuthExceptions along with a connection status code which
+ allows clients to create a localized Dialog using
+ getErrorDialog(int, android.app.Activity, int).
+ Finally, this method is blocking and shouldn't be called in the main
+ event thread. If so an IllegalStateException will be thrown.
+
+ Which exceptions should be handled and how depends on the context of the
+ code. For example in the case of an Activity where
+ the user is actively engaged:
+
+
+ String token;
+ try {
+ token = GoogleAuthUtil.getToken(context, accountName, scope);
+ } catch (GooglePlayServicesAvailabilityException playEx) {
+ Dialog dialog = GooglePlayServicesUtil.getErrorDialog(
+ playEx.getConnectionStatusCode(),
+ Activity.this,
+ AUTH_REQUEST_CODE);
+ // Use the dialog to present to the user.
+ } catch (UserRecoverableAutException recoverableException) {
+ Intent recoveryIntent = recoverableException.getIntent();
+ // Use the intent in a custom dialog or just startActivityForResult.
+ } catch (GoogleAuthException authEx) {
+ // This is likely unrecoverable.
+ Log.e(TAG, "Unrecoverable authentication exception: " + authEx.getMesssage(), authEx);
+ } catch (IOException ioEx) {
+ Log.i(TAG, "transient error encountered: " + ioEx.getMessage());
+ doExponentialBackoff();
+ }
+
Authenticates the user and returns a valid Google authentication token, or throws an
+ Exception if there was an error while getting the token.
+
+ The exception thrown depends upon the underlying error and support for
+ recovery. IOExceptions will be thrown if the underlying error
+ might be solved by some intelligent retry strategy. Alternatively,
+ GoogleAuthExceptions represent a broad class of
+ Exceptions that cannot be recovered from programmatically. Some
+ may be fatal errors stemming from implementation errors while others may
+ require user intervention. UserRecoverableAuthExceptions are
+ GoogleAuthExceptions that provide Intents which can be used to
+ initiate any user intervention required to fix the underlying error. For
+ example, a UserRecoverableAuthExceptions intent might lead to a request
+ for a user's consent or present the user with a device policy manager
+ download screen. GooglePlayServicesAvailabilityExceptions are
+ UserRecoverableAuthExceptions along with a connection status code which
+ allows clients to create a localized Dialog using
+ getErrorDialog(int, android.app.Activity, int).
+ Finally, this method is blocking and shouldn't be called in the main
+ event thread. If so an IllegalStateException will be thrown.
+
+ Which exceptions should be handled and how depends on the context of the
+ code. For example in the case of an Activity where
+ the user is actively engaged:
+
+
+ String token;
+ try {
+ token = GoogleAuthUtil.getToken(context, accountName, scope, bundle);
+ } catch (GooglePlayServicesAvailabilityException playEx) {
+ Dialog dialog = GooglePlayServicesUtil.getErrorDialog(
+ playEx.getConnectionStatusCode(),
+ Activity.this,
+ AUTH_REQUEST_CODE);
+ // Use the dialog to present to the user.
+ } catch (UserRecoverableAutException recoverableException) {
+ Intent recoveryIntent = recoverableException.getIntent();
+ // Use the intent in a custom dialog or just startActivityForResult.
+ } catch (GoogleAuthException authEx) {
+ // This is likely unrecoverable.
+ Log.e(TAG, "Unrecoverable authentication exception: " + authEx.getMesssage(), authEx);
+ } catch (IOException ioEx) {
+ Log.i(TAG, "transient error encountered: " + ioEx.getMessage());
+ doExponentialBackoff();
+ }
+
Authenticates the user and returns a valid Google authentication token, or throws an
+ Exception if there was an error while getting the token.
+
+ This method is specifically provided for background tasks. In the event of an error that
+ needs user intervention, this method takes care of pushing relevant notification.
+
+ The exception thrown depends upon the underlying error and support for
+ recovery. UserRecoverableNotifiedException will be thrown if the error can be
+ resolved by user intervention and a notification has already been posted to address it.
+ IOExceptions will be thrown if the underlying error
+ might be solved by some intelligent retry strategy. Alternatively,
+ GoogleAuthExceptions represent a broad class of
+ Exceptions that cannot be recovered programmatically.
+
+
Authenticates the user and returns a valid Google authentication token, or throws an
+ Exception if there was an error while getting the token.
+
+ This method is specifically provided for background tasks. In the event of an error that
+ needs user intervention, this method takes care of pushing relevant notification. After the
+ user addresses the notification, the callback is broadcasted. If the user cancels then the
+ callback is not fired.
+
+ The exception thrown depends upon the underlying error and support for
+ recovery. UserRecoverableNotifiedException will be thrown if the error can be
+ resolved by user intervention and a notification has already been posted to address it.
+ IOExceptions will be thrown if the underlying error
+ might be solved by some intelligent retry strategy. Alternatively,
+ GoogleAuthExceptions represent a broad class of
+ Exceptions that cannot be recovered programmatically.
+
+
String representing the authenticating user account.
+
+
+
scope
+
String representing the authentication scope.
+
+
+
extras
+
Bundle containing additional information that may be
+ relevant to the authentication scope.
+
+
+
callback
+
A broadcast intent with a valid receiver that has been exported for other
+ apps to send broadcasts to it. This intent must be serializable using
+ toUri(Intent.URI_INTENT_SCHEME) and Intent.parseUri(intentUri, Intent.URI_INTENT_SCHEME).
+ Cannot be null.
Authenticates the user and returns a valid Google authentication token, or throws an
+ Exception if there was an error while getting the token.
+
+ This method is specifically provided for sync adaptors. In the event of an error that
+ needs user intervention, this method takes care of pushing relevant notification. After the
+ user addresses the notification, a sync request will be kicked off using the given params.
+ If the user cancels then the sync is not fired.
+
+ The exception thrown depends upon the underlying error and support for
+ recovery. UserRecoverableNotifiedException will be thrown if the error can be
+ resolved by user intervention and a notification has already been posted to address it.
+ IOExceptions will be thrown if the underlying error
+ might be solved by some intelligent retry strategy. Alternatively,
+ GoogleAuthExceptions represent a broad class of
+ Exceptions that cannot be recovered programmatically.
+
+
String representing the authenticating user account.
+
+
+
scope
+
String representing the authentication scope.
+
+
+
extras
+
Bundle containing additional information that may be
+ relevant to the authentication scope.
+
+
+
authority
+
Authority for firing a sync request. Must not be empty or null.
+
+
+
syncBundle
+
extras for firing a sync request. This bundle must pass
+ ContentResolver.validateSyncExtrasBundle(). If no extras are needed can a null value
+ can be passed.
GooglePlayServicesAvailabilityExceptions are special instances of
+ UserRecoverableAuthExceptions which are thrown when the expected Google Play services app
+ is not available for some reason. In these cases client code can use
+ getConnectionStatusCode() in conjunction with
+ getErrorDialog(int, android.app.Activity, int)
+ to provide users with a localized Dialog that will allow users to install,
+ update, or otherwise enable Google Play services.
+
GooglePlayServicesAvailabilityExceptions are special instances of
+ UserRecoverableAuthExceptions which are thrown when the expected Google Play services app
+ is not available for some reason.
+
+
+
+
+
+
+
+
+
+
+
+
+
Class Overview
+
UserRecoverableAuthExceptions signal Google authentication errors that can be recovered with user
+ action, such as a user login.
+
UserRecoverableNotifiedException signals that there was a Google authentication error which can
+ be recovered with user action and has been handled by publishing a notification for the user
+ to act on.
+
GooglePlayServicesAvailabilityExceptions are special instances of
+ UserRecoverableAuthExceptions which are thrown when the expected Google Play services app
+ is not available for some reason.
UserRecoverableNotifiedException signals that there was a Google authentication error which can
+ be recovered with user action and has been handled by publishing a notification for the user
+ to act on.
Returns an intent to an Activity that prompts the user to choose from a list of
+ accounts.
+ The caller will then typically start the activity by calling
+ startActivityForResult(intent, ...);.
+
+ On success the activity returns a Bundle with the account name and type specified using
+ keys KEY_ACCOUNT_NAME and KEY_ACCOUNT_TYPE.
+
+ The most common case is to call this with one account type, e.g.:
+
+
+ The account picker activity will return when use has selected and/or created an account,
+ and the resulting account name can be retrieved as follows:
+
+ protected void onActivityResult(final int requestCode, final int resultCode,
+ final Intent data) {
+ if (requestCode == SOME_REQUEST_CODE && resultCode == RESULT_OK) {
+ String accountName = data.getStringExtra(AccountManager.KEY_ACCOUNT_NAME);
+ }
+ }
+
+
+
Parameters
+
+
+
selectedAccount
+
if specified, indicates that the Account is the currently
+ selected one, according to the caller's definition of selected.
+
+
+
allowableAccounts
+
an optional ArrayList of accounts that are allowed to be
+ shown. If not specified then this field will not limit the displayed accounts.
+
+
+
allowableAccountTypes
+
an optional string array of account types. These are used
+ both to filter the shown accounts and to filter the list of account types that are shown
+ when adding an account.
+
+
+
alwaysPromptForAccount
+
if set the account chooser screen is always shown, otherwise
+ it is only shown when there is more than one account from which to choose
+
+
+
descriptionOverrideText
+
if non-null this string is used as the description in the
+ accounts chooser screen rather than the default
+ 