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

Class RCSBusinessMessaging.Phones.GetCapabilities

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<Capabilities>

com.google.api.services.rcsbusinessmessaging.v1.RCSBusinessMessaging.Phones.GetCapabilities

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

RCSBusinessMessaging.Phones

public class RCSBusinessMessaging.Phones.GetCapabilities
extends RCSBusinessMessagingRequest<Capabilities>

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GetCapabilities(java.lang.String name)	Get the RBM-related capabilities of a user.

Method Summary

Modifier and Type	Method	Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.String	getAgentId()	Optional.
java.lang.String	getName()	This field resolves to "phones/{E.164}/capabilities", where {E.164} is the user's phone number in E.164 format.
java.lang.String	getRequestId()	The unique ID of the request, assigned by the agent.
RCSBusinessMessaging.Phones.GetCapabilities	set(java.lang.String parameterName, java.lang.Object value)
RCSBusinessMessaging.Phones.GetCapabilities	set$Xgafv(java.lang.String $Xgafv)	V1 error format.
RCSBusinessMessaging.Phones.GetCapabilities	setAccessToken(java.lang.String accessToken)	OAuth access token.
RCSBusinessMessaging.Phones.GetCapabilities	setAgentId(java.lang.String agentId)	Optional.
RCSBusinessMessaging.Phones.GetCapabilities	setAlt(java.lang.String alt)	Data format for response.
RCSBusinessMessaging.Phones.GetCapabilities	setCallback(java.lang.String callback)	JSONP
RCSBusinessMessaging.Phones.GetCapabilities	setFields(java.lang.String fields)	Selector specifying which fields to include in a partial response.
RCSBusinessMessaging.Phones.GetCapabilities	setKey(java.lang.String key)	API key.
RCSBusinessMessaging.Phones.GetCapabilities	setName(java.lang.String name)	This field resolves to "phones/{E.164}/capabilities", where {E.164} is the user's phone number in E.164 format.
RCSBusinessMessaging.Phones.GetCapabilities	setOauthToken(java.lang.String oauthToken)	OAuth 2.0 token for the current user.
RCSBusinessMessaging.Phones.GetCapabilities	setPrettyPrint(java.lang.Boolean prettyPrint)	Returns response with indentations and line breaks.
RCSBusinessMessaging.Phones.GetCapabilities	setQuotaUser(java.lang.String quotaUser)	Available to use for quota purposes for server-side applications.
RCSBusinessMessaging.Phones.GetCapabilities	setRequestId(java.lang.String requestId)	The unique ID of the request, assigned by the agent.
RCSBusinessMessaging.Phones.GetCapabilities	setUploadProtocol(java.lang.String uploadProtocol)	Upload protocol for media (e.g.
RCSBusinessMessaging.Phones.GetCapabilities	setUploadType(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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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

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

GetCapabilities

protected GetCapabilities(java.lang.String name)

Get the RBM-related capabilities of a user. The returned payload specifies whether a user can be reached with RBM and, if so, which RBM features the user supports. If the user can't be reached with RBM, the RBM platform returns `404 NOT_FOUND`. An agent that isn't launched can only request capabilities for users who are testers of that agent. If an unlaunched agent requests the capabilities of a non-tester, the RBM platform returns `403 PERMISSION_DENIED`. Create a request for the method "phones.getCapabilities". This request holds the parameters needed by the the rcsbusinessmessaging server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

GetCapabilities#initialize(com.google.api.client.googleapis.services.Abst ractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

name - This field resolves to "phones/{E.164}/capabilities", 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 resulting endpoint is https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/capabilities.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Capabilities>

Throws:

java.io.IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Capabilities>

Throws:

java.io.IOException

set$Xgafv

public RCSBusinessMessaging.Phones.GetCapabilities set$Xgafv(java.lang.String $Xgafv)

Description copied from class: RCSBusinessMessagingRequest

V1 error format.

Overrides:

set$Xgafv in class RCSBusinessMessagingRequest<Capabilities>

setAccessToken

public RCSBusinessMessaging.Phones.GetCapabilities setAccessToken(java.lang.String accessToken)

Description copied from class: RCSBusinessMessagingRequest

OAuth access token.

Overrides:

setAccessToken in class RCSBusinessMessagingRequest<Capabilities>

setAlt

public RCSBusinessMessaging.Phones.GetCapabilities setAlt(java.lang.String alt)

Description copied from class: RCSBusinessMessagingRequest

Data format for response.

Overrides:

setAlt in class RCSBusinessMessagingRequest<Capabilities>

setCallback

public RCSBusinessMessaging.Phones.GetCapabilities setCallback(java.lang.String callback)

Description copied from class: RCSBusinessMessagingRequest

JSONP

Overrides:

setCallback in class RCSBusinessMessagingRequest<Capabilities>

setFields

public RCSBusinessMessaging.Phones.GetCapabilities setFields(java.lang.String fields)

Description copied from class: RCSBusinessMessagingRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class RCSBusinessMessagingRequest<Capabilities>

setKey

public RCSBusinessMessaging.Phones.GetCapabilities setKey(java.lang.String key)

Description copied from class: RCSBusinessMessagingRequest

API 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:

setKey in class RCSBusinessMessagingRequest<Capabilities>

setOauthToken

public RCSBusinessMessaging.Phones.GetCapabilities setOauthToken(java.lang.String oauthToken)

Description copied from class: RCSBusinessMessagingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class RCSBusinessMessagingRequest<Capabilities>

setPrettyPrint

public RCSBusinessMessaging.Phones.GetCapabilities setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: RCSBusinessMessagingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class RCSBusinessMessagingRequest<Capabilities>

setQuotaUser

public RCSBusinessMessaging.Phones.GetCapabilities setQuotaUser(java.lang.String quotaUser)

Description copied from class: RCSBusinessMessagingRequest

Available 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:

setQuotaUser in class RCSBusinessMessagingRequest<Capabilities>

setUploadType

public RCSBusinessMessaging.Phones.GetCapabilities setUploadType(java.lang.String uploadType)

Description copied from class: RCSBusinessMessagingRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class RCSBusinessMessagingRequest<Capabilities>

setUploadProtocol

public RCSBusinessMessaging.Phones.GetCapabilities setUploadProtocol(java.lang.String uploadProtocol)

Description copied from class: RCSBusinessMessagingRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class RCSBusinessMessagingRequest<Capabilities>

getName

public java.lang.String getName()

This field resolves to "phones/{E.164}/capabilities", 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 resulting endpoint is https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/capabilities.

setName

public RCSBusinessMessaging.Phones.GetCapabilities setName(java.lang.String name)

This field resolves to "phones/{E.164}/capabilities", 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 resulting endpoint is https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/capabilities.

getRequestId

public java.lang.String getRequestId()

The unique ID of the request, assigned by the agent. This must be a UUID, as defined in https://tools.ietf.org/html/rfc4122. If the request ID matches an ID that the agent used for a previous request, the RBM platform ignores the new request.

setRequestId

public RCSBusinessMessaging.Phones.GetCapabilities setRequestId(java.lang.String requestId)

The unique ID of the request, assigned by the agent. This must be a UUID, as defined in https://tools.ietf.org/html/rfc4122. If the request ID matches an ID that the agent used for a previous request, the RBM platform ignores the new request.

getAgentId

public java.lang.String getAgentId()

Optional. The agent's unique identifier. Defined by RCS Business Messaging.

setAgentId

public RCSBusinessMessaging.Phones.GetCapabilities setAgentId(java.lang.String agentId)

Optional. The agent's unique identifier. Defined by RCS Business Messaging.

set

public RCSBusinessMessaging.Phones.GetCapabilities set(java.lang.String parameterName,
                                                       java.lang.Object value)

Overrides:

set in class RCSBusinessMessagingRequest<Capabilities>