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

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.

B

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

Initial delay before first retry, without jitter.

build() - Method in class com.google.android.gcm.server.Message.Builder

C

collapseKey(String) - Method in class com.google.android.gcm.server.Message.Builder

Sets the collapseKey property.

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

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.

G

GCM_SEND_ENDPOINT - Static variable in class com.google.android.gcm.server.Constants

Endpoint for sending messages.

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.

getCollapseKey() - Method in class com.google.android.gcm.server.Message

Gets the collapse key.

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.

getFailure() - Method in class com.google.android.gcm.server.MulticastResult

Gets the number of failed messages.

getHttpStatusCode() - Method in exception com.google.android.gcm.server.InvalidRequestException

Gets the HTTP Status Code.

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.

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.

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.

getTimeToLive() - Method in class com.google.android.gcm.server.Message

Gets the time to live (in seconds).

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.

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

L

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

MulticastResult - Class in com.google.android.gcm.server

Result of a GCM multicast message request .

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.

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_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_REGISTRATION_ID - Static variable in class com.google.android.gcm.server.Constants

HTTP parameter for registration id.

PARAM_TIME_TO_LIVE - Static variable in class com.google.android.gcm.server.Constants

Prefix to HTTP parameter used to set the message time-to-live.

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

R

random - Variable in class com.google.android.gcm.server.Sender

Result - Class in com.google.android.gcm.server

Result of a GCM message request that returned HTTP status code 200.

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.

T

timeToLive(int) - Method in class com.google.android.gcm.server.Message.Builder

Sets the time to live, in seconds.

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.

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

U

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

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