Package com.mypurecloud.sdk.v2.model

Class WebMessagingMessage

java.lang.Object

com.mypurecloud.sdk.v2.model.WebMessagingMessage

All Implemented Interfaces:

Serializable

public class WebMessagingMessage
extends Object
implements Serializable

A web messaging message

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WebMessagingMessage.DirectionEnum	The direction of the message.
static enum	WebMessagingMessage.OriginatingEntityEnum	Specifies if this message was sent by a human agent or bot.
static enum	WebMessagingMessage.StatusEnum	Message receipt status, only used with type Receipt.
static enum	WebMessagingMessage.TypeEnum	Message type.

Constructor Summary

Constructors

Constructor	Description
WebMessagingMessage()
WebMessagingMessage(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
WebMessagingMessage	channel(WebMessagingChannel channel)	Channel-specific information that describes the message and the message channel/provider.
WebMessagingMessage	content(List<WebMessagingContent> content)	List of content elements.
WebMessagingMessage	direction(WebMessagingMessage.DirectionEnum direction)	The direction of the message.
boolean	equals(Object o)
WebMessagingMessage	events(List<WebMessagingEvent> events)	List of event elements.
WebMessagingChannel	getChannel()
List<WebMessagingContent>	getContent()
WebMessagingMessage.DirectionEnum	getDirection()
List<WebMessagingEvent>	getEvents()
String	getId()
Map<String,String>	getMetadata()
WebMessagingMessage.OriginatingEntityEnum	getOriginatingEntity()
List<Reason>	getReasons()
WebMessagingMessage.StatusEnum	getStatus()
String	getText()
WebMessagingMessage.TypeEnum	getType()
int	hashCode()
WebMessagingMessage	id(String id)	Unique ID of the message.
WebMessagingMessage	metadata(Map<String,String> metadata)	Additional metadata about this message.
WebMessagingMessage	originatingEntity(WebMessagingMessage.OriginatingEntityEnum originatingEntity)	Specifies if this message was sent by a human agent or bot.
void	setChannel(WebMessagingChannel channel)
void	setContent(List<WebMessagingContent> content)
void	setDirection(WebMessagingMessage.DirectionEnum direction)
void	setEvents(List<WebMessagingEvent> events)
void	setId(String id)
void	setMetadata(Map<String,String> metadata)
void	setOriginatingEntity(WebMessagingMessage.OriginatingEntityEnum originatingEntity)
void	setText(String text)
void	setType(WebMessagingMessage.TypeEnum type)
WebMessagingMessage	text(String text)	Message text.
String	toString()
WebMessagingMessage	type(WebMessagingMessage.TypeEnum type)	Message type.

Methods inherited from class java.lang.Object

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

Constructor Details

WebMessagingMessage

public WebMessagingMessage()

WebMessagingMessage

public WebMessagingMessage(Boolean initWithEmptyList)

Method Details

id

public WebMessagingMessage 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.

getId

public String getId()

setId

public void setId(String id)

channel

public WebMessagingMessage channel(WebMessagingChannel channel)

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

getChannel

public WebMessagingChannel getChannel()

setChannel

public void setChannel(WebMessagingChannel channel)

type

public WebMessagingMessage type(WebMessagingMessage.TypeEnum type)

Message type.

getType

public WebMessagingMessage.TypeEnum getType()

setType

public void setType(WebMessagingMessage.TypeEnum type)

text

public WebMessagingMessage text(String text)

Message text.

getText

public String getText()

setText

public void setText(String text)

content

public WebMessagingMessage content(List<WebMessagingContent> content)

List of content elements.

getContent

public List<WebMessagingContent> getContent()

setContent

public void setContent(List<WebMessagingContent> content)

getStatus

public WebMessagingMessage.StatusEnum getStatus()

getReasons

public List<Reason> getReasons()

events

public WebMessagingMessage events(List<WebMessagingEvent> events)

List of event elements.

getEvents

public List<WebMessagingEvent> getEvents()

setEvents

public void setEvents(List<WebMessagingEvent> events)

direction

public WebMessagingMessage direction(WebMessagingMessage.DirectionEnum direction)

The direction of the message. Direction is always from the perspective of the Genesys Cloud platform. An Inbound message is one sent from a guest to the Genesys Cloud Platform. An Outbound message is one sent from the Genesys Cloud Platform to a guest.

getDirection

public WebMessagingMessage.DirectionEnum getDirection()

setDirection

public void setDirection(WebMessagingMessage.DirectionEnum direction)

originatingEntity

public WebMessagingMessage originatingEntity(WebMessagingMessage.OriginatingEntityEnum originatingEntity)

Specifies if this message was sent by a human agent or bot. The platform may use this to apply appropriate provider policies.

getOriginatingEntity

public WebMessagingMessage.OriginatingEntityEnum getOriginatingEntity()

setOriginatingEntity

public void setOriginatingEntity(WebMessagingMessage.OriginatingEntityEnum originatingEntity)

metadata

public WebMessagingMessage 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