com.google.android.gcm.server
Class Message

java.lang.Object
  com.google.android.gcm.server.Message

All Implemented Interfaces:

java.io.Serializable

public final class Message
extends java.lang.Object
implements java.io.Serializable

GCM message.

Instances of this class are immutable and should be created using a Message.Builder. Examples: Simplest message:

 Message message = new Message.Builder().build();
 

Message with optional attributes:

 Message message = new Message.Builder()
    .collapseKey(collapseKey)
    .timeToLive(3)
    .delayWhileIdle(true)
    .build();
 

Message with optional attributes and payload data:

 Message message = new Message.Builder()
    .collapseKey(collapseKey)
    .timeToLive(3)
    .delayWhileIdle(true)
    .addData("key1", "value1")
    .addData("key2", "value2")
    .build();
 

See Also:

Serialized Form

Nested Class Summary

static class

Message.Builder

Method Summary

java.lang.String	getCollapseKey() Gets the collapse key.
java.util.Map<java.lang.String,java.lang.String>	getData() Gets the payload data, which is immutable.
java.lang.Integer	getTimeToLive() Gets the time to live (in seconds).
java.lang.Boolean	isDelayWhileIdle() Gets the delayWhileIdle flag.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getCollapseKey

public java.lang.String getCollapseKey()

Gets the collapse key.

isDelayWhileIdle

public java.lang.Boolean isDelayWhileIdle()

Gets the delayWhileIdle flag.

getTimeToLive

public java.lang.Integer getTimeToLive()

Gets the time to live (in seconds).

getData

public java.util.Map<java.lang.String,java.lang.String> getData()

Gets the payload data, which is immutable.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object