com.google.android.gcm.server

Class Message

java.lang.Object

com.google.android.gcm.server.Message

All Implemented Interfaces:

Serializable

public final class Message
extends Object
implements 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

Nested Classes

Modifier and Type	Class and Description
static class	Message.Builder

Method Summary

Methods

Modifier and Type	Method and Description
String	getCollapseKey() Gets the collapse key.
Map<String,String>	getData() Gets the payload data, which is immutable.
Integer	getTimeToLive() Gets the time to live (in seconds).
Boolean	isDelayWhileIdle() Gets the delayWhileIdle flag.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getCollapseKey

public String getCollapseKey()

Gets the collapse key.

isDelayWhileIdle

public Boolean isDelayWhileIdle()

Gets the delayWhileIdle flag.

getTimeToLive

public Integer getTimeToLive()

Gets the time to live (in seconds).

getData

public Map<String,String> getData()

Gets the payload data, which is immutable.

toString

public String toString()

Overrides:

toString in class Object