Package com.mypurecloud.sdk.v2.model

Class MessageDetails

java.lang.Object

com.mypurecloud.sdk.v2.model.MessageDetails

All Implemented Interfaces:

Serializable

public class MessageDetails
extends Object
implements Serializable

MessageDetails

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MessageDetails.MessageStatusEnum	Indicates the delivery status of the message.
static enum	MessageDetails.SocialVisibilityEnum	For social media messages, the visibility of the message in the originating social platform

Constructor Summary

Constructors

Constructor	Description
MessageDetails()
MessageDetails(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
MessageDetails	errorInfo(ErrorBody errorInfo)	Provider specific error information for a communication.
ErrorBody	getErrorInfo()
List<MessageMedia>	getMedia()
String	getMessageId()
ConversationMessageMetadata	getMessageMetadata()
Integer	getMessageSegmentCount()
MessageDetails.MessageStatusEnum	getMessageStatus()
Date	getMessageTime()
String	getMessageURI()
MessageDetails.SocialVisibilityEnum	getSocialVisibility()
List<MessageSticker>	getStickers()
int	hashCode()
MessageDetails	media(List<MessageMedia> media)	Deprecated: Use the API /api/v2/conversations/messages/{conversationId}/messages/{messageId} to get the associated media.
MessageDetails	messageId(String messageId)	UUID identifying the message media.
MessageDetails	messageMetadata(ConversationMessageMetadata messageMetadata)	Information that describes the content of the message, if any
MessageDetails	messageSegmentCount(Integer messageSegmentCount)	The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g.
MessageDetails	messageStatus(MessageDetails.MessageStatusEnum messageStatus)	Indicates the delivery status of the message.
MessageDetails	messageTime(Date messageTime)	The time when the message was sent or received.
MessageDetails	messageURI(String messageURI)	A URI for this message entity.
void	setErrorInfo(ErrorBody errorInfo)
void	setMedia(List<MessageMedia> media)
void	setMessageId(String messageId)
void	setMessageMetadata(ConversationMessageMetadata messageMetadata)
void	setMessageSegmentCount(Integer messageSegmentCount)
void	setMessageStatus(MessageDetails.MessageStatusEnum messageStatus)
void	setMessageTime(Date messageTime)
void	setMessageURI(String messageURI)
void	setSocialVisibility(MessageDetails.SocialVisibilityEnum socialVisibility)
void	setStickers(List<MessageSticker> stickers)
MessageDetails	socialVisibility(MessageDetails.SocialVisibilityEnum socialVisibility)	For social media messages, the visibility of the message in the originating social platform
MessageDetails	stickers(List<MessageSticker> stickers)	Deprecated: This attribute is no longer used.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

MessageDetails

public MessageDetails()

MessageDetails

public MessageDetails(Boolean initWithEmptyList)

Method Details

messageId

public MessageDetails messageId(String messageId)

UUID identifying the message media.

getMessageId

public String getMessageId()

setMessageId

public void setMessageId(String messageId)

messageURI

public MessageDetails messageURI(String messageURI)

A URI for this message entity.

getMessageURI

public String getMessageURI()

setMessageURI

public void setMessageURI(String messageURI)

messageStatus

public MessageDetails messageStatus(MessageDetails.MessageStatusEnum messageStatus)

Indicates the delivery status of the message.

getMessageStatus

public MessageDetails.MessageStatusEnum getMessageStatus()

setMessageStatus

public void setMessageStatus(MessageDetails.MessageStatusEnum messageStatus)

messageSegmentCount

public MessageDetails messageSegmentCount(Integer messageSegmentCount)

The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g. SMS character limits.

getMessageSegmentCount

public Integer getMessageSegmentCount()

setMessageSegmentCount

public void setMessageSegmentCount(Integer messageSegmentCount)

messageTime

public MessageDetails messageTime(Date messageTime)

The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getMessageTime

public Date getMessageTime()

setMessageTime

public void setMessageTime(Date messageTime)

media

public MessageDetails media(List<MessageMedia> media)

Deprecated: Use the API /api/v2/conversations/messages/{conversationId}/messages/{messageId} to get the associated media.

getMedia

public List<MessageMedia> getMedia()

setMedia

public void setMedia(List<MessageMedia> media)

stickers

public MessageDetails stickers(List<MessageSticker> stickers)

Deprecated: This attribute is no longer used. Messages have not included associated stickers for a long time.

getStickers

public List<MessageSticker> getStickers()

setStickers

public void setStickers(List<MessageSticker> stickers)

messageMetadata

public MessageDetails messageMetadata(ConversationMessageMetadata messageMetadata)

Information that describes the content of the message, if any

getMessageMetadata

public ConversationMessageMetadata getMessageMetadata()

setMessageMetadata

public void setMessageMetadata(ConversationMessageMetadata messageMetadata)

socialVisibility

public MessageDetails socialVisibility(MessageDetails.SocialVisibilityEnum socialVisibility)

For social media messages, the visibility of the message in the originating social platform

getSocialVisibility

public MessageDetails.SocialVisibilityEnum getSocialVisibility()

setSocialVisibility

public void setSocialVisibility(MessageDetails.SocialVisibilityEnum socialVisibility)

errorInfo

public MessageDetails errorInfo(ErrorBody errorInfo)

Provider specific error information for a communication.

getErrorInfo

public ErrorBody getErrorInfo()

setErrorInfo

public void setErrorInfo(ErrorBody errorInfo)

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