Class RCSBusinessMessaging.Phones.AgentMessages.Delete
- 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<Empty>
-
- com.google.api.services.rcsbusinessmessaging.v1.RCSBusinessMessaging.Phones.AgentMessages.Delete
-
- All Implemented Interfaces:
java.lang.Cloneable,java.util.Map<java.lang.String,java.lang.Object>
- Enclosing class:
- RCSBusinessMessaging.Phones.AgentMessages
public class RCSBusinessMessaging.Phones.AgentMessages.Delete extends RCSBusinessMessagingRequest<Empty>
-
-
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 protectedDelete(java.lang.String name)Revokes an agent message that has been sent but not yet delivered.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetAgentId()Optional.java.lang.StringgetName()" phones/{E.164}/agentMessages/{messageId}", where {E.164} is the user's phone number in E.164 " format and {messageId} is the agent-assigned ID of the agent message that should be revoked.RCSBusinessMessaging.Phones.AgentMessages.Deleteset(java.lang.String parameterName, java.lang.Object value)RCSBusinessMessaging.Phones.AgentMessages.Deleteset$Xgafv(java.lang.String $Xgafv)V1 error format.RCSBusinessMessaging.Phones.AgentMessages.DeletesetAccessToken(java.lang.String accessToken)OAuth access token.RCSBusinessMessaging.Phones.AgentMessages.DeletesetAgentId(java.lang.String agentId)Optional.RCSBusinessMessaging.Phones.AgentMessages.DeletesetAlt(java.lang.String alt)Data format for response.RCSBusinessMessaging.Phones.AgentMessages.DeletesetCallback(java.lang.String callback)JSONPRCSBusinessMessaging.Phones.AgentMessages.DeletesetFields(java.lang.String fields)Selector specifying which fields to include in a partial response.RCSBusinessMessaging.Phones.AgentMessages.DeletesetKey(java.lang.String key)API key.RCSBusinessMessaging.Phones.AgentMessages.DeletesetName(java.lang.String name)"phones/{E.164}/agentMessages/{messageId}", where {E.164} is the user's phone number in E.164 format and {messageId} is the agent-assigned ID of the agent message that should be revoked.RCSBusinessMessaging.Phones.AgentMessages.DeletesetOauthToken(java.lang.String oauthToken)OAuth 2.0 token for the current user.RCSBusinessMessaging.Phones.AgentMessages.DeletesetPrettyPrint(java.lang.Boolean prettyPrint)Returns response with indentations and line breaks.RCSBusinessMessaging.Phones.AgentMessages.DeletesetQuotaUser(java.lang.String quotaUser)Available to use for quota purposes for server-side applications.RCSBusinessMessaging.Phones.AgentMessages.DeletesetUploadProtocol(java.lang.String uploadProtocol)Upload protocol for media (e.g.RCSBusinessMessaging.Phones.AgentMessages.DeletesetUploadType(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
-
Delete
protected Delete(java.lang.String name)
Revokes an agent message that has been sent but not yet delivered. If the RBM platform successfully revokes a message, then the message is deleted from the user’s message queue and is never delivered. This method immediately returns 200 OK, whether or not the message was successfully revoked. There is a small chance that the agent may initiate a revocation while the RBM platform is in the process of delivering the message. In these rare cases, the agent receives a DELIVERED user event for the message shortly after initiating the revocation request. Create a request for the method "agentMessages.delete". 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:
name- "phones/{E.164}/agentMessages/{messageId}", where {E.164} is the user's phone number in E.164 format and {messageId} is the agent-assigned ID of the agent message that should be revoked. For example, with the US phone number +1-222-333-4444 and an agent message with the ID "12345xyz", the resulting endpoint would be https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages/12345xyz.- Since:
- 1.13
-
-
Method Detail
-
set$Xgafv
public RCSBusinessMessaging.Phones.AgentMessages.Delete set$Xgafv(java.lang.String $Xgafv)
Description copied from class:RCSBusinessMessagingRequestV1 error format.- Overrides:
set$Xgafvin classRCSBusinessMessagingRequest<Empty>
-
setAccessToken
public RCSBusinessMessaging.Phones.AgentMessages.Delete setAccessToken(java.lang.String accessToken)
Description copied from class:RCSBusinessMessagingRequestOAuth access token.- Overrides:
setAccessTokenin classRCSBusinessMessagingRequest<Empty>
-
setAlt
public RCSBusinessMessaging.Phones.AgentMessages.Delete setAlt(java.lang.String alt)
Description copied from class:RCSBusinessMessagingRequestData format for response.- Overrides:
setAltin classRCSBusinessMessagingRequest<Empty>
-
setCallback
public RCSBusinessMessaging.Phones.AgentMessages.Delete setCallback(java.lang.String callback)
Description copied from class:RCSBusinessMessagingRequestJSONP- Overrides:
setCallbackin classRCSBusinessMessagingRequest<Empty>
-
setFields
public RCSBusinessMessaging.Phones.AgentMessages.Delete setFields(java.lang.String fields)
Description copied from class:RCSBusinessMessagingRequestSelector specifying which fields to include in a partial response.- Overrides:
setFieldsin classRCSBusinessMessagingRequest<Empty>
-
setKey
public RCSBusinessMessaging.Phones.AgentMessages.Delete 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<Empty>
-
setOauthToken
public RCSBusinessMessaging.Phones.AgentMessages.Delete setOauthToken(java.lang.String oauthToken)
Description copied from class:RCSBusinessMessagingRequestOAuth 2.0 token for the current user.- Overrides:
setOauthTokenin classRCSBusinessMessagingRequest<Empty>
-
setPrettyPrint
public RCSBusinessMessaging.Phones.AgentMessages.Delete setPrettyPrint(java.lang.Boolean prettyPrint)
Description copied from class:RCSBusinessMessagingRequestReturns response with indentations and line breaks.- Overrides:
setPrettyPrintin classRCSBusinessMessagingRequest<Empty>
-
setQuotaUser
public RCSBusinessMessaging.Phones.AgentMessages.Delete 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<Empty>
-
setUploadType
public RCSBusinessMessaging.Phones.AgentMessages.Delete setUploadType(java.lang.String uploadType)
Description copied from class:RCSBusinessMessagingRequestLegacy upload protocol for media (e.g. "media", "multipart").- Overrides:
setUploadTypein classRCSBusinessMessagingRequest<Empty>
-
setUploadProtocol
public RCSBusinessMessaging.Phones.AgentMessages.Delete setUploadProtocol(java.lang.String uploadProtocol)
Description copied from class:RCSBusinessMessagingRequestUpload protocol for media (e.g. "raw", "multipart").- Overrides:
setUploadProtocolin classRCSBusinessMessagingRequest<Empty>
-
getName
public java.lang.String getName()
" phones/{E.164}/agentMessages/{messageId}", where {E.164} is the user's phone number in E.164 " format and {messageId} is the agent-assigned ID of the agent message that should be revoked. For " example, with the US phone number +1-222-333-4444 and an agent message with the ID "12345xyz", the " resulting endpoint would be " https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages/12345xyz. "
-
setName
public RCSBusinessMessaging.Phones.AgentMessages.Delete setName(java.lang.String name)
"phones/{E.164}/agentMessages/{messageId}", where {E.164} is the user's phone number in E.164 format and {messageId} is the agent-assigned ID of the agent message that should be revoked. For example, with the US phone number +1-222-333-4444 and an agent message with the ID "12345xyz", the resulting endpoint would be https://rcsbusinessmessaging.googleapi s.com/v1/phones/+12223334444/agentMessages/12345xyz.
-
getAgentId
public java.lang.String getAgentId()
Optional. The agent's unique identifier. Defined by RCS Business Messaging.
-
setAgentId
public RCSBusinessMessaging.Phones.AgentMessages.Delete setAgentId(java.lang.String agentId)
Optional. The agent's unique identifier. Defined by RCS Business Messaging.
-
set
public RCSBusinessMessaging.Phones.AgentMessages.Delete set(java.lang.String parameterName, java.lang.Object value)
- Overrides:
setin classRCSBusinessMessagingRequest<Empty>
-
-