java/com/google/ipc/invalidation/ticl/android/AndroidC2DMConstants.java

/*
 * Copyright 2011 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.ipc.invalidation.ticl.android;

/**
 * Defines constants related to Invalidation C2DM messages.
 *
 */
public class AndroidC2DMConstants {

  /**
   * The default account name associated with delivered C2DM messages.  Alternate sender IDs
   * may be used when sharing C2DM within an application.
   */
  public static final String SENDER_ID = "ipc.invalidation@gmail.com";

  /**
   * The prefix that is added to data items when C2DM messages are generated.  This prefix
   * <b>does not</b> appear on the data items in the received C2DM intent extra bundle.
   */
  public static final String DATA_PREFIX = "data.";

  /** Name of C2DM parameter containing the client key. */
  public static final String CLIENT_KEY_PARAM = "tid";

  /**
   * Name of C2DM parameter containing message content.  If not set, data is not present. (We drop
   * it if it is too big.)
   */
  public static final String CONTENT_PARAM = "content";

  /** Name of the C2DM parameter containing an opaque token to be echoed on HTTP requests. */
  public static final String ECHO_PARAM = "echo-token";
}