Package com.mypurecloud.sdk.v2.model

Class OpenNormalizedMessage

java.lang.Object

com.mypurecloud.sdk.v2.model.OpenNormalizedMessage

All Implemented Interfaces:

Serializable

public class OpenNormalizedMessage
extends Object
implements Serializable

Open Messaging rich media message structure

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OpenNormalizedMessage.DirectionEnum	The direction of the message.
static enum	OpenNormalizedMessage.StatusEnum	Message receipt status, only used with type Receipt.
static enum	OpenNormalizedMessage.TypeEnum	Message type.

Constructor Summary

Constructors

Constructor	Description
OpenNormalizedMessage()
OpenNormalizedMessage(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
OpenNormalizedMessage	channel(OpenMessagingChannel channel)	Channel-specific information that describes the message and the message channel/provider.
OpenNormalizedMessage	content(List<OpenMessageContent> content)	List of content elements.
OpenNormalizedMessage	direction(OpenNormalizedMessage.DirectionEnum direction)	The direction of the message.
boolean	equals(Object o)
OpenMessagingChannel	getChannel()
List<OpenMessageContent>	getContent()
OpenNormalizedMessage.DirectionEnum	getDirection()
String	getId()
Boolean	getIsFinalReceipt()
Map<String,String>	getMetadata()
List<ConversationReason>	getReasons()
OpenNormalizedMessage.StatusEnum	getStatus()
String	getText()
OpenNormalizedMessage.TypeEnum	getType()
int	hashCode()
OpenNormalizedMessage	id(String id)	Unique ID of the message.
OpenNormalizedMessage	isFinalReceipt(Boolean isFinalReceipt)	Indicates if this is the last message receipt for this message, or if another message receipt can be expected.
OpenNormalizedMessage	metadata(Map<String,String> metadata)	Additional metadata about this message.
OpenNormalizedMessage	reasons(List<ConversationReason> reasons)	List of reasons for a message receipt that indicates the message has failed.
void	setChannel(OpenMessagingChannel channel)
void	setContent(List<OpenMessageContent> content)
void	setDirection(OpenNormalizedMessage.DirectionEnum direction)
void	setId(String id)
void	setIsFinalReceipt(Boolean isFinalReceipt)
void	setMetadata(Map<String,String> metadata)
void	setReasons(List<ConversationReason> reasons)
void	setStatus(OpenNormalizedMessage.StatusEnum status)
void	setText(String text)
void	setType(OpenNormalizedMessage.TypeEnum type)
OpenNormalizedMessage	status(OpenNormalizedMessage.StatusEnum status)	Message receipt status, only used with type Receipt.
OpenNormalizedMessage	text(String text)	Message text.
String	toString()
OpenNormalizedMessage	type(OpenNormalizedMessage.TypeEnum type)	Message type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OpenNormalizedMessage

public OpenNormalizedMessage()

OpenNormalizedMessage

public OpenNormalizedMessage(Boolean initWithEmptyList)

Method Details

id

public OpenNormalizedMessage id(String id)

Unique ID of the message. This ID is generated by Messaging Platform. Message receipts will have the same ID as the message they reference, as such should only be set when sending a message receipt.

getId

public String getId()

setId

public void setId(String id)

channel

public OpenNormalizedMessage channel(OpenMessagingChannel channel)

Channel-specific information that describes the message and the message channel/provider.

getChannel

public OpenMessagingChannel getChannel()

setChannel

public void setChannel(OpenMessagingChannel channel)

type

public OpenNormalizedMessage type(OpenNormalizedMessage.TypeEnum type)

Message type.

getType

public OpenNormalizedMessage.TypeEnum getType()

setType

public void setType(OpenNormalizedMessage.TypeEnum type)

text

public OpenNormalizedMessage text(String text)

Message text.

getText

public String getText()

setText

public void setText(String text)

content

public OpenNormalizedMessage content(List<OpenMessageContent> content)

List of content elements.

getContent

public List<OpenMessageContent> getContent()

setContent

public void setContent(List<OpenMessageContent> content)

status

public OpenNormalizedMessage status(OpenNormalizedMessage.StatusEnum status)

Message receipt status, only used with type Receipt.

getStatus

public OpenNormalizedMessage.StatusEnum getStatus()

setStatus

public void setStatus(OpenNormalizedMessage.StatusEnum status)

reasons

public OpenNormalizedMessage reasons(List<ConversationReason> reasons)

List of reasons for a message receipt that indicates the message has failed. Only used with Failed status.

getReasons

public List<ConversationReason> getReasons()

setReasons

public void setReasons(List<ConversationReason> reasons)

isFinalReceipt

public OpenNormalizedMessage isFinalReceipt(Boolean isFinalReceipt)

Indicates if this is the last message receipt for this message, or if another message receipt can be expected.

getIsFinalReceipt

public Boolean getIsFinalReceipt()

setIsFinalReceipt

public void setIsFinalReceipt(Boolean isFinalReceipt)

direction

public OpenNormalizedMessage direction(OpenNormalizedMessage.DirectionEnum direction)

The direction of the message.

getDirection

public OpenNormalizedMessage.DirectionEnum getDirection()

setDirection

public void setDirection(OpenNormalizedMessage.DirectionEnum direction)

metadata

public OpenNormalizedMessage metadata(Map<String,String> metadata)

Additional metadata about this message.

getMetadata

public Map<String,String> getMetadata()

setMetadata

public void setMetadata(Map<String,String> metadata)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object