Package com.google.chat.v1 (0.44.0)
Client Classes
Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.
| Client | Description |
|---|---|
| com. |
Service Description: Enables developers to build Chat apps and integrations on Google Chat
Platform. This class provides the ability to make remote calls to the backing service through method |
Settings Classes
Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.
| Settings | Description |
|---|---|
| com. |
Settings class to configure an instance of ChatServiceClient
. The default instance has everything set to sensible defaults: |
| com. |
Represents the access setting of the space. |
| com. |
Permission settings that you can specify when updating an existing named space. |
| com. |
Predefined permission settings that you can only specify when creating a named space. More settings might be added in the future. For details about permission settings for named spaces, see Learn about |
Classes
| Class | Description |
|---|---|
| com. |
One or more interactive widgets that appear at the bottom of a message. For details, see Add interactive widgets at the bottom of a message . |
| com. |
One or more interactive widgets that appear at the bottom of a message. For details, see Add interactive widgets at the bottom of a message . |
| com. |
Parameters that a Chat app can use to configure how its response is posted. |
| com. |
Parameters that a Chat app can use to configure how its response is posted. |
| com. |
List of widget autocomplete results. |
| com. |
List of widget autocomplete results. |
| com. |
For selectionInput
widgets, returns autocomplete suggestions for a
multiselect menu. |
| com. |
For selectionInput
widgets, returns autocomplete suggestions for a
multiselect menu. |
| com. |
Represents the status for a request to either invoke or submit a dialog . |
| com. |
Represents the status for a request to either invoke or submit a dialog . |
| com. |
|
| com. |
Output only. Annotations can be associated with the plain-text body of the
message or with chips that link to Google Workspace resources like Google
Docs or Sheets with start_index
and length
of 0. To add basic formatting |
| com. |
Output only. Annotations can be associated with the plain-text body of the
message or with chips that link to Google Workspace resources like Google
Docs or Sheets with start_index
and length
of 0. To add basic formatting |
| com. |
|
| com. |
A GIF image that's specified by a URL. |
| com. |
A GIF image that's specified by a URL. |
| com. |
An attachment in Google Chat. |
| com. |
An attachment in Google Chat. |
| com. |
A reference to the attachment data. |
| com. |
A reference to the attachment data. |
| com. |
|
| com. |
Builder for spaces/{space}/messages/{message}/attachments/{attachment}. |
| com. |
|
| com. |
Data for Calendar event links. |
| com. |
Data for Calendar event links. |
| com. |
A card in a Google Chat message. |
| com. |
A card in a Google Chat message. |
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
Enables developers to build Chat apps and integrations on Google Chat Platform. |
| com. |
Base class for the server implementation of the service ChatService. Enables developers to build Chat apps and |
| com. |
|
| com. |
Builder for ChatServiceSettings. |
| com. |
Data for Chat space links. |
| com. |
Data for Chat space links. |
| com. |
Request message for completing the import process for a space. |
| com. |
Request message for completing the import process for a space. |
| com. |
Response message for completing the import process for a space. |
| com. |
Response message for completing the import process for a space. |
| com. |
The markup for developers to specify the contents of a contextual AddOn. |
| com. |
The markup for developers to specify the contents of a contextual AddOn. |
| com. |
A card is a UI element that can contain UI widgets such as text and images. |
| com. |
A card is a UI element that can contain UI widgets such as text and images. |
| com. |
A card action is the action associated with the card. For an invoice card, a typical action would be: delete invoice, email invoice or open the |
| com. |
A card action is the action associated with the card. For an invoice card, a typical action would be: delete invoice, email invoice or open the |
| com. |
Protobuf type google.chat.v1.ContextualAddOnMarkup.Card.CardHeader
|
| com. |
Protobuf type google.chat.v1.ContextualAddOnMarkup.Card.CardHeader
|
| com. |
A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so |
| com. |
A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so |
| com. |
|
| com. |
A request to create a custom emoji. |
| com. |
A request to create a custom emoji. |
| com. |
Request message for creating a membership. |
| com. |
Request message for creating a membership. |
| com. |
Creates a message. |
| com. |
Creates a message. |
| com. |
Creates a reaction to a message. |
| com. |
Creates a reaction to a message. |
| com. |
A request to create a named space with no members. |
| com. |
A request to create a named space with no members. |
| com. |
Represents a custom emoji . |
| com. |
Represents a custom emoji . |
| com. |
Payload data for the custom emoji. |
| com. |
Payload data for the custom emoji. |
| com. |
Annotation metadata for custom emoji. |
| com. |
Annotation metadata for custom emoji. |
| com. |
|
| com. |
Builder for customEmojis/{custom_emoji}. |
| com. |
Request for deleting a custom emoji. |
| com. |
Request for deleting a custom emoji. |
| com. |
Request to delete a membership in a space. |
| com. |
Request to delete a membership in a space. |
| com. |
Request to delete a message. |
| com. |
Request to delete a message. |
| com. |
Deletes a reaction to a message. |
| com. |
Deletes a reaction to a message. |
| com. |
Request for deleting a space. |
| com. |
Request for deleting a space. |
| com. |
Information about a deleted message. A message is deleted when delete_time
is set. |
| com. |
Information about a deleted message. A message is deleted when delete_time
is set. |
| com. |
|
| com. |
Wrapper around the card body of the dialog. |
| com. |
Wrapper around the card body of the dialog. |
| com. |
Contains a dialog and request status code. |
| com. |
Contains a dialog and request status code. |
| com. |
A reference to the data of a drive attachment. |
| com. |
A reference to the data of a drive attachment. |
| com. |
Data for Google Drive links. |
| com. |
Data for Google Drive links. |
| com. |
An emoji that is used as a reaction to a message. |
| com. |
An emoji that is used as a reaction to a message. |
| com. |
The number of people who reacted to a message with a specific emoji. |
| com. |
The number of people who reacted to a message with a specific emoji. |
| com. |
|
| com. |
A request to get direct message space based on the user resource. |
| com. |
A request to get direct message space based on the user resource. |
| com. |
Request to get an attachment. |
| com. |
Request to get an attachment. |
| com. |
A request to return a single custom emoji. |
| com. |
A request to return a single custom emoji. |
| com. |
Request to get a membership of a space. |
| com. |
Request to get a membership of a space. |
| com. |
Request to get a message. |
| com. |
Request to get a message. |
| com. |
Request message for getting a space event. |
| com. |
Request message for getting a space event. |
| com. |
Request message to get space notification setting. Only supports getting notification setting for the calling user. |
| com. |
Request message to get space notification setting. Only supports getting notification setting for the calling user. |
| com. |
Request message for GetSpaceReadState API. |
| com. |
Request message for GetSpaceReadState API. |
| com. |
A request to return a single space. |
| com. |
A request to return a single space. |
| com. |
Request message for GetThreadReadStateRequest API. |
| com. |
Request message for GetThreadReadStateRequest API. |
| com. |
A Google Group in Google Chat. |
| com. |
A Google Group in Google Chat. |
| com. |
|
| com. |
|
| com. |
A request to return a list of custom emojis. |
| com. |
A request to return a list of custom emojis. |
| com. |
A response to list custom emojis. |
| com. |
A response to list custom emojis. |
| com. |
Request message for listing memberships. |
| com. |
Request message for listing memberships. |
| com. |
Response to list memberships of the space. |
| com. |
Response to list memberships of the space. |
| com. |
Lists messages in the specified space, that the user is a member of. |
| com. |
Lists messages in the specified space, that the user is a member of. |
| com. |
Response message for listing messages. |
| com. |
Response message for listing messages. |
| com. |
Lists reactions to a message. |
| com. |
Lists reactions to a message. |
| com. |
Response to a list reactions request. |
| com. |
Response to a list reactions request. |
| com. |
Request message for listing space events. |
| com. |
Request message for listing space events. |
| com. |
Response message for listing space events. |
| com. |
Response message for listing space events. |
| com. |
A request to list the spaces the caller is a member of. |
| com. |
A request to list the spaces the caller is a member of. |
| com. |
The response for a list spaces request. |
| com. |
The response for a list spaces request. |
| com. |
A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see Preview links . |
| com. |
A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see Preview links . |
| com. |
|
| com. |
Data for Meet space links. |
| com. |
Data for Meet space links. |
| com. |
Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. |
| com. |
Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. |
| com. |
Event payload for multiple new memberships.
Event type: google.workspace.chat.membership.v1.batchCreated
|
| com. |
Event payload for multiple new memberships.
Event type: google.workspace.chat.membership.v1.batchCreated
|
| com. |
Event payload for multiple deleted memberships.
Event type: google.workspace.chat.membership.v1.batchDeleted
|
| com. |
Event payload for multiple deleted memberships.
Event type: google.workspace.chat.membership.v1.batchDeleted
|
| com. |
Event payload for multiple updated memberships.
Event type: google.workspace.chat.membership.v1.batchUpdated
|
| com. |
Event payload for multiple updated memberships.
Event type: google.workspace.chat.membership.v1.batchUpdated
|
| com. |
Event payload for a new membership.
Event type: google.workspace.chat.membership.v1.created
. |
| com. |
Event payload for a new membership.
Event type: google.workspace.chat.membership.v1.created
. |
| com. |
Event payload for a deleted membership.
Event type: google.workspace.chat.membership.v1.deleted
|
| com. |
Event payload for a deleted membership.
Event type: google.workspace.chat.membership.v1.deleted
|
| com. |
|
| com. |
Builder for spaces/{space}/members/{member}. |
| com. |
|
| com. |
Event payload for an updated membership.
Event type: google.workspace.chat.membership.v1.updated
|
| com. |
Event payload for an updated membership.
Event type: google.workspace.chat.membership.v1.updated
|
| com. |
A message in a Google Chat space. |
| com. |
A message in a Google Chat space. |
| com. |
Event payload for multiple new messages.
Event type: google.workspace.chat.message.v1.batchCreated
|
| com. |
Event payload for multiple new messages.
Event type: google.workspace.chat.message.v1.batchCreated
|
| com. |
Event payload for multiple deleted messages.
Event type: google.workspace.chat.message.v1.batchDeleted
|
| com. |
Event payload for multiple deleted messages.
Event type: google.workspace.chat.message.v1.batchDeleted
|
| com. |
Event payload for multiple updated messages.
Event type: google.workspace.chat.message.v1.batchUpdated
|
| com. |
Event payload for multiple updated messages.
Event type: google.workspace.chat.message.v1.batchUpdated
|
| com. |
Event payload for a new message.
Event type: google.workspace.chat.message.v1.created
|
| com. |
Event payload for a new message.
Event type: google.workspace.chat.message.v1.created
|
| com. |
Event payload for a deleted message.
Event type: google.workspace.chat.message.v1.deleted
|
| com. |
Event payload for a deleted message.
Event type: google.workspace.chat.message.v1.deleted
|
| com. |
|
| com. |
Builder for spaces/{space}/messages/{message}. |
| com. |
|
| com. |
Event payload for an updated message.
Event type: google.workspace.chat.message.v1.updated
|
| com. |
Event payload for an updated message.
Event type: google.workspace.chat.message.v1.updated
|
| com. |
Information about a message that another message quotes. When you create a message, you can quote messages within the same |
| com. |
Information about a message that another message quotes. When you create a message, you can quote messages within the same |
| com. |
A reaction to a message. |
| com. |
A reaction to a message. |
| com. |
Event payload for multiple new reactions.
Event type: google.workspace.chat.reaction.v1.batchCreated
|
| com. |
Event payload for multiple new reactions.
Event type: google.workspace.chat.reaction.v1.batchCreated
|
| com. |
Event payload for multiple deleted reactions.
Event type: google.workspace.chat.reaction.v1.batchDeleted
|
| com. |
Event payload for multiple deleted reactions.
Event type: google.workspace.chat.reaction.v1.batchDeleted
|
| com. |
Event payload for a new reaction.
Event type: google.workspace.chat.reaction.v1.created
|
| com. |
Event payload for a new reaction.
Event type: google.workspace.chat.reaction.v1.created
|
| com. |
Event payload for a deleted reaction.
Type: google.workspace.chat.reaction.v1.deleted
|
| com. |
Event payload for a deleted reaction.
Type: google.workspace.chat.reaction.v1.deleted
|
| com. |
|
| com. |
Builder for spaces/{space}/messages/{message}/reactions/{reaction}. |
| com. |
|
| com. |
A rich link to a resource. Rich links can be associated with the plain-text
body of the message or represent chips that link to Google Workspace
resources like Google Docs or Sheets with start_index
and length
|
| com. |
A rich link to a resource. Rich links can be associated with the plain-text
body of the message or represent chips that link to Google Workspace
resources like Google Docs or Sheets with start_index
and length
|
| com. |
Request to search for a list of spaces based on a query. |
| com. |
Request to search for a list of spaces based on a query. |
| com. |
Response with a list of spaces corresponding to the search spaces request. |
| com. |
Response with a list of spaces corresponding to the search spaces request. |
| com. |
Request to create a space and add specified users to it. |
| com. |
Request to create a space and add specified users to it. |
| com. |
Metadata about a slash command in Google Chat. |
| com. |
Metadata about a slash command in Google Chat. |
| com. |
Annotation metadata for slash commands (/). |
| com. |
Annotation metadata for slash commands (/). |
| com. |
|
| com. |
A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. |
| com. |
Represents the access setting of the space. |
| com. |
A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. |
| com. |
Represents the count of memberships of a space, grouped into categories. |
| com. |
Represents the count of memberships of a space, grouped into categories. |
| com. |
Represents a space permission setting. |
| com. |
Represents a space permission setting. |
| com. |
Permission settings that you can specify when updating an existing named space. |
| com. |
Details about the space including description and rules. |
| com. |
Details about the space including description and rules. |
| com. |
Event payload for multiple updates to a space.
Event type: google.workspace.chat.space.v1.batchUpdated
|
| com. |
Event payload for multiple updates to a space.
Event type: google.workspace.chat.space.v1.batchUpdated
|
| com. |
An event that represents a change or activity in a Google Chat space. To learn more, see Work with events from Google Chat . |
| com. |
An event that represents a change or activity in a Google Chat space. To learn more, see Work with events from Google Chat . |
| com. |
|
| com. |
Builder for spaces/{space}/spaceEvents/{space_event}. |
| com. |
|
| com. |
|
| com. |
Builder for spaces/{space}. |
| com. |
The notification setting of a user in a space. |
| com. |
The notification setting of a user in a space. |
| com. |
|
| com. |
Builder for users/{user}/spaces/{space}/spaceNotificationSetting. |
| com. |
|
| com. |
|
| com. |
A user's read state within a space, used to identify read and unread messages. |
| com. |
A user's read state within a space, used to identify read and unread messages. |
| com. |
|
| com. |
Builder for users/{user}/spaces/{space}/spaceReadState. |
| com. |
|
| com. |
|
| com. |
Event payload for an updated space.
Event type: google.workspace.chat.space.v1.updated
|
| com. |
Event payload for an updated space.
Event type: google.workspace.chat.space.v1.updated
|
| com. |
A thread in a Google Chat space. For example usage, see Start or reply to a message thread . |
| com. |
A thread in a Google Chat space. For example usage, see Start or reply to a message thread . |
| com. |
A user's read state within a thread, used to identify read and unread messages. |
| com. |
A user's read state within a thread, used to identify read and unread messages. |
| com. |
|
| com. |
Builder for users/{user}/spaces/{space}/threads/{thread}/threadReadState. |
| com. |
|
| com. |
Request message for updating a membership. |
| com. |
Request message for updating a membership. |
| com. |
Request to update a message. |
| com. |
Request to update a message. |
| com. |
Request to update the space notification settings. Only supports updating notification setting for the calling user. |
| com. |
Request to update the space notification settings. Only supports updating notification setting for the calling user. |
| com. |
Request message for UpdateSpaceReadState API. |
| com. |
Request message for UpdateSpaceReadState API. |
| com. |
A request to update a single space. |
| com. |
A request to update a single space. |
| com. |
Request to upload an attachment. |
| com. |
Request to upload an attachment. |
| com. |
Response of uploading an attachment. |
| com. |
Response of uploading an attachment. |
| com. |
A user in Google Chat. When returned as an output from a request, if your Chat app authenticates as a |
| com. |
A user in Google Chat. When returned as an output from a request, if your Chat app authenticates as a |
| com. |
Annotation metadata for user mentions (@). |
| com. |
Annotation metadata for user mentions (@). |
| com. |
|
| com. |
A widget is a UI element that presents text and images. |
| com. |
A widget is a UI element that presents text and images. |
| com. |
A button. Can be a text button or an image button. |
| com. |
A button. Can be a text button or an image button. |
| com. |
A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form. |
| com. |
List of string parameters to supply when the action method is invoked.
For example, consider three snooze buttons: snooze now, snooze one day,
snooze next week. You might use action method = snooze()
, passing the |
| com. |
List of string parameters to supply when the action method is invoked.
For example, consider three snooze buttons: snooze now, snooze one day,
snooze next week. You might use action method = snooze()
, passing the |
| com. |
A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form. |
| com. |
An image that's specified by a URL and can have an onclick
action. |
| com. |
An image that's specified by a URL and can have an onclick
action. |
| com. |
An image button with an onclick
action. |
| com. |
An image button with an onclick
action. |
| com. |
A UI element contains a key (label) and a value (content). This
element can also contain some actions such as onclick
button. |
| com. |
A UI element contains a key (label) and a value (content). This
element can also contain some actions such as onclick
button. |
| com. |
An onclick
action (for example, open a link). |
| com. |
An onclick
action (for example, open a link). |
| com. |
A link that opens a new window. |
| com. |
A link that opens a new window. |
| com. |
A button with text and onclick
action. |
| com. |
A button with text and onclick
action. |
| com. |
A paragraph of text. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat |
| com. |
A paragraph of text. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat |
| com. |
