cn.jpush.api.push.model

Class PushPayload

java.lang.Object

cn.jpush.api.push.model.PushPayload

All Implemented Interfaces:

PushModel

public class PushPayload
extends Object
implements PushModel

The object you should build for sending a push. Basically start with newBuilder() method to build a PushPayload object. alertAll() is a shortcut for quickly build payload of alert to all platform and all audience; mesageAll() is a shortcut for quickly build payload of message to all platform and all audience.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PushPayload.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,com.google.gson.JsonObject>	custom

Fields inherited from interface cn.jpush.api.push.model.PushModel

gson

Method Summary

Modifier and Type	Method and Description
static PushPayload	alertAll(String alert) The shortcut of building a simple alert notification object to all platforms and all audiences
static PushPayload	alertAll(String alert, SMS sms)
static PushPayload	fromJSON(String payloadString)
Audience	getAudience()
String	getCid()
Options	getOptions()
Platform	getPlatform()
int	getSendno()
String	getTarget()
boolean	isGlobalExceedLength()
boolean	isIosExceedLength()
static PushPayload	messageAll(String msgContent) The shortcut of building a simple message object to all platforms and all audiences
static PushPayload	messageAll(String msgContent, SMS sms)
static PushPayload.Builder	newBuilder() The entrance for building a PushPayload object.
void	resetOptionsApnsProduction(boolean apnsProduction)
void	resetOptionsTimeToLive(long timeToLive)
PushPayload	setCid(String cid)
com.google.gson.JsonElement	toJSON()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

custom

protected Map<String,com.google.gson.JsonObject> custom

Method Detail

setCid

public PushPayload setCid(String cid)

getPlatform

public Platform getPlatform()

getTarget

public String getTarget()

getCid

public String getCid()

newBuilder

public static PushPayload.Builder newBuilder()

The entrance for building a PushPayload object.

Returns:

PushPayload builder

alertAll

public static PushPayload alertAll(String alert)

The shortcut of building a simple alert notification object to all platforms and all audiences

Parameters:

alert - The alert message.

Returns:

PushPayload

alertAll

public static PushPayload alertAll(String alert,
                                   SMS sms)

messageAll

public static PushPayload messageAll(String msgContent)

The shortcut of building a simple message object to all platforms and all audiences

Parameters:

msgContent - The message content.

Returns:

PushPayload

messageAll

public static PushPayload messageAll(String msgContent,
                                     SMS sms)

fromJSON

public static PushPayload fromJSON(String payloadString)

resetOptionsApnsProduction

public void resetOptionsApnsProduction(boolean apnsProduction)

resetOptionsTimeToLive

public void resetOptionsTimeToLive(long timeToLive)

getSendno

public int getSendno()

getAudience

public Audience getAudience()

getOptions

public Options getOptions()

toJSON

public com.google.gson.JsonElement toJSON()

Specified by:

toJSON in interface PushModel

isGlobalExceedLength

public boolean isGlobalExceedLength()

isIosExceedLength

public boolean isIosExceedLength()

toString

public String toString()

Overrides:

toString in class Object