com.microstrategy.ushersdk

Class MessageEntity

java.lang.Object

com.microstrategy.ushersdk.MessageEntity

public abstract class MessageEntity
extends java.lang.Object

The MessageEntity abstract class wraps various properties related to messages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageEntity.Builder
static class	MessageEntity.Participant The MessageEntity.Participant abstract class wraps various properties related to the sender and receiver of the message.
static class	MessageEntity.Purpose Enumerations of MessageEntity.Purpose.
static class	MessageEntity.Status Enumerations of MessageEntity.Status.
static class	MessageEntity.Type Enumerations of MessageEntity.Type.

Constructor Summary

Constructors

Constructor and Description
MessageEntity()

Method Summary

Modifier and Type	Method and Description
static MessageEntity.Builder	builder() Returns the MessageEntity.Builder object for the MessageEntity abstract class.
abstract java.lang.String	code() Returns a String of the message code.
abstract long	codeExpiredTs() Returns a long of the time in seconds at which the code expires.
abstract java.util.Map<java.lang.String,java.lang.String>	content() Returns the content of the message.
abstract long	createdTs() Returns a long of the time in seconds at which the message was created.
abstract long	expiredTs() Returns a long of the time in seconds at which the message was expired.
abstract java.lang.String	iotId() Returns a String of the identification number of the IoT device.
abstract java.lang.String	iotType() Returns a String of the type of IoT device.
abstract boolean	isExpired() Returns a boolean to indicate whether the message is expired or not.
abstract java.lang.String	messageId() Returns a String of the identification number of the message.
abstract MessageEntity.Participant	participant() Returns the MessageEntity.Participant of the message.
abstract MessageEntity.Purpose	purpose() Returns the MessageEntity.Purpose of message.
abstract MessageEntity.Status	status() Returns the MessageEntity.Status of the message.
abstract MessageEntity.Type	type() Returns the MessageEntity.Type of message.
abstract long	updateTs() Returns a long of the time in seconds at which the message was updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageEntity

public MessageEntity()

Method Detail

messageId

public abstract java.lang.String messageId()

Returns a String of the identification number of the message.

Returns:

the identification number of the message.

type

public abstract MessageEntity.Type type()

Returns the MessageEntity.Type of message.

Returns:

the MessageEntity.Type of message.

createdTs

public abstract long createdTs()

Returns a long of the time in seconds at which the message was created.

Returns:

the time in seconds at which the message was created.

updateTs

public abstract long updateTs()

Returns a long of the time in seconds at which the message was updated.

Returns:

the time in seconds at which the message was updated.

expiredTs

public abstract long expiredTs()

Returns a long of the time in seconds at which the message was expired.

Returns:

the time in seconds at which the message was expired.

isExpired

public abstract boolean isExpired()

Returns a boolean to indicate whether the message is expired or not.

Returns:

a boolean of whether the message is expired.

iotId

public abstract java.lang.String iotId()

Returns a String of the identification number of the IoT device.

Returns:

the identification number of the IoT device.

iotType

public abstract java.lang.String iotType()

Returns a String of the type of IoT device.

Returns:

the type of IoT device.

purpose

public abstract MessageEntity.Purpose purpose()

Returns the MessageEntity.Purpose of message.

Returns:

the MessageEntity.Purpose of message.

code

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

Returns a String of the message code.

Returns:

the message code.

codeExpiredTs

public abstract long codeExpiredTs()

Returns a long of the time in seconds at which the code expires.

Returns:

the time in seconds at which the code expires.

participant

public abstract MessageEntity.Participant participant()

Returns the MessageEntity.Participant of the message. This includes both the sender and receiver of the message.

Returns:

the MessageEntity.Participant of the message.

status

public abstract MessageEntity.Status status()

Returns the MessageEntity.Status of the message.

Returns:

the MessageEntity.Status of the message.

content

@Nullable
public abstract java.util.Map<java.lang.String,java.lang.String> content()

Returns the content of the message. May be null.

Returns:

the content of the message.

builder

public static MessageEntity.Builder builder()

Returns the MessageEntity.Builder object for the MessageEntity abstract class.

Returns:

the MessageEntity.Builder object for the MessageEntity abstract class.