target.apidocs.com.google.api.services.chat.v1.HangoutsChat.Spaces.Messages.Create.html Maven / Gradle / Ivy
HangoutsChat.Spaces.Messages.Create (Google Chat API v1-rev20240829-2.0.0)
com.google.api.services.chat.v1
Class HangoutsChat.Spaces.Messages.Create
- java.lang.Object
-
- java.util.AbstractMap<String,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.chat.v1.HangoutsChatRequest<Message>
-
- com.google.api.services.chat.v1.HangoutsChat.Spaces.Messages.Create
-
- Enclosing class:
- HangoutsChat.Spaces.Messages
public class HangoutsChat.Spaces.Messages.Create
extends HangoutsChatRequest<Message>
-
-
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
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected Create(String parent,
Message content)
Creates a message in a Google Chat space.
-
Method Summary
-
Methods inherited from class com.google.api.services.chat.v1.HangoutsChatRequest
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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream
-
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, 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
-
Create
protected Create(String parent,
Message content)
Creates a message in a Google Chat space. For an example, see [Send a
message](https://developers.google.com/workspace/chat/create-messages). The `create()` method
requires either user or app authentication. Chat attributes the message sender differently
depending on the type of authentication that you use in your request. The following image shows
how Chat attributes a message when you use app authentication. Chat displays the Chat app as
the message sender. The content of the message can contain text (`text`), cards (`cardsV2`),
and accessory widgets (`accessoryWidgets`).  The
following image shows how Chat attributes a message when you use user authentication. Chat
displays the user as the message sender and attributes the Chat app to the message by
displaying its name. The content of message can only contain text (`text`). 
The maximum message size, including the message contents, is 32,000 bytes.
Create a request for the method "messages.create".
This request holds the parameters needed by the the chat server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation. HangoutsChat.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must
be called to initialize this instance immediately after invoking the constructor.
- Parameters:
parent - Required. The resource name of the space in which to create a message. Format: `spaces/{space}`content - the Message- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public HangoutsChat.Spaces.Messages.Create set$Xgafv(String $Xgafv)
Description copied from class: HangoutsChatRequest
V1 error format.
- Overrides:
set$Xgafv in class HangoutsChatRequest<Message>
-
setAccessToken
public HangoutsChat.Spaces.Messages.Create setAccessToken(String accessToken)
Description copied from class: HangoutsChatRequest
OAuth access token.
- Overrides:
setAccessToken in class HangoutsChatRequest<Message>
-
setAlt
public HangoutsChat.Spaces.Messages.Create setAlt(String alt)
Description copied from class: HangoutsChatRequest
Data format for response.
- Overrides:
setAlt in class HangoutsChatRequest<Message>
-
setCallback
public HangoutsChat.Spaces.Messages.Create setCallback(String callback)
Description copied from class: HangoutsChatRequest
JSONP
- Overrides:
setCallback in class HangoutsChatRequest<Message>
-
setFields
public HangoutsChat.Spaces.Messages.Create setFields(String fields)
Description copied from class: HangoutsChatRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class HangoutsChatRequest<Message>
-
setKey
public HangoutsChat.Spaces.Messages.Create setKey(String key)
Description copied from class: HangoutsChatRequest
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 HangoutsChatRequest<Message>
-
setOauthToken
public HangoutsChat.Spaces.Messages.Create setOauthToken(String oauthToken)
Description copied from class: HangoutsChatRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class HangoutsChatRequest<Message>
-
setPrettyPrint
public HangoutsChat.Spaces.Messages.Create setPrettyPrint(Boolean prettyPrint)
Description copied from class: HangoutsChatRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class HangoutsChatRequest<Message>
-
setQuotaUser
public HangoutsChat.Spaces.Messages.Create setQuotaUser(String quotaUser)
Description copied from class: HangoutsChatRequest
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 HangoutsChatRequest<Message>
-
setUploadType
public HangoutsChat.Spaces.Messages.Create setUploadType(String uploadType)
Description copied from class: HangoutsChatRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class HangoutsChatRequest<Message>
-
setUploadProtocol
public HangoutsChat.Spaces.Messages.Create setUploadProtocol(String uploadProtocol)
Description copied from class: HangoutsChatRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class HangoutsChatRequest<Message>
-
getParent
public String getParent()
Required. The resource name of the space in which to create a message. Format: `spaces/{space}`
-
setParent
public HangoutsChat.Spaces.Messages.Create setParent(String parent)
Required. The resource name of the space in which to create a message. Format:
`spaces/{space}`
-
getMessageId
public String getMessageId()
Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without
needing to store the system-assigned ID in the message's resource name (represented in the message
`name` field). The value for this field must meet the following requirements: * Begins with
`client-`. For example, `client-custom-name` is a valid custom ID, but `custom-name` is not. *
Contains up to 63 characters and only lowercase letters, numbers, and hyphens. * Is unique within a
space. A Chat app can't use the same custom ID for different messages. For details, see [Name a
message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
-
setMessageId
public HangoutsChat.Spaces.Messages.Create setMessageId(String messageId)
Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message
without needing to store the system-assigned ID in the message's resource name
(represented in the message `name` field). The value for this field must meet the
following requirements: * Begins with `client-`. For example, `client-custom-name` is a
valid custom ID, but `custom-name` is not. * Contains up to 63 characters and only
lowercase letters, numbers, and hyphens. * Is unique within a space. A Chat app can't use
the same custom ID for different messages. For details, see [Name a
message](https://developers.google.com/workspace/chat/create-
messages#name_a_created_message).
-
getMessageReplyOption
public String getMessageReplyOption()
Optional. Specifies whether a message starts a thread or replies to one. Only supported in named
spaces.
-
setMessageReplyOption
public HangoutsChat.Spaces.Messages.Create setMessageReplyOption(String messageReplyOption)
Optional. Specifies whether a message starts a thread or replies to one. Only supported
in named spaces.
-
getRequestId
public String getRequestId()
Optional. A unique request ID for this message. Specifying an existing request ID returns the
message created with that ID instead of creating a new message.
-
setRequestId
public HangoutsChat.Spaces.Messages.Create setRequestId(String requestId)
Optional. A unique request ID for this message. Specifying an existing request ID returns
the message created with that ID instead of creating a new message.
-
getThreadKey
public String getThreadKey()
Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000
characters. To start or add to a thread, create a message and specify a `threadKey` or the
thread.name. For example usage, see [Start or reply to a message
thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).
-
setThreadKey
public HangoutsChat.Spaces.Messages.Create setThreadKey(String threadKey)
Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to
4000 characters. To start or add to a thread, create a message and specify a `threadKey`
or the thread.name. For example usage, see [Start or reply to a message
thread](https://developers.google.com/workspace/chat/create-messages#create-message-
thread).
-
set
public HangoutsChat.Spaces.Messages.Create set(String parameterName,
Object value)
- Overrides:
set in class HangoutsChatRequest<Message>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy