com.microstrategy.ushersdk

Class MessageEntity.Builder

java.lang.Object

com.microstrategy.ushersdk.MessageEntity.Builder

Enclosing class:

MessageEntity

public abstract static class MessageEntity.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
abstract MessageEntity	build() Builds the MessageEntity object that is used to wrap various properties related to messages.
abstract MessageEntity.Builder	code(java.lang.String code) Returns the MessageEntity.Builder for the MessageEntity.code() component of the MessageEntity object.
abstract MessageEntity.Builder	codeExpiredTs(long codeExpiredTs) Returns the MessageEntity.Builder for the MessageEntity.codeExpiredTs() component of the MessageEntity object.
abstract MessageEntity.Builder	content(java.util.Map<java.lang.String,java.lang.String> content) Returns the MessageEntity.Builder for the MessageEntity.content() component of the MessageEntity object.
abstract MessageEntity.Builder	createdTs(long createdTs) Returns the MessageEntity.Builder for the MessageEntity.createdTs() component of the MessageEntity object.
abstract MessageEntity.Builder	expiredTs(long expiredTs) Returns the MessageEntity.Builder for the MessageEntity.expiredTs() component of the MessageEntity object.
abstract MessageEntity.Builder	iotId(java.lang.String iotId) Returns the MessageEntity.Builder for the MessageEntity.iotId() component of the MessageEntity object.
abstract MessageEntity.Builder	iotType(java.lang.String iotType) Returns the MessageEntity.Builder for the MessageEntity.iotType() component of the MessageEntity object.
abstract MessageEntity.Builder	isExpired(boolean isExpired) Returns the MessageEntity.Builder for the MessageEntity.isExpired() component of the MessageEntity object.
abstract MessageEntity.Builder	messageId(java.lang.String messageId) Returns the MessageEntity.Builder for the MessageEntity.messageId() component of the MessageEntity object.
abstract MessageEntity.Builder	participant(MessageEntity.Participant participant) Returns the MessageEntity.Builder for the MessageEntity.participant() component of the MessageEntity object.
abstract MessageEntity.Builder	purpose(MessageEntity.Purpose purpose) Returns the MessageEntity.Builder for the MessageEntity.purpose() component of the MessageEntity object.
abstract MessageEntity.Builder	status(MessageEntity.Status status) Returns the MessageEntity.Builder for the MessageEntity.status() component of the MessageEntity object.
abstract MessageEntity.Builder	type(MessageEntity.Type type) Returns the MessageEntity.Builder for the MessageEntity.type() component of the MessageEntity object.
abstract MessageEntity.Builder	updateTs(long updateTs) Returns the MessageEntity.Builder for the MessageEntity.updateTs() component of the MessageEntity object.

Methods inherited from class java.lang.Object

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

Method Detail

codeExpiredTs

public abstract MessageEntity.Builder codeExpiredTs(long codeExpiredTs)

Returns the MessageEntity.Builder for the MessageEntity.codeExpiredTs() component of the MessageEntity object.

Parameters:

codeExpiredTs - the time in seconds at which the code expires

Returns:

the MessageEntity.Builder for the MessageEntity.codeExpiredTs() component of the MessageEntity object.

createdTs

public abstract MessageEntity.Builder createdTs(long createdTs)

Returns the MessageEntity.Builder for the MessageEntity.createdTs() component of the MessageEntity object.

Parameters:

createdTs - the time in seconds at which the message was created

Returns:

the MessageEntity.Builder for the MessageEntity.createdTs() component of the MessageEntity object.

iotId

public abstract MessageEntity.Builder iotId(@Nonnull
                                            java.lang.String iotId)

Returns the MessageEntity.Builder for the MessageEntity.iotId() component of the MessageEntity object.

Parameters:

iotId - the identification number of the IoT device

Returns:

the MessageEntity.Builder for the MessageEntity.iotId() component of the MessageEntity object.

iotType

public abstract MessageEntity.Builder iotType(@Nonnull
                                              java.lang.String iotType)

Returns the MessageEntity.Builder for the MessageEntity.iotType() component of the MessageEntity object.

Parameters:

iotType - the type of IoT device

Returns:

the MessageEntity.Builder for the MessageEntity.iotType() component of the MessageEntity object.

messageId

public abstract MessageEntity.Builder messageId(@Nonnull
                                                java.lang.String messageId)

Returns the MessageEntity.Builder for the MessageEntity.messageId() component of the MessageEntity object.

Parameters:

messageId - the identification number of the message

Returns:

the MessageEntity.Builder for the MessageEntity.messageId() component of the MessageEntity object.

participant

public abstract MessageEntity.Builder participant(@Nonnull
                                                  MessageEntity.Participant participant)

Returns the MessageEntity.Builder for the MessageEntity.participant() component of the MessageEntity object.

Parameters:

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

Returns:

the MessageEntity.Builder for the MessageEntity.participant() component of the MessageEntity object.

status

public abstract MessageEntity.Builder status(@Nonnull
                                             MessageEntity.Status status)

Returns the MessageEntity.Builder for the MessageEntity.status() component of the MessageEntity object.

Parameters:

status - the MessageEntity.Status of the message

Returns:

the MessageEntity.Builder for the MessageEntity.status() component of the MessageEntity object.

type

public abstract MessageEntity.Builder type(@Nonnull
                                           MessageEntity.Type type)

Returns the MessageEntity.Builder for the MessageEntity.type() component of the MessageEntity object.

Parameters:

type - the MessageEntity.Type of the message

Returns:

the MessageEntity.Builder for the MessageEntity.type() component of the MessageEntity object.

updateTs

public abstract MessageEntity.Builder updateTs(long updateTs)

Returns the MessageEntity.Builder for the MessageEntity.updateTs() component of the MessageEntity object.

Parameters:

updateTs - the time in seconds at which the message was updated

Returns:

the MessageEntity.Builder for the MessageEntity.updateTs() component of the MessageEntity object.

expiredTs

public abstract MessageEntity.Builder expiredTs(long expiredTs)

Returns the MessageEntity.Builder for the MessageEntity.expiredTs() component of the MessageEntity object.

Parameters:

expiredTs - the time in seconds at which the message was expired

Returns:

the MessageEntity.Builder for the MessageEntity.expiredTs() component of the MessageEntity object.

isExpired

public abstract MessageEntity.Builder isExpired(boolean isExpired)

Returns the MessageEntity.Builder for the MessageEntity.isExpired() component of the MessageEntity object.

Parameters:

isExpired - boolean to indicate whether the message is expired

Returns:

the MessageEntity.Builder for the MessageEntity.isExpired() component of the MessageEntity object.

purpose

public abstract MessageEntity.Builder purpose(@Nonnull
                                              MessageEntity.Purpose purpose)

Returns the MessageEntity.Builder for the MessageEntity.purpose() component of the MessageEntity object.

Parameters:

purpose - the MessageEntity.Purpose of the message. This includes the purpose of the message

Returns:

the MessageEntity.Builder for the MessageEntity.purpose() component of the MessageEntity object.

code

public abstract MessageEntity.Builder code(java.lang.String code)

Returns the MessageEntity.Builder for the MessageEntity.code() component of the MessageEntity object.

Parameters:

code - the message code

Returns:

the MessageEntity.Builder for the MessageEntity.code() component of the MessageEntity object.

content

public abstract MessageEntity.Builder content(java.util.Map<java.lang.String,java.lang.String> content)

Returns the MessageEntity.Builder for the MessageEntity.content() component of the MessageEntity object.

Parameters:

content - the message content

Returns:

the MessageEntity.Builder for the MessageEntity.content() component of the MessageEntity object.

build

public abstract MessageEntity build()

Builds the MessageEntity object that is used to wrap various properties related to messages.

Returns:

the MessageEntity object that is used to wrap various properties related to messages.