Class RCSBusinessMessaging.Phones.AgentEvents.Create
- java.lang.Object
-
- java.util.AbstractMap<java.lang.String,java.lang.Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
-
- com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
-
- com.google.api.services.rcsbusinessmessaging.v1.RCSBusinessMessagingRequest<AgentEvent>
-
- com.google.api.services.rcsbusinessmessaging.v1.RCSBusinessMessaging.Phones.AgentEvents.Create
-
- All Implemented Interfaces:
java.lang.Cloneable,java.util.Map<java.lang.String,java.lang.Object>
- Enclosing class:
- RCSBusinessMessaging.Phones.AgentEvents
public class RCSBusinessMessaging.Phones.AgentEvents.Create extends RCSBusinessMessagingRequest<AgentEvent>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedCreate(java.lang.String parent, AgentEvent content)Sends an event from the agent to a user.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetAgentId()Optional.java.lang.StringgetEventId()The ID of the event, assigned by the agent.java.lang.StringgetParent()" phones/{E.164}", where {E.164} is the user's phone number in E.164 format.RCSBusinessMessaging.Phones.AgentEvents.Createset(java.lang.String parameterName, java.lang.Object value)RCSBusinessMessaging.Phones.AgentEvents.Createset$Xgafv(java.lang.String $Xgafv)V1 error format.RCSBusinessMessaging.Phones.AgentEvents.CreatesetAccessToken(java.lang.String accessToken)OAuth access token.RCSBusinessMessaging.Phones.AgentEvents.CreatesetAgentId(java.lang.String agentId)Optional.RCSBusinessMessaging.Phones.AgentEvents.CreatesetAlt(java.lang.String alt)Data format for response.RCSBusinessMessaging.Phones.AgentEvents.CreatesetCallback(java.lang.String callback)JSONPRCSBusinessMessaging.Phones.AgentEvents.CreatesetEventId(java.lang.String eventId)The ID of the event, assigned by the agent.RCSBusinessMessaging.Phones.AgentEvents.CreatesetFields(java.lang.String fields)Selector specifying which fields to include in a partial response.RCSBusinessMessaging.Phones.AgentEvents.CreatesetKey(java.lang.String key)API key.RCSBusinessMessaging.Phones.AgentEvents.CreatesetOauthToken(java.lang.String oauthToken)OAuth 2.0 token for the current user.RCSBusinessMessaging.Phones.AgentEvents.CreatesetParent(java.lang.String parent)"phones/{E.164}", where {E.164} is the user's phone number in E.164 format.RCSBusinessMessaging.Phones.AgentEvents.CreatesetPrettyPrint(java.lang.Boolean prettyPrint)Returns response with indentations and line breaks.RCSBusinessMessaging.Phones.AgentEvents.CreatesetQuotaUser(java.lang.String quotaUser)Available to use for quota purposes for server-side applications.RCSBusinessMessaging.Phones.AgentEvents.CreatesetUploadProtocol(java.lang.String uploadProtocol)Upload protocol for media (e.g.RCSBusinessMessaging.Phones.AgentEvents.CreatesetUploadType(java.lang.String uploadType)Legacy upload protocol for media (e.g.-
Methods inherited from class com.google.api.services.rcsbusinessmessaging.v1.RCSBusinessMessagingRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders
-
Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue
-
Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue
-
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values
-
-
-
-
Constructor Detail
-
Create
protected Create(java.lang.String parent, AgentEvent content)Sends an event from the agent to a user. Agent events can be used to indicate that the agent has read a message from the user or that the agent is in the process of typing (which adds a human element to the RBM experience). If RBM can't reach the user, the RBM platform returns `404 NOT_FOUND`. Unlike agent messages, agent events cannot be revoked after sending. Create a request for the method "agentEvents.create". This request holds the parameters needed by the the rcsbusinessmessaging server. After setting any optional parameters, call theAbstractGoogleClientRequest.execute()method to invoke the remote operation.RCSBusinessMessaging.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)must be called to initialize this instance immediately after invoking the constructor.- Parameters:
parent- "phones/{E.164}", where {E.164} is the user's phone number in E.164 format. For example, for a user with the US phone number +1-222-333-4444, the value would be phones/+12223334444, and the resulting endpoint would be https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentEvents.content- theAgentEvent- Since:
- 1.13
-
-
Method Detail
-
set$Xgafv
public RCSBusinessMessaging.Phones.AgentEvents.Create set$Xgafv(java.lang.String $Xgafv)
Description copied from class:RCSBusinessMessagingRequestV1 error format.- Overrides:
set$Xgafvin classRCSBusinessMessagingRequest<AgentEvent>
-
setAccessToken
public RCSBusinessMessaging.Phones.AgentEvents.Create setAccessToken(java.lang.String accessToken)
Description copied from class:RCSBusinessMessagingRequestOAuth access token.- Overrides:
setAccessTokenin classRCSBusinessMessagingRequest<AgentEvent>
-
setAlt
public RCSBusinessMessaging.Phones.AgentEvents.Create setAlt(java.lang.String alt)
Description copied from class:RCSBusinessMessagingRequestData format for response.- Overrides:
setAltin classRCSBusinessMessagingRequest<AgentEvent>
-
setCallback
public RCSBusinessMessaging.Phones.AgentEvents.Create setCallback(java.lang.String callback)
Description copied from class:RCSBusinessMessagingRequestJSONP- Overrides:
setCallbackin classRCSBusinessMessagingRequest<AgentEvent>
-
setFields
public RCSBusinessMessaging.Phones.AgentEvents.Create setFields(java.lang.String fields)
Description copied from class:RCSBusinessMessagingRequestSelector specifying which fields to include in a partial response.- Overrides:
setFieldsin classRCSBusinessMessagingRequest<AgentEvent>
-
setKey
public RCSBusinessMessaging.Phones.AgentEvents.Create setKey(java.lang.String key)
Description copied from class:RCSBusinessMessagingRequestAPI key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.- Overrides:
setKeyin classRCSBusinessMessagingRequest<AgentEvent>
-
setOauthToken
public RCSBusinessMessaging.Phones.AgentEvents.Create setOauthToken(java.lang.String oauthToken)
Description copied from class:RCSBusinessMessagingRequestOAuth 2.0 token for the current user.- Overrides:
setOauthTokenin classRCSBusinessMessagingRequest<AgentEvent>
-
setPrettyPrint
public RCSBusinessMessaging.Phones.AgentEvents.Create setPrettyPrint(java.lang.Boolean prettyPrint)
Description copied from class:RCSBusinessMessagingRequestReturns response with indentations and line breaks.- Overrides:
setPrettyPrintin classRCSBusinessMessagingRequest<AgentEvent>
-
setQuotaUser
public RCSBusinessMessaging.Phones.AgentEvents.Create setQuotaUser(java.lang.String quotaUser)
Description copied from class:RCSBusinessMessagingRequestAvailable to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.- Overrides:
setQuotaUserin classRCSBusinessMessagingRequest<AgentEvent>
-
setUploadType
public RCSBusinessMessaging.Phones.AgentEvents.Create setUploadType(java.lang.String uploadType)
Description copied from class:RCSBusinessMessagingRequestLegacy upload protocol for media (e.g. "media", "multipart").- Overrides:
setUploadTypein classRCSBusinessMessagingRequest<AgentEvent>
-
setUploadProtocol
public RCSBusinessMessaging.Phones.AgentEvents.Create setUploadProtocol(java.lang.String uploadProtocol)
Description copied from class:RCSBusinessMessagingRequestUpload protocol for media (e.g. "raw", "multipart").- Overrides:
setUploadProtocolin classRCSBusinessMessagingRequest<AgentEvent>
-
getParent
public java.lang.String getParent()
" phones/{E.164}", where {E.164} is the user's phone number in E.164 format. For example, for a user " with the US phone number +1-222-333-4444, the value would be phones/+12223334444, and the " resulting endpoint would be " https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentEvents. "
-
setParent
public RCSBusinessMessaging.Phones.AgentEvents.Create setParent(java.lang.String parent)
"phones/{E.164}", where {E.164} is the user's phone number in E.164 format. For example, for a user with the US phone number +1-222-333-4444, the value would be phones/+12223334444, and the resulting endpoint would be https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentEvents.
-
getEventId
public java.lang.String getEventId()
The ID of the event, assigned by the agent. This must be a UUID, as defined in https://tools.ietf.org/html/rfc4122. The RBM platform ignores any agent message sent with an ID that was used by an earlier message or event sent from the same agent.
-
setEventId
public RCSBusinessMessaging.Phones.AgentEvents.Create setEventId(java.lang.String eventId)
The ID of the event, assigned by the agent. This must be a UUID, as defined in https://tools.ietf.org/html/rfc4122. The RBM platform ignores any agent message sent with an ID that was used by an earlier message or event sent from the same agent.
-
getAgentId
public java.lang.String getAgentId()
Optional. The agent's unique identifier. Defined by RCS Business Messaging.
-
setAgentId
public RCSBusinessMessaging.Phones.AgentEvents.Create setAgentId(java.lang.String agentId)
Optional. The agent's unique identifier. Defined by RCS Business Messaging.
-
set
public RCSBusinessMessaging.Phones.AgentEvents.Create set(java.lang.String parameterName, java.lang.Object value)
- Overrides:
setin classRCSBusinessMessagingRequest<AgentEvent>
-
-