Package com.google.api.services.rcsbusinessmessaging.v1.model

Class AgentEvent

  • All Implemented Interfaces:
    java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.Object>
    public final class AgentEvent
extends com.google.api.client.json.GenericJson
    An event from the agent to the user.

    This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the RCS Business Messaging API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

    Author:
    Google, Inc.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

        com.google.api.client.util.GenericData.Flags

      • Nested classes/interfaces inherited from class java.util.AbstractMap

        java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Constructor Summary

      Constructors 
      Constructor Description
      AgentEvent()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AgentEvent clone()  
      java.lang.String getEventType()
      The type of the agent event.
      java.lang.String getMessageId()
      The ID of the user message that the agent event pertains to.
      java.lang.String getName()
      This field is set by the RBM platform.
      java.lang.String getSendTime()
      This field is set by the RBM platform.
      AgentEvent set​(java.lang.String fieldName, java.lang.Object value)  
      AgentEvent setEventType​(java.lang.String eventType)
      The type of the agent event.
      AgentEvent setMessageId​(java.lang.String messageId)
      The ID of the user message that the agent event pertains to.
      AgentEvent setName​(java.lang.String name)
      This field is set by the RBM platform.
      AgentEvent setSendTime​(java.lang.String sendTime)
      This field is set by the RBM platform.

      • Methods inherited from class com.google.api.client.json.GenericJson

        getFactory, setFactory, toPrettyString, toString

      • Methods inherited from class com.google.api.client.util.GenericData

        entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

      • Methods inherited from class java.util.AbstractMap

        clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.util.Map

        compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

    • Constructor Detail

      • AgentEvent

        public AgentEvent()

    • Method Detail

      • getEventType

        public java.lang.String getEventType()
        The type of the agent event.
        Returns:
        value or null for none

      • setEventType

        public AgentEvent setEventType​(java.lang.String eventType)
        The type of the agent event.
        Parameters:
        eventType - eventType or null for none

      • getMessageId

        public java.lang.String getMessageId()
        The ID of the user message that the agent event pertains to. This field is only applicable for agent events of type READ.
        Returns:
        value or null for none

      • setMessageId

        public AgentEvent setMessageId​(java.lang.String messageId)
        The ID of the user message that the agent event pertains to. This field is only applicable for agent events of type READ.
        Parameters:
        messageId - messageId or null for none

      • getName

        public java.lang.String getName()
        This field is set by the RBM platform. Do not include it when creating an agent event. The field resolves "phones/{E.164}/agentEvents/{eventId}", where {E.164} is the user's phone number in E.164 format and {eventId} is the agent-assigned ID of the agent event.
        Returns:
        value or null for none

      • setName

        public AgentEvent setName​(java.lang.String name)
        This field is set by the RBM platform. Do not include it when creating an agent event. The field resolves "phones/{E.164}/agentEvents/{eventId}", where {E.164} is the user's phone number in E.164 format and {eventId} is the agent-assigned ID of the agent event.
        Parameters:
        name - name or null for none

      • getSendTime

        public java.lang.String getSendTime()
        This field is set by the RBM platform. Do not include it when creating an agent message. The field resolves the time when the event is sent to the user.
        Returns:
        value or null for none

      • setSendTime

        public AgentEvent setSendTime​(java.lang.String sendTime)
        This field is set by the RBM platform. Do not include it when creating an agent message. The field resolves the time when the event is sent to the user.
        Parameters:
        sendTime - sendTime or null for none

      • set

        public AgentEvent set​(java.lang.String fieldName,
                      java.lang.Object value)
        Overrides:
        set in class com.google.api.client.json.GenericJson

      • clone

        public AgentEvent clone()
        Overrides:
        clone in class com.google.api.client.json.GenericJson