com.microstrategy.usher

Class InboxEntity

java.lang.Object

com.microstrategy.usher.InboxEntity

public abstract class InboxEntity
extends java.lang.Object

The InboxEntity abstract class wraps various attributes related to the inbox, including notification ID, sender name, sender title, and message, among others.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InboxEntity.SenderEntity The InboxEntity.SenderEntity abstract class wraps various properties related to the sender of an InboxEntity, including badge ID, name, and title, among others.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INVALID_NOTIFICATION_ID Invalid notification ID.
static int	INVALID_OPTION_ID Invalid option ID.

Method Summary

Modifier and Type	Method and Description
abstract int	badgeId() Returns an int of the identification number of the badge, which received the notification.
abstract long	createdTime() Returns a long of the time in seconds at which the notification was sent.
static InboxEntity	fromJsonString(java.lang.String jsonString) Returns an InboxEntity object after parsing a JSON string.
abstract java.lang.String	message() Returns a String of the message.
abstract int	notificationId() Returns an int of the identification number of the notification.
abstract java.lang.String	option() Returns a String of the chosen option.
abstract java.util.List<java.lang.String>	optionList() Returns a List of Strings of options.
abstract long	repliedTime() Returns a long of the time in seconds at which the notification was replied to.
abstract InboxEntity.SenderEntity	senderEntity() Returns a InboxEntity.SenderEntity object, which provides information about the message sender, including name, title, and badge ID, among others.
static java.lang.String	toJsonString(InboxEntity inboxEntity) Returns a JSON String of an InboxEntity object.
abstract InboxEntity	withOption(java.lang.String option) Constructor for a InboxEntity object with the option set.

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_NOTIFICATION_ID

public static final int INVALID_NOTIFICATION_ID

Invalid notification ID. Value is -2147483648.

See Also:

Constant Field Values

INVALID_OPTION_ID

public static final int INVALID_OPTION_ID

Invalid option ID. Value is -2147483648.

See Also:

Constant Field Values

Method Detail

toJsonString

public static java.lang.String toJsonString(InboxEntity inboxEntity)

Returns a JSON String of an InboxEntity object.

Parameters:

inboxEntity - See InboxEntity

Returns:

a JSON string of the InboxEntity object.

fromJsonString

public static InboxEntity fromJsonString(java.lang.String jsonString)

Returns an InboxEntity object after parsing a JSON string.

Parameters:

jsonString - the JSON string of the InboxEntity object

Returns:

the InboxEntity object parsed from a JSON string.

notificationId

public abstract int notificationId()

Returns an int of the identification number of the notification. Used in the Object.hashCode() and Object.equals(Object) implementations.

Returns:

the identification number of the notification. This can also include:

• INVALID_NOTIFICATION_ID = Integer.MIN_VALUE

badgeId

public abstract int badgeId()

Returns an int of the identification number of the badge, which received the notification.

Returns:

the identification number of the badge, which received the notification.

createdTime

public abstract long createdTime()

Returns a long of the time in seconds at which the notification was sent.

Returns:

the time in seconds at which the notification was sent.

repliedTime

public abstract long repliedTime()

Returns a long of the time in seconds at which the notification was replied to.

Returns:

the time in seconds at which the notification was replied to.

message

public abstract java.lang.String message()

Returns a String of the message.

Returns:

the message.

optionList

@Nullable
public abstract java.util.List<java.lang.String> optionList()

Returns a List of Strings of options. Will be null for generic messages.

Returns:

a List of Strings of options.

option

@Nullable
public abstract java.lang.String option()

Returns a String of the chosen option. Will be null for generic messages.

Returns:

the chosen option.

senderEntity

@Nullable
public abstract InboxEntity.SenderEntity senderEntity()

Returns a InboxEntity.SenderEntity object, which provides information about the message sender, including name, title, and badge ID, among others.

Returns:

a InboxEntity.SenderEntity object.

withOption

public abstract InboxEntity withOption(java.lang.String option)

Constructor for a InboxEntity object with the option set.

Parameters:

option - the chosen option

Returns:

a InboxEntity object with the option set.