com.codename1.push

Class PushContent

java.lang.Object

com.codename1.push.PushContent

public class PushContent
extends Object

Encapsulates the content of a Push message. Use this class inside the PushCallback.push(java.lang.String) method to retrieve details of the push, including title, body, image URL, category, type, and metadata if available.

Method Summary

Modifier and Type	Method and Description
static boolean	exists() Checks if there is pending push content to retrieve.
static PushContent	get() Gets the most recent push notification content if it exists.
String	getActionId() If the user selected an action on the push notification, then the ID of the selected action will be stored in the PushContent's actionId.
String	getBody() Gets the body of the push content.
String	getCategory() Gets category of the push content.
String	getImageUrl() Gets the image URL of the push content.
String	getMetaData() Gets the metadata associated with push.
String	getTextResponse() If the push notification action included a text field for the user to enter a response, then that response will be returned here.
String	getTitle() Gets the title of the Push content.
int	getType() Gets the type of the push content.
static void	reset() Resets the push content.
static void	setActionId(String actionId) Deprecated. For internal use only.
static void	setBody(String body) Deprecated. For internal use only
static void	setCategory(String category) Deprecated. For internal use only.
static void	setImageUrl(String imageUrl) Deprecated. For internal use only.
static void	setMetaData(String metaData) Deprecated. For internal use only.
static void	setTextResponse(String textResponse) Deprecated. For internal use only.
static void	setTitle(String title) Deprecated. For internal use only.
static void	setType(int type) Deprecated. For internal use only.

Methods inherited from class java.lang.Object

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

Method Detail

exists

public static boolean exists()

Checks if there is pending push content to retrieve.

Returns:

True if there is pending push content to retrieve.

get

public static PushContent get()

Gets the most recent push notification content if it exists. This functions like Stack.pop() for a single-element stack. I.e. In addition to returning the PushContent, that push content is removed from the queue.

if (PushContent.exists()) { PushContent content = PushContent.get(); // content should be non-null PushContent content2 = PushContent.get(); // content2 should be null PushContent.exists(); // false }

Returns:

Pending push content if it exists.

reset

public static void reset()

Resets the push content. After calling this, exists() will return false.

getTitle

public String getTitle()

Gets the title of the Push content.

Returns:

the title

setTitle

public static void setTitle(String title)

Deprecated. For internal use only.

Sets the title of the pending push content.

Parameters:

title - the title to set

getBody

public String getBody()

Gets the body of the push content.

Returns:

the body

setBody

public static void setBody(String body)

Deprecated. For internal use only

Sets the body of pending push content.

Parameters:

body - the body to set

getImageUrl

public String getImageUrl()

Gets the image URL of the push content.

Returns:

the imageUrl

setImageUrl

public static void setImageUrl(String imageUrl)

Deprecated. For internal use only.

Sets the image URL of pending push content.

Parameters:

imageUrl - the imageUrl to set

getCategory

public String getCategory()

Gets category of the push content.

Returns:

the category

setCategory

public static void setCategory(String category)

Deprecated. For internal use only.

Sets the category of the pending push content.

Parameters:

category - the category to set

getMetaData

public String getMetaData()

Gets the metadata associated with push. This is hidden content not shown to the user.

Returns:

the metaData

setMetaData

public static void setMetaData(String metaData)

Deprecated. For internal use only.

Sets the metadata of pending push content.

Parameters:

metaData - the metaData to set

getType

public int getType()

Gets the type of the push content.

Returns:

the type of the push content.

setType

public static void setType(int type)

Deprecated. For internal use only.

Sets the type of the push content.

Parameters:

type - the type to set

getActionId

public String getActionId()

If the user selected an action on the push notification, then the ID of the selected action will be stored in the PushContent's actionId. If the user did not tap an action, then this will be null.

Returns:

The action ID that was selected by the user.

See Also:

PushActionsProvider, PushActionCategory, PushAction

getTextResponse

public String getTextResponse()

If the push notification action included a text field for the user to enter a response, then that response will be returned here. For notifications that don't include a response, this will return null.

Returns:

The action ID that was selected by the user.

See Also:

PushActionsProvider, PushActionCategory, PushAction, PushAction.getTextInputButtonText(), PushAction.getTextInputPlaceholder()

setActionId

public static void setActionId(String actionId)

Deprecated. For internal use only.

Sets the action ID of the push content. The action ID is only set if the user tapped on one of the actions in the push notification; and, if set, it will be set to the ID of the action that was selected.

Parameters:

actionId - The ID of the action that was selected by the user.

See Also:

PushActionsProvider, PushActionCategory, PushAction

setTextResponse

public static void setTextResponse(String textResponse)

Deprecated. For internal use only.

Sets the text response for the notification. Only applies to notifications where the user has entered a text response.

See Also:

PushActionsProvider, PushActionCategory, PushAction, PushAction.getTextInputButtonText(), PushAction.getTextInputPlaceholder()