Index

A B C D E F G I J L M N P R S T U V

A

addData(String, String) - Method in class com.google.android.gcm.server.Message.Builder: Adds a key/value pair to the payload data.
addParameter(StringBuilder, String, String) - Static method in class com.google.android.gcm.server.Sender: Adds a new parameter to the HTTP POST body.
addResult(Result) - Method in class com.google.android.gcm.server.MulticastResult.Builder

B

BACKOFF_INITIAL_DELAY - Static variable in class com.google.android.gcm.server.Sender: Initial delay before first retry, without jitter.
badge(int) - Method in class com.google.android.gcm.server.Notification.Builder: Sets the badge property.
body(String) - Method in class com.google.android.gcm.server.Notification.Builder: Sets the body property.
bodyLocArgs(List<String>) - Method in class com.google.android.gcm.server.Notification.Builder: Sets the body localization values property.
bodyLocKey(String) - Method in class com.google.android.gcm.server.Notification.Builder: Sets the body localization key property.
build() - Method in class com.google.android.gcm.server.Message.Builder
build() - Method in class com.google.android.gcm.server.MulticastResult.Builder
build() - Method in class com.google.android.gcm.server.Notification.Builder
build() - Method in class com.google.android.gcm.server.Result.Builder

C

canonicalRegistrationId(String) - Method in class com.google.android.gcm.server.Result.Builder
clickAction(String) - Method in class com.google.android.gcm.server.Notification.Builder: Sets the click action property.
collapseKey(String) - Method in class com.google.android.gcm.server.Message.Builder: Sets the collapseKey property.
color(String) - Method in class com.google.android.gcm.server.Notification.Builder: Sets the color property in #rrggbb format.
com.google.android.gcm.server - package com.google.android.gcm.server
Constants - Class in com.google.android.gcm.server: Constants used on GCM service communication.

D

delayWhileIdle(boolean) - Method in class com.google.android.gcm.server.Message.Builder: Sets the delayWhileIdle property (default value is false).
dryRun(boolean) - Method in class com.google.android.gcm.server.Message.Builder: Sets the dryRun property (default value is false).

E

ERROR_DEVICE_QUOTA_EXCEEDED - Static variable in class com.google.android.gcm.server.Constants: Too many messages sent by the sender to a specific device.
ERROR_INTERNAL_SERVER_ERROR - Static variable in class com.google.android.gcm.server.Constants: A particular message could not be sent because the GCM servers encountered an error.
ERROR_INVALID_REGISTRATION - Static variable in class com.google.android.gcm.server.Constants: Bad registration_id.
ERROR_INVALID_TTL - Static variable in class com.google.android.gcm.server.Constants: Time to Live value passed is less than zero or more than maximum.
ERROR_MESSAGE_TOO_BIG - Static variable in class com.google.android.gcm.server.Constants: The payload of the message is too big, see the limitations.
ERROR_MISMATCH_SENDER_ID - Static variable in class com.google.android.gcm.server.Constants: The sender_id contained in the registration_id does not match the sender_id used to register with the GCM servers.
ERROR_MISSING_COLLAPSE_KEY - Static variable in class com.google.android.gcm.server.Constants: Collapse key is required.
ERROR_MISSING_REGISTRATION - Static variable in class com.google.android.gcm.server.Constants: Missing registration_id.
ERROR_NOT_REGISTERED - Static variable in class com.google.android.gcm.server.Constants: The user has uninstalled the application or turned off notifications.
ERROR_QUOTA_EXCEEDED - Static variable in class com.google.android.gcm.server.Constants: Too many messages sent by the sender.
ERROR_UNAVAILABLE - Static variable in class com.google.android.gcm.server.Constants: A particular message could not be sent because the GCM servers were not available.
errorCode(String) - Method in class com.google.android.gcm.server.Result.Builder

F

failedRegistrationIds(List<String>) - Method in class com.google.android.gcm.server.Result.Builder
failure(Integer) - Method in class com.google.android.gcm.server.Result.Builder

G

GCM_SEND_ENDPOINT - Static variable in class com.google.android.gcm.server.Constants: Endpoint for sending messages.
getBadge() - Method in class com.google.android.gcm.server.Notification: Gets the badge.
getBody() - Method in class com.google.android.gcm.server.Notification: Gets the body.
getBodyLocArgs() - Method in class com.google.android.gcm.server.Notification: Gets the body localization values list, which is immutable.
getBodyLocKey() - Method in class com.google.android.gcm.server.Notification: Gets the body localization key.
getCanonicalIds() - Method in class com.google.android.gcm.server.MulticastResult: Gets the number of successful messages that also returned a canonical registration id.
getCanonicalRegistrationId() - Method in class com.google.android.gcm.server.Result: Gets the canonical registration id, if any.
getClickAction() - Method in class com.google.android.gcm.server.Notification: Gets the click action.
getCollapseKey() - Method in class com.google.android.gcm.server.Message: Gets the collapse key.
getColor() - Method in class com.google.android.gcm.server.Notification: Gets the color.
getConnection(String) - Method in class com.google.android.gcm.server.Sender: Gets an HttpURLConnection given an URL.
getData() - Method in class com.google.android.gcm.server.Message: Gets the payload data, which is immutable.
getDescription() - Method in exception com.google.android.gcm.server.InvalidRequestException: Gets the error description.
getErrorCodeName() - Method in class com.google.android.gcm.server.Result: Gets the error code, if any.
getFailedRegistrationIds() - Method in class com.google.android.gcm.server.Result
getFailure() - Method in class com.google.android.gcm.server.MulticastResult: Gets the number of failed messages.
getFailure() - Method in class com.google.android.gcm.server.Result
getHttpStatusCode() - Method in exception com.google.android.gcm.server.InvalidRequestException: Gets the HTTP Status Code.
getIcon() - Method in class com.google.android.gcm.server.Notification: Gets the icon.
getMessageId() - Method in class com.google.android.gcm.server.Result: Gets the message id, if any.
getMulticastId() - Method in class com.google.android.gcm.server.MulticastResult: Gets the multicast id.
getNotification() - Method in class com.google.android.gcm.server.Message: Gets notification payload, which is immutable.
getPriority() - Method in class com.google.android.gcm.server.Message: Gets the message priority value.
getRestrictedPackageName() - Method in class com.google.android.gcm.server.Message: Gets the restricted package name.
getResults() - Method in class com.google.android.gcm.server.MulticastResult: Gets the results of each individual message, which is immutable.
getRetryMulticastIds() - Method in class com.google.android.gcm.server.MulticastResult: Gets additional ids if more than one multicast message was sent.
getSound() - Method in class com.google.android.gcm.server.Notification: Gets the sound.
getString(InputStream) - Static method in class com.google.android.gcm.server.Sender: Convenience method to convert an InputStream to a String.
getSuccess() - Method in class com.google.android.gcm.server.MulticastResult: Gets the number of successful messages.
getSuccess() - Method in class com.google.android.gcm.server.Result
getTag() - Method in class com.google.android.gcm.server.Notification: Gets the tag.
getTimeToLive() - Method in class com.google.android.gcm.server.Message: Gets the time to live (in seconds).
getTitle() - Method in class com.google.android.gcm.server.Notification: Gets the title.
getTitleLocArgs() - Method in class com.google.android.gcm.server.Notification: Gets the title localization values list, which is immutable.
getTitleLocKey() - Method in class com.google.android.gcm.server.Notification: Gets the title localization key.
getTotal() - Method in class com.google.android.gcm.server.MulticastResult: Gets the total number of messages sent, regardless of the status.

I

InvalidRequestException - Exception in com.google.android.gcm.server: Exception thrown when GCM returned an error due to an invalid request.
InvalidRequestException(int) - Constructor for exception com.google.android.gcm.server.InvalidRequestException
InvalidRequestException(int, String) - Constructor for exception com.google.android.gcm.server.InvalidRequestException
isDelayWhileIdle() - Method in class com.google.android.gcm.server.Message: Gets the delayWhileIdle flag.
isDryRun() - Method in class com.google.android.gcm.server.Message: Gets the dryRun flag.

J

JSON_CANONICAL_IDS - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the number of messages with a canonical registration id.
JSON_ERROR - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the error field of an individual request.
JSON_FAILURE - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the number of failed messages.
JSON_MESSAGE_ID - Static variable in class com.google.android.gcm.server.Constants: JSON-only field sent by GCM when a message was successfully sent.
JSON_MULTICAST_ID - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the id of the multicast request.
JSON_NOTIFICATION - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the notification payload.
JSON_NOTIFICATION_BADGE - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the notification badge.
JSON_NOTIFICATION_BODY - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the notification body.
JSON_NOTIFICATION_BODY_LOC_ARGS - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the notification body localization values.
JSON_NOTIFICATION_BODY_LOC_KEY - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the notification body localization key.
JSON_NOTIFICATION_CLICK_ACTION - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the notification click action.
JSON_NOTIFICATION_COLOR - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the notification color.
JSON_NOTIFICATION_ICON - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the notification icon.
JSON_NOTIFICATION_SOUND - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the notification sound.
JSON_NOTIFICATION_TAG - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the notification tag.
JSON_NOTIFICATION_TITLE - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the notification title.
JSON_NOTIFICATION_TITLE_LOC_ARGS - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the notification title localization values.
JSON_NOTIFICATION_TITLE_LOC_KEY - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the notification title localization key.
JSON_PAYLOAD - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the payload data.
JSON_REGISTRATION_IDS - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the registration ids.
JSON_RESULTS - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the result of each individual request.
JSON_SUCCESS - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the number of successful messages.
JSON_TO - Static variable in class com.google.android.gcm.server.Constants: JSON-only field representing the to recipient.

L

logger - Static variable in class com.google.android.gcm.server.Sender

M

MAX_BACKOFF_DELAY - Static variable in class com.google.android.gcm.server.Sender: Maximum delay before a retry.
Message - Class in com.google.android.gcm.server: GCM message.
Message.Builder - Class in com.google.android.gcm.server
Message.Builder() - Constructor for class com.google.android.gcm.server.Message.Builder
Message.Priority - Enum in com.google.android.gcm.server
MESSAGE_PRIORITY_HIGH - Static variable in class com.google.android.gcm.server.Constants: Value used to set message priority to high.
MESSAGE_PRIORITY_NORMAL - Static variable in class com.google.android.gcm.server.Constants: Value used to set message priority to normal.
messageId(String) - Method in class com.google.android.gcm.server.Result.Builder
MulticastResult - Class in com.google.android.gcm.server: Result of a GCM multicast message request .
MulticastResult.Builder - Class in com.google.android.gcm.server
MulticastResult.Builder(int, int, int, long) - Constructor for class com.google.android.gcm.server.MulticastResult.Builder

N

newBody(String, String) - Static method in class com.google.android.gcm.server.Sender: Creates a StringBuilder to be used as the body of an HTTP POST.
newKeyValues(String, String) - Static method in class com.google.android.gcm.server.Sender: Creates a map with just one key-value pair.
notification(Notification) - Method in class com.google.android.gcm.server.Message.Builder: Sets the notification property.
Notification - Class in com.google.android.gcm.server: GCM message notification part.
Notification.Builder - Class in com.google.android.gcm.server
Notification.Builder(String) - Constructor for class com.google.android.gcm.server.Notification.Builder

P

PARAM_COLLAPSE_KEY - Static variable in class com.google.android.gcm.server.Constants: HTTP parameter for collapse key.
PARAM_DELAY_WHILE_IDLE - Static variable in class com.google.android.gcm.server.Constants: HTTP parameter for delaying the message delivery if the device is idle.
PARAM_DRY_RUN - Static variable in class com.google.android.gcm.server.Constants: HTTP parameter for telling gcm to validate the message without actually sending it.
PARAM_PAYLOAD_PREFIX - Static variable in class com.google.android.gcm.server.Constants: Prefix to HTTP parameter used to pass key-values in the message payload.
PARAM_PRIORITY - Static variable in class com.google.android.gcm.server.Constants: Parameter used to set the message priority.
PARAM_REGISTRATION_ID - Static variable in class com.google.android.gcm.server.Constants: HTTP parameter for registration id.
PARAM_RESTRICTED_PACKAGE_NAME - Static variable in class com.google.android.gcm.server.Constants: 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.
PARAM_TIME_TO_LIVE - Static variable in class com.google.android.gcm.server.Constants: Parameter used to set the message time-to-live.
PARAM_TO - Static variable in class com.google.android.gcm.server.Constants: Parameter for to field.
post(String, String) - Method in class com.google.android.gcm.server.Sender: Make an HTTP post to a given URL.
post(String, String, String) - Method in class com.google.android.gcm.server.Sender: Makes an HTTP POST request to a given endpoint.
priority(Message.Priority) - Method in class com.google.android.gcm.server.Message.Builder: Sets the priority property.

R

random - Variable in class com.google.android.gcm.server.Sender
restrictedPackageName(String) - Method in class com.google.android.gcm.server.Message.Builder: Sets the restrictedPackageName property.
Result - Class in com.google.android.gcm.server: Result of a GCM message request that returned HTTP status code 200.
Result.Builder - Class in com.google.android.gcm.server
Result.Builder() - Constructor for class com.google.android.gcm.server.Result.Builder
retryMulticastIds(List<Long>) - Method in class com.google.android.gcm.server.MulticastResult.Builder

S

send(Message, String, int) - Method in class com.google.android.gcm.server.Sender: Sends a message to one device, retrying in case of unavailability.
send(Message, List<String>, int) - Method in class com.google.android.gcm.server.Sender: Sends a message to many devices, retrying in case of unavailability.
Sender - Class in com.google.android.gcm.server: Helper class to send messages to the GCM service using an API Key.
Sender(String) - Constructor for class com.google.android.gcm.server.Sender: Default constructor.
sendNoRetry(Message, String) - Method in class com.google.android.gcm.server.Sender: Sends a message without retrying in case of service unavailability.
sendNoRetry(Message, List<String>) - Method in class com.google.android.gcm.server.Sender: Sends a message without retrying in case of service unavailability.
sound(String) - Method in class com.google.android.gcm.server.Notification.Builder: Sets the sound property (default value is default).
success(Integer) - Method in class com.google.android.gcm.server.Result.Builder

T

tag(String) - Method in class com.google.android.gcm.server.Notification.Builder: Sets the tag property.
timeToLive(int) - Method in class com.google.android.gcm.server.Message.Builder: Sets the time to live, in seconds.
title(String) - Method in class com.google.android.gcm.server.Notification.Builder: Sets the title property.
titleLocArgs(List<String>) - Method in class com.google.android.gcm.server.Notification.Builder: Sets the title localization values property.
titleLocKey(String) - Method in class com.google.android.gcm.server.Notification.Builder: Sets the title localization key property.
TOKEN_CANONICAL_REG_ID - Static variable in class com.google.android.gcm.server.Constants: Token returned by GCM when the requested registration id has a canonical value.
TOKEN_ERROR - Static variable in class com.google.android.gcm.server.Constants: Token returned by GCM when there was an error sending a message.
TOKEN_MESSAGE_ID - Static variable in class com.google.android.gcm.server.Constants: Token returned by GCM when a message was successfully sent.
TOPIC_PREFIX - Static variable in class com.google.android.gcm.server.Constants: Prefix of the topic.
toString() - Method in class com.google.android.gcm.server.Message
toString() - Method in class com.google.android.gcm.server.MulticastResult
toString() - Method in class com.google.android.gcm.server.Notification
toString() - Method in class com.google.android.gcm.server.Result

U

UTF8 - Static variable in class com.google.android.gcm.server.Sender

V

valueOf(String) - Static method in enum com.google.android.gcm.server.Message.Priority: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.google.android.gcm.server.Message.Priority: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G I J L M N P R S T U V