Package com.thalesgroup.gemalto.d1.messaging

Class Message

java.lang.Object

com.thalesgroup.gemalto.d1.messaging.Message

public class Message
extends Object

This contains the information about message notification. The message is related to activities in the card issued by D1.

Since:

4.0.0

Constructor Summary

Constructors

Constructor	Description
Message(String messageID, String title, String message, String metaData, MessageType messageType, MessageFormat messageFormat, String action, boolean isRead, String timeStamp)

Method Summary

Modifier and Type	Method	Description
String	getAction()	The hint provided to determine the action to be taken if the end user clicks on the notification.
MessageFormat	getFormat()	The message format which is either in text or HTML.
String	getMessage()	The message content.
static Message	getMessage(String messageID)	To get the message based on the message ID.
String	getMessageID()	The message ID.
String	getMetadata()	The metadata contains a free-form object.
String	getTimeStamp()	The message creation time based on ISO 8601 format YYYY-MM-DDThh:mm:ssTZD.
String	getTitle()	The message title.
MessageType	getType()	The message type.
boolean	isRead()	Indicates if the application has marked the message as read by the end user.

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message(String messageID,
               String title,
               String message,
               String metaData,
               MessageType messageType,
               MessageFormat messageFormat,
               String action,
               boolean isRead,
               String timeStamp)

Method Detail

getMessageID

public String getMessageID()

The message ID.

Returns:

The messageID.

getTitle

public String getTitle()

The message title.

Returns:

The title.

getMessage

public String getMessage()

The message content.

Returns:

The message content.

getType

public MessageType getType()

The message type.

Returns:

The message type.

getFormat

public MessageFormat getFormat()

The message format which is either in text or HTML.

Returns:

The message format.

getAction

public String getAction()

The hint provided to determine the action to be taken if the end user clicks on the notification.

Returns:

The action.

isRead

public boolean isRead()

Indicates if the application has marked the message as read by the end user.

Returns:

A boolean value if the message is read by the end user.

getTimeStamp

public String getTimeStamp()

The message creation time based on ISO 8601 format YYYY-MM-DDThh:mm:ssTZD.

Returns:

The timestamp.

getMetadata

public String getMetadata()

The metadata contains a free-form object. The content and type of data depend on how the notification has been configured at the backend.

Returns:

The metadata.

getMessage

public static Message getMessage(@NonNull
                                 String messageID)

To get the message based on the message ID.

Parameters:

messageID - The message ID.

Returns:

The message.