Constants

java.lang.Object
- com.google.android.gcm.server.Constants

public final class Constants
extends java.lang.Object

Constants used on GCM service communication.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ERROR_DEVICE_QUOTA_EXCEEDED` Too many messages sent by the sender to a specific device.
`static java.lang.String`	`ERROR_INTERNAL_SERVER_ERROR` A particular message could not be sent because the GCM servers encountered an error.
`static java.lang.String`	`ERROR_INVALID_REGISTRATION` Bad registration_id.
`static java.lang.String`	`ERROR_INVALID_TTL` Time to Live value passed is less than zero or more than maximum.
`static java.lang.String`	`ERROR_MESSAGE_TOO_BIG` The payload of the message is too big, see the limitations.
`static java.lang.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.
`static java.lang.String`	`ERROR_MISSING_COLLAPSE_KEY` Collapse key is required.
`static java.lang.String`	`ERROR_MISSING_REGISTRATION` Missing registration_id.
`static java.lang.String`	`ERROR_NOT_REGISTERED` The user has uninstalled the application or turned off notifications.
`static java.lang.String`	`ERROR_QUOTA_EXCEEDED` Too many messages sent by the sender.
`static java.lang.String`	`ERROR_UNAVAILABLE` A particular message could not be sent because the GCM servers were not available.
`static java.lang.String`	`GCM_SEND_ENDPOINT` Endpoint for sending messages.
`static java.lang.String`	`JSON_CANONICAL_IDS` JSON-only field representing the number of messages with a canonical registration id.
`static java.lang.String`	`JSON_ERROR` JSON-only field representing the error field of an individual request.
`static java.lang.String`	`JSON_FAILURE` JSON-only field representing the number of failed messages.
`static java.lang.String`	`JSON_MESSAGE_ID` JSON-only field sent by GCM when a message was successfully sent.
`static java.lang.String`	`JSON_MULTICAST_ID` JSON-only field representing the id of the multicast request.
`static java.lang.String`	`JSON_NOTIFICATION` JSON-only field representing the notification payload.
`static java.lang.String`	`JSON_NOTIFICATION_BADGE` JSON-only field representing the notification badge.
`static java.lang.String`	`JSON_NOTIFICATION_BODY` JSON-only field representing the notification body.
`static java.lang.String`	`JSON_NOTIFICATION_BODY_LOC_ARGS` JSON-only field representing the notification body localization values.
`static java.lang.String`	`JSON_NOTIFICATION_BODY_LOC_KEY` JSON-only field representing the notification body localization key.
`static java.lang.String`	`JSON_NOTIFICATION_CLICK_ACTION` JSON-only field representing the notification click action.
`static java.lang.String`	`JSON_NOTIFICATION_COLOR` JSON-only field representing the notification color.
`static java.lang.String`	`JSON_NOTIFICATION_ICON` JSON-only field representing the notification icon.
`static java.lang.String`	`JSON_NOTIFICATION_SOUND` JSON-only field representing the notification sound.
`static java.lang.String`	`JSON_NOTIFICATION_TAG` JSON-only field representing the notification tag.
`static java.lang.String`	`JSON_NOTIFICATION_TITLE` JSON-only field representing the notification title.
`static java.lang.String`	`JSON_NOTIFICATION_TITLE_LOC_ARGS` JSON-only field representing the notification title localization values.
`static java.lang.String`	`JSON_NOTIFICATION_TITLE_LOC_KEY` JSON-only field representing the notification title localization key.
`static java.lang.String`	`JSON_PAYLOAD` JSON-only field representing the payload data.
`static java.lang.String`	`JSON_REGISTRATION_IDS` JSON-only field representing the registration ids.
`static java.lang.String`	`JSON_RESULTS` JSON-only field representing the result of each individual request.
`static java.lang.String`	`JSON_SUCCESS` JSON-only field representing the number of successful messages.
`static java.lang.String`	`JSON_TO` JSON-only field representing the to recipient.
`static java.lang.String`	`MESSAGE_PRIORITY_HIGH` Value used to set message priority to high.
`static java.lang.String`	`MESSAGE_PRIORITY_NORMAL` Value used to set message priority to normal.
`static java.lang.String`	`PARAM_COLLAPSE_KEY` HTTP parameter for collapse key.
`static java.lang.String`	`PARAM_DELAY_WHILE_IDLE` HTTP parameter for delaying the message delivery if the device is idle.
`static java.lang.String`	`PARAM_DRY_RUN` HTTP parameter for telling gcm to validate the message without actually sending it.
`static java.lang.String`	`PARAM_PAYLOAD_PREFIX` Prefix to HTTP parameter used to pass key-values in the message payload.
`static java.lang.String`	`PARAM_PRIORITY` Parameter used to set the message priority.
`static java.lang.String`	`PARAM_REGISTRATION_ID` HTTP parameter for registration id.
`static java.lang.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.
`static java.lang.String`	`PARAM_TIME_TO_LIVE` Parameter used to set the message time-to-live.
`static java.lang.String`	`PARAM_TO` Parameter for to field.
`static java.lang.String`	`TOKEN_CANONICAL_REG_ID` Token returned by GCM when the requested registration id has a canonical value.
`static java.lang.String`	`TOKEN_ERROR` Token returned by GCM when there was an error sending a message.
`static java.lang.String`	`TOKEN_MESSAGE_ID` Token returned by GCM when a message was successfully sent.
`static java.lang.String`	`TOPIC_PREFIX` Prefix of the topic.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - GCM_SEND_ENDPOINT
```
public static final java.lang.String GCM_SEND_ENDPOINT
```
    Endpoint for sending messages.
    
    See Also:
    Constant Field Values
  - PARAM_TO
```
public static final java.lang.String PARAM_TO
```
    Parameter for to field.
    
    See Also:
    Constant Field Values
  - TOPIC_PREFIX
```
public static final java.lang.String TOPIC_PREFIX
```
    Prefix of the topic.
    
    See Also:
    Constant Field Values
  - PARAM_REGISTRATION_ID
```
public static final java.lang.String PARAM_REGISTRATION_ID
```
    HTTP parameter for registration id.
    
    See Also:
    Constant Field Values
  - PARAM_COLLAPSE_KEY
```
public static final java.lang.String PARAM_COLLAPSE_KEY
```
    HTTP parameter for collapse key.
    
    See Also:
    Constant Field Values
  - PARAM_DELAY_WHILE_IDLE
```
public static final java.lang.String PARAM_DELAY_WHILE_IDLE
```
    HTTP parameter for delaying the message delivery if the device is idle.
    
    See Also:
    Constant Field Values
  - PARAM_DRY_RUN
```
public static final java.lang.String PARAM_DRY_RUN
```
    HTTP parameter for telling gcm to validate the message without actually sending it.
    
    See Also:
    Constant Field Values
  - PARAM_RESTRICTED_PACKAGE_NAME
```
public static final java.lang.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.
    
    See Also:
    Constant Field Values
  - PARAM_PAYLOAD_PREFIX
```
public static final java.lang.String PARAM_PAYLOAD_PREFIX
```
    Prefix to HTTP parameter used to pass key-values in the message payload.
    
    See Also:
    Constant Field Values
  - PARAM_TIME_TO_LIVE
```
public static final java.lang.String PARAM_TIME_TO_LIVE
```
    Parameter used to set the message time-to-live.
    
    See Also:
    Constant Field Values
  - PARAM_PRIORITY
```
public static final java.lang.String PARAM_PRIORITY
```
    Parameter used to set the message priority.
    
    See Also:
    Constant Field Values
  - MESSAGE_PRIORITY_NORMAL
```
public static final java.lang.String MESSAGE_PRIORITY_NORMAL
```
    Value used to set message priority to normal.
    
    See Also:
    Constant Field Values
  - MESSAGE_PRIORITY_HIGH
```
public static final java.lang.String MESSAGE_PRIORITY_HIGH
```
    Value used to set message priority to high.
    
    See Also:
    Constant Field Values
  - ERROR_QUOTA_EXCEEDED
```
public static final java.lang.String ERROR_QUOTA_EXCEEDED
```
    Too many messages sent by the sender. Retry after a while.
    
    See Also:
    Constant Field Values
  - ERROR_DEVICE_QUOTA_EXCEEDED
```
public static final java.lang.String ERROR_DEVICE_QUOTA_EXCEEDED
```
    Too many messages sent by the sender to a specific device. Retry after a while.
    
    See Also:
    Constant Field Values
  - ERROR_MISSING_REGISTRATION
```
public static final java.lang.String ERROR_MISSING_REGISTRATION
```
    Missing registration_id. Sender should always add the registration_id to the request.
    
    See Also:
    Constant Field Values
  - ERROR_INVALID_REGISTRATION
```
public static final java.lang.String ERROR_INVALID_REGISTRATION
```
    Bad registration_id. Sender should remove this registration_id.
    
    See Also:
    Constant Field Values
  - ERROR_MISMATCH_SENDER_ID
```
public static final java.lang.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.
    
    See Also:
    Constant Field Values
  - ERROR_NOT_REGISTERED
```
public static final java.lang.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.
    
    See Also:
    Constant Field Values
  - ERROR_MESSAGE_TOO_BIG
```
public static final java.lang.String ERROR_MESSAGE_TOO_BIG
```
    The payload of the message is too big, see the limitations. Reduce the size of the message.
    
    See Also:
    Constant Field Values
  - ERROR_MISSING_COLLAPSE_KEY
```
public static final java.lang.String ERROR_MISSING_COLLAPSE_KEY
```
    Collapse key is required. Include collapse key in the request.
    
    See Also:
    Constant Field Values
  - ERROR_UNAVAILABLE
```
public static final java.lang.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.
    
    See Also:
    Constant Field Values
  - ERROR_INTERNAL_SERVER_ERROR
```
public static final java.lang.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.
    
    See Also:
    Constant Field Values
  - ERROR_INVALID_TTL
```
public static final java.lang.String ERROR_INVALID_TTL
```
    Time to Live value passed is less than zero or more than maximum.
    
    See Also:
    Constant Field Values
  - TOKEN_MESSAGE_ID
```
public static final java.lang.String TOKEN_MESSAGE_ID
```
    Token returned by GCM when a message was successfully sent.
    
    See Also:
    Constant Field Values
  - TOKEN_CANONICAL_REG_ID
```
public static final java.lang.String TOKEN_CANONICAL_REG_ID
```
    Token returned by GCM when the requested registration id has a canonical value.
    
    See Also:
    Constant Field Values
  - TOKEN_ERROR
```
public static final java.lang.String TOKEN_ERROR
```
    Token returned by GCM when there was an error sending a message.
    
    See Also:
    Constant Field Values
  - JSON_REGISTRATION_IDS
```
public static final java.lang.String JSON_REGISTRATION_IDS
```
    JSON-only field representing the registration ids.
    
    See Also:
    Constant Field Values
  - JSON_TO
```
public static final java.lang.String JSON_TO
```
    JSON-only field representing the to recipient.
    
    See Also:
    Constant Field Values
  - JSON_PAYLOAD
```
public static final java.lang.String JSON_PAYLOAD
```
    JSON-only field representing the payload data.
    
    See Also:
    Constant Field Values
  - JSON_NOTIFICATION
```
public static final java.lang.String JSON_NOTIFICATION
```
    JSON-only field representing the notification payload.
    
    See Also:
    Constant Field Values
  - JSON_NOTIFICATION_TITLE
```
public static final java.lang.String JSON_NOTIFICATION_TITLE
```
    JSON-only field representing the notification title.
    
    See Also:
    Constant Field Values
  - JSON_NOTIFICATION_BODY
```
public static final java.lang.String JSON_NOTIFICATION_BODY
```
    JSON-only field representing the notification body.
    
    See Also:
    Constant Field Values
  - JSON_NOTIFICATION_ICON
```
public static final java.lang.String JSON_NOTIFICATION_ICON
```
    JSON-only field representing the notification icon.
    
    See Also:
    Constant Field Values
  - JSON_NOTIFICATION_SOUND
```
public static final java.lang.String JSON_NOTIFICATION_SOUND
```
    JSON-only field representing the notification sound.
    
    See Also:
    Constant Field Values
  - JSON_NOTIFICATION_BADGE
```
public static final java.lang.String JSON_NOTIFICATION_BADGE
```
    JSON-only field representing the notification badge.
    
    See Also:
    Constant Field Values
  - JSON_NOTIFICATION_TAG
```
public static final java.lang.String JSON_NOTIFICATION_TAG
```
    JSON-only field representing the notification tag.
    
    See Also:
    Constant Field Values
  - JSON_NOTIFICATION_COLOR
```
public static final java.lang.String JSON_NOTIFICATION_COLOR
```
    JSON-only field representing the notification color.
    
    See Also:
    Constant Field Values
  - JSON_NOTIFICATION_CLICK_ACTION
```
public static final java.lang.String JSON_NOTIFICATION_CLICK_ACTION
```
    JSON-only field representing the notification click action.
    
    See Also:
    Constant Field Values
  - JSON_NOTIFICATION_BODY_LOC_KEY
```
public static final java.lang.String JSON_NOTIFICATION_BODY_LOC_KEY
```
    JSON-only field representing the notification body localization key.
    
    See Also:
    Constant Field Values
  - JSON_NOTIFICATION_BODY_LOC_ARGS
```
public static final java.lang.String JSON_NOTIFICATION_BODY_LOC_ARGS
```
    JSON-only field representing the notification body localization values.
    
    See Also:
    Constant Field Values
  - JSON_NOTIFICATION_TITLE_LOC_KEY
```
public static final java.lang.String JSON_NOTIFICATION_TITLE_LOC_KEY
```
    JSON-only field representing the notification title localization key.
    
    See Also:
    Constant Field Values
  - JSON_NOTIFICATION_TITLE_LOC_ARGS
```
public static final java.lang.String JSON_NOTIFICATION_TITLE_LOC_ARGS
```
    JSON-only field representing the notification title localization values.
    
    See Also:
    Constant Field Values
  - JSON_SUCCESS
```
public static final java.lang.String JSON_SUCCESS
```
    JSON-only field representing the number of successful messages.
    
    See Also:
    Constant Field Values
  - JSON_FAILURE
```
public static final java.lang.String JSON_FAILURE
```
    JSON-only field representing the number of failed messages.
    
    See Also:
    Constant Field Values
  - JSON_CANONICAL_IDS
```
public static final java.lang.String JSON_CANONICAL_IDS
```
    JSON-only field representing the number of messages with a canonical registration id.
    
    See Also:
    Constant Field Values
  - JSON_MULTICAST_ID
```
public static final java.lang.String JSON_MULTICAST_ID
```
    JSON-only field representing the id of the multicast request.
    
    See Also:
    Constant Field Values
  - JSON_RESULTS
```
public static final java.lang.String JSON_RESULTS
```
    JSON-only field representing the result of each individual request.
    
    See Also:
    Constant Field Values
  - JSON_ERROR
```
public static final java.lang.String JSON_ERROR
```
    JSON-only field representing the error field of an individual request.
    
    See Also:
    Constant Field Values
  - JSON_MESSAGE_ID
```
public static final java.lang.String JSON_MESSAGE_ID
```
    JSON-only field sent by GCM when a message was successfully sent.
    
    See Also:
    Constant Field Values

Class Constants

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GCM_SEND_ENDPOINT

PARAM_TO

TOPIC_PREFIX

PARAM_REGISTRATION_ID

PARAM_COLLAPSE_KEY

PARAM_DELAY_WHILE_IDLE

PARAM_DRY_RUN

PARAM_RESTRICTED_PACKAGE_NAME

PARAM_PAYLOAD_PREFIX

PARAM_TIME_TO_LIVE

PARAM_PRIORITY

MESSAGE_PRIORITY_NORMAL

MESSAGE_PRIORITY_HIGH

ERROR_QUOTA_EXCEEDED

ERROR_DEVICE_QUOTA_EXCEEDED

ERROR_MISSING_REGISTRATION

ERROR_INVALID_REGISTRATION

ERROR_MISMATCH_SENDER_ID

ERROR_NOT_REGISTERED

ERROR_MESSAGE_TOO_BIG

ERROR_MISSING_COLLAPSE_KEY

ERROR_UNAVAILABLE

ERROR_INTERNAL_SERVER_ERROR

ERROR_INVALID_TTL

TOKEN_MESSAGE_ID

TOKEN_CANONICAL_REG_ID

TOKEN_ERROR

JSON_REGISTRATION_IDS

JSON_TO

JSON_PAYLOAD

JSON_NOTIFICATION

JSON_NOTIFICATION_TITLE

JSON_NOTIFICATION_BODY

JSON_NOTIFICATION_ICON

JSON_NOTIFICATION_SOUND

JSON_NOTIFICATION_BADGE

JSON_NOTIFICATION_TAG

JSON_NOTIFICATION_COLOR

JSON_NOTIFICATION_CLICK_ACTION

JSON_NOTIFICATION_BODY_LOC_KEY

JSON_NOTIFICATION_BODY_LOC_ARGS

JSON_NOTIFICATION_TITLE_LOC_KEY

JSON_NOTIFICATION_TITLE_LOC_ARGS

JSON_SUCCESS

JSON_FAILURE

JSON_CANONICAL_IDS

JSON_MULTICAST_ID

JSON_RESULTS

JSON_ERROR

JSON_MESSAGE_ID