Links
Android Sites
Language
| java.lang.Object | |
| ↳ | com.google.android.gcm.server.Constants |
Constants used on GCM service communication.
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | ERROR_DEVICE_QUOTA_EXCEEDED | Too many messages sent by the sender to a specific device. | |||||||||
| String | ERROR_INTERNAL_SERVER_ERROR | A particular message could not be sent because the GCM servers encountered an error. | |||||||||
| String | ERROR_INVALID_REGISTRATION | Bad registration_id. | |||||||||
| String | ERROR_INVALID_TTL | Time to Live value passed is less than zero or more than maximum. | |||||||||
| String | ERROR_MESSAGE_TOO_BIG | The payload of the message is too big, see the limitations. | |||||||||
| String | ERROR_MISMATCH_SENDER_ID | The sender_id contained in the registration_id does not match the sender_id used to register with the GCM servers. | |||||||||
| String | ERROR_MISSING_COLLAPSE_KEY | Collapse key is required. | |||||||||
| String | ERROR_MISSING_REGISTRATION | Missing registration_id. | |||||||||
| String | ERROR_NOT_REGISTERED | The user has uninstalled the application or turned off notifications. | |||||||||
| String | ERROR_QUOTA_EXCEEDED | Too many messages sent by the sender. | |||||||||
| String | ERROR_UNAVAILABLE | A particular message could not be sent because the GCM servers were not available. | |||||||||
| String | GCM_SEND_ENDPOINT | Endpoint for sending messages. | |||||||||
| String | JSON_CANONICAL_IDS | JSON-only field representing the number of messages with a canonical registration id. | |||||||||
| String | JSON_ERROR | JSON-only field representing the error field of an individual request. | |||||||||
| String | JSON_FAILURE | JSON-only field representing the number of failed messages. | |||||||||
| String | JSON_MESSAGE_ID | JSON-only field sent by GCM when a message was successfully sent. | |||||||||
| String | JSON_MULTICAST_ID | JSON-only field representing the id of the multicast request. | |||||||||
| String | JSON_PAYLOAD | JSON-only field representing the payload data. | |||||||||
| String | JSON_REGISTRATION_IDS | JSON-only field representing the registration ids. | |||||||||
| String | JSON_RESULTS | JSON-only field representing the result of each individual request. | |||||||||
| String | JSON_SUCCESS | JSON-only field representing the number of successful messages. | |||||||||
| String | PARAM_COLLAPSE_KEY | HTTP parameter for collapse key. | |||||||||
| String | PARAM_DELAY_WHILE_IDLE | HTTP parameter for delaying the message delivery if the device is idle. | |||||||||
| 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_TIME_TO_LIVE | Prefix to HTTP parameter used to set the message time-to-live. | |||||||||
| String | TOKEN_CANONICAL_REG_ID | Token returned by GCM when the requested registration id has a canonical value. | |||||||||
| String | TOKEN_ERROR | Token returned by GCM when there was an error sending a message. | |||||||||
| String | TOKEN_MESSAGE_ID | Token returned by GCM when a message was successfully sent. | |||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Too many messages sent by the sender to a specific device. Retry after a while.
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.
Bad registration_id. Sender should remove this registration_id.
Time to Live value passed is less than zero or more than maximum.
The payload of the message is too big, see the limitations. Reduce the size of the message.
The sender_id contained in the registration_id does not match the sender_id used to register with the GCM servers.
Collapse key is required. Include collapse key in the request.
Missing registration_id. Sender should always add the registration_id to the request.
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.
Too many messages sent by the sender. Retry after a while.
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.
Endpoint for sending messages.
JSON-only field representing the number of messages with a canonical registration id.
JSON-only field representing the error field of an individual request.
JSON-only field representing the number of failed messages.
JSON-only field sent by GCM when a message was successfully sent.
JSON-only field representing the id of the multicast request.
JSON-only field representing the payload data.
JSON-only field representing the registration ids.
JSON-only field representing the result of each individual request.
JSON-only field representing the number of successful messages.
HTTP parameter for collapse key.
HTTP parameter for delaying the message delivery if the device is idle.
Prefix to HTTP parameter used to pass key-values in the message payload.
HTTP parameter for registration id.
Prefix to HTTP parameter used to set the message time-to-live.
Token returned by GCM when the requested registration id has a canonical value.
Token returned by GCM when there was an error sending a message.
Token returned by GCM when a message was successfully sent.