Package software.xdev.brevo.model
Class ConversationsMessage
java.lang.Object
software.xdev.brevo.model.ConversationsMessage
a Conversations message
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription_file(ConversationsMessageFile _file) booleanID of the agent on whose behalf the message was sent (only in messages sent by an agent).Agent’s name as displayed to the visitor.Timestamp in milliseconds.getFile()Get _filegetId()Message ID.`true` for pushed messagesIn two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop.getText()Message text or name of the attached filegetType()`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages.visitor’s IDinthashCode()receivedFrom(String receivedFrom) voidsetAgentId(String agentId) voidsetAgentName(String agentName) voidsetCreatedAt(Long createdAt) voidsetFile(ConversationsMessageFile _file) voidvoidsetIsPushed(Boolean isPushed) voidsetReceivedFrom(String receivedFrom) voidvoidvoidsetVisitorId(String visitorId) toString()Convert the instance into URL query string.toUrlQueryString(String prefix) Convert the instance into URL query string.
-
Field Details
-
JSON_PROPERTY_ID
- See Also:
-
JSON_PROPERTY_TYPE
- See Also:
-
JSON_PROPERTY_TEXT
- See Also:
-
JSON_PROPERTY_VISITOR_ID
- See Also:
-
JSON_PROPERTY_AGENT_ID
- See Also:
-
JSON_PROPERTY_AGENT_NAME
- See Also:
-
JSON_PROPERTY_CREATED_AT
- See Also:
-
JSON_PROPERTY_IS_PUSHED
- See Also:
-
JSON_PROPERTY_RECEIVED_FROM
- See Also:
-
JSON_PROPERTY_FILE
- See Also:
-
-
Constructor Details
-
ConversationsMessage
public ConversationsMessage()
-
-
Method Details
-
id
-
getId
Message ID. It can be used for further manipulations with the message.- Returns:
- id
-
setId
-
type
-
getType
`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages.- Returns:
- type
-
setType
-
text
-
getText
Message text or name of the attached file- Returns:
- text
-
setText
-
visitorId
-
getVisitorId
visitor’s ID- Returns:
- visitorId
-
setVisitorId
-
agentId
-
getAgentId
ID of the agent on whose behalf the message was sent (only in messages sent by an agent).- Returns:
- agentId
-
setAgentId
-
agentName
-
getAgentName
Agent’s name as displayed to the visitor. Only in the messages sent by an agent.- Returns:
- agentName
-
setAgentName
-
createdAt
-
getCreatedAt
Timestamp in milliseconds. minimum: 0- Returns:
- createdAt
-
setCreatedAt
-
isPushed
-
getIsPushed
`true` for pushed messages- Returns:
- isPushed
-
setIsPushed
-
receivedFrom
-
getReceivedFrom
In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop.- Returns:
- receivedFrom
-
setReceivedFrom
-
_file
-
getFile
Get _file- Returns:
- _file
-
setFile
-
equals
-
hashCode
public int hashCode() -
toString
-
toUrlQueryString
Convert the instance into URL query string.- Returns:
- URL query string
-
toUrlQueryString
Convert the instance into URL query string.- Parameters:
prefix- prefix of the query string- Returns:
- URL query string
-