Class ConversationsMessage

java.lang.Object
software.xdev.brevo.model.ConversationsMessage

public class ConversationsMessage extends Object
a Conversations message
  • Field Details

  • Constructor Details

    • ConversationsMessage

      public ConversationsMessage()
  • Method Details

    • id

      public ConversationsMessage id(String id)
    • getId

      @Nullable public String getId()
      Message ID. It can be used for further manipulations with the message.
      Returns:
      id
    • setId

      public void setId(String id)
    • type

    • getType

      @Nullable public ConversationsMessage.TypeEnum getType()
      `\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages.
      Returns:
      type
    • setType

      public void setType(ConversationsMessage.TypeEnum type)
    • text

      public ConversationsMessage text(String text)
    • getText

      @Nullable public String getText()
      Message text or name of the attached file
      Returns:
      text
    • setText

      public void setText(String text)
    • visitorId

      public ConversationsMessage visitorId(String visitorId)
    • getVisitorId

      @Nullable public String getVisitorId()
      visitor’s ID
      Returns:
      visitorId
    • setVisitorId

      public void setVisitorId(String visitorId)
    • agentId

      public ConversationsMessage agentId(String agentId)
    • getAgentId

      @Nullable public String getAgentId()
      ID of the agent on whose behalf the message was sent (only in messages sent by an agent).
      Returns:
      agentId
    • setAgentId

      public void setAgentId(String agentId)
    • agentName

      public ConversationsMessage agentName(String agentName)
    • getAgentName

      @Nullable public String getAgentName()
      Agent’s name as displayed to the visitor. Only in the messages sent by an agent.
      Returns:
      agentName
    • setAgentName

      public void setAgentName(String agentName)
    • createdAt

      public ConversationsMessage createdAt(Long createdAt)
    • getCreatedAt

      @Nullable public Long getCreatedAt()
      Timestamp in milliseconds. minimum: 0
      Returns:
      createdAt
    • setCreatedAt

      public void setCreatedAt(Long createdAt)
    • isPushed

      public ConversationsMessage isPushed(Boolean isPushed)
    • getIsPushed

      @Nullable public Boolean getIsPushed()
      `true` for pushed messages
      Returns:
      isPushed
    • setIsPushed

      public void setIsPushed(Boolean isPushed)
    • receivedFrom

      public ConversationsMessage receivedFrom(String receivedFrom)
    • getReceivedFrom

      @Nullable public String 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

      public void setReceivedFrom(String receivedFrom)
    • _file

    • getFile

      @Nullable public ConversationsMessageFile getFile()
      Get _file
      Returns:
      _file
    • setFile

      public void setFile(ConversationsMessageFile _file)
    • 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
    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string
    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string