Namespace Google.Apis.HangoutsChat.v1
Classes
HangoutsChatBaseServiceRequest<TResponse>
A base abstract class for HangoutsChat requests.
HangoutsChatService
The HangoutsChat Service.
HangoutsChatService.Scope
Available OAuth 2.0 scopes for use with the Google Chat API.
HangoutsChatService.ScopeConstants
Available OAuth 2.0 scope constants for use with the Google Chat API.
MediaResource
The "media" collection of methods.
MediaResource.DownloadRequest
Downloads media. Download is supported on the URI /v1/media/{+name}?alt=media
.
MediaResource.UploadMediaUpload
Upload media upload which supports resumable upload.
MediaResource.UploadRequest
Uploads an attachment. For an example, see Upload media as a file attachment. Requires user authentication. You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see File types blocked by Google Chat.
SpacesResource
The "spaces" collection of methods.
SpacesResource.CompleteImportRequest
Completes the import process for the specified space and makes it visible to users. Requires app authentication and domain-wide delegation. For more information, see Authorize Google Chat apps to import data.
SpacesResource.CreateRequest
Creates a named space. Spaces grouped by topics aren't supported. For an example, see Create a
space. If you receive the error message
ALREADY_EXISTS
when creating a space, try a different displayName
. An existing space within the Google
Workspace organization might already use this display name. Requires user
authentication.
SpacesResource.DeleteRequest
Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see Delete a space. Requires user authentication from a user who has permission to delete the space.
SpacesResource.FindDirectMessageRequest
Returns the existing direct message with the specified user. If no direct message space is found, returns a
404 NOT_FOUND
error. For an example, see Find a direct
message. With user
authentication, returns the
direct message space between the specified user and the authenticated user. With app
authentication, returns the
direct message space between the specified user and the calling Chat app. Requires user
authentication or app
authentication.
SpacesResource.GetRequest
Returns details about a space. For an example, see Get details about a space. Requires authentication. Supports app authentication and user authentication.
SpacesResource.ListRequest
Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent.
For an example, see List spaces. Requires
authentication. Supports app
authentication and user
authentication. Lists spaces
visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is
sent. To list all named spaces by Google Workspace organization, use the
spaces.search()
method
using Workspace administrator privileges instead.
SpacesResource.MembersResource
The "members" collection of methods.
SpacesResource.MembersResource.CreateRequest
Creates a human membership or app membership for the calling app. Creating memberships for other apps
isn't supported. For an example, see Invite or add a user or a Google Chat app to a
space. When creating a membership, if the
specified member has their auto-accept policy turned off, then they're invited, and must accept the
space invitation before joining. Otherwise, creating a membership adds the member directly to the
specified space. Requires user
authentication. To
specify the member to add, set the membership.member.name
for the human or app member, or set the
membership.group_member.name
for the group member. - To add the calling app to a space or a direct
message between two human users, use users/app
. Unable to add other apps to the space. - To add a
human user, use users/{user}
, where {user}
can be the email address for the user. For users in the
same Workspace organization {user}
can also be the id
for the person from the People API, or the
id
for the user in the Directory API. For example, if the People API Person profile ID for
user@example.com
is 123456789
, you can add the user to the space by setting the
membership.member.name
to users/user@example.com
or users/123456789
. - To add or invite a Google
group in a named space, use groups/{group}
, where {group}
is the id
for the group from the Cloud
Identity Groups API. For example, you can use Cloud Identity Groups lookup
API to retrieve the ID
123456789
for group email group@example.com
, then you can add or invite the group to a named space
by setting the membership.group_member.name
to groups/123456789
. Group email is not supported, and
Google groups can only be added as members in named spaces.
SpacesResource.MembersResource.DeleteRequest
Deletes a membership. For an example, see Remove a user or a Google Chat app from a space. Requires user authentication.
SpacesResource.MembersResource.GetRequest
Returns details about a membership. For an example, see Get details about a user's or Google Chat app's membership. Requires authentication. Supports app authentication and user authentication.
SpacesResource.MembersResource.ListRequest
Lists memberships in a space. For an example, see List users and Google Chat apps in a space. Listing memberships with app authentication lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with User authentication lists memberships in spaces that the authenticated user has access to. Requires authentication. Supports app authentication and user authentication.
SpacesResource.MembersResource.PatchRequest
Updates a membership. For an example, see Update a user's membership in a space. Requires user authentication.
SpacesResource.MessagesResource
The "messages" collection of methods.
SpacesResource.MessagesResource.AttachmentsResource
The "attachments" collection of methods.
SpacesResource.MessagesResource.AttachmentsResource.GetRequest
Gets the metadata of a message attachment. The attachment data is fetched using the media API. For an example, see Get metadata about a message attachment. Requires app authentication.
SpacesResource.MessagesResource.CreateRequest
Creates a message in a Google Chat space. The maximum message size, including text and cards, is 32,000 bytes. For an example, see Send a message. Calling this method requires authentication and supports the following authentication types: - For text messages, user authentication or app authentication are supported. - For card messages, only app authentication is supported. (Only Chat apps can create card messages.)
SpacesResource.MessagesResource.DeleteRequest
Deletes a message. For an example, see Delete a message. Requires authentication. Supports app authentication and user authentication. When using app authentication, requests can only delete messages created by the calling Chat app.
SpacesResource.MessagesResource.GetRequest
Returns details about a message. For an example, see Get details about a message. Requires authentication. Supports app authentication and user authentication. Note: Might return a message from a blocked member or space.
SpacesResource.MessagesResource.ListRequest
Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. For an example, see List messages. Requires user authentication.
SpacesResource.MessagesResource.PatchRequest
Updates a message. There's a difference between the patch
and update
methods. The patch
method
uses a patch
request while the update
method uses a put
request. We recommend using the patch
method. For an example, see Update a
message. Requires
authentication. Supports app
authentication and user
authentication. When
using app authentication, requests can only update messages created by the calling Chat app.
SpacesResource.MessagesResource.ReactionsResource
The "reactions" collection of methods.
SpacesResource.MessagesResource.ReactionsResource.CreateRequest
Creates a reaction and adds it to a message. Only unicode emojis are supported. For an example, see Add a reaction to a message. Requires user authentication.
SpacesResource.MessagesResource.ReactionsResource.DeleteRequest
Deletes a reaction to a message. Only unicode emojis are supported. For an example, see Delete a reaction. Requires user authentication.
SpacesResource.MessagesResource.ReactionsResource.ListRequest
Lists reactions to a message. For an example, see List reactions for a message. Requires user authentication.
SpacesResource.MessagesResource.UpdateRequest
Updates a message. There's a difference between the patch
and update
methods. The patch
method
uses a patch
request while the update
method uses a put
request. We recommend using the patch
method. For an example, see Update a
message. Requires
authentication. Supports app
authentication and user
authentication. When
using app authentication, requests can only update messages created by the calling Chat app.
SpacesResource.PatchRequest
Updates a space. For an example, see Update a
space. If you're updating the displayName
field and receive the error message ALREADY_EXISTS
, try a different display name.. An existing space
within the Google Workspace organization might already use this display name. Requires user
authentication.
SpacesResource.SetupRequest
Creates a space and adds specified users to it. The calling user is automatically added to the space, and
shouldn't be specified as a membership in the request. For an example, see Set up a space with initial
members. To specify the human members to add,
add memberships with the appropriate membership.member.name
. To add a human user, use users/{user}
,
where {user}
can be the email address for the user. For users in the same Workspace organization {user}
can also be the id
for the person from the People API, or the id
for the user in the Directory API. For
example, if the People API Person profile ID for user@example.com
is 123456789
, you can add the user to
the space by setting the membership.member.name
to users/user@example.com
or users/123456789
. To
specify the Google groups to add, add memberships with the appropriate membership.group_member.name
. To
add or invite a Google group, use groups/{group}
, where {group}
is the id
for the group from the Cloud
Identity Groups API. For example, you can use Cloud Identity Groups lookup
API to retrieve the ID 123456789
for group email group@example.com
, then you can add the group to the space by setting the
membership.group_member.name
to groups/123456789
. Group email is not supported, and Google groups can
only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is
blocked by some members, or doesn't have permission to add some members, then those members aren't added to
the created space. To create a direct message (DM) between the calling user and another human user, specify
exactly one membership to represent the human user. If one user blocks the other, the request fails and the
DM isn't created. To create a DM between the calling user and the calling app, set Space.singleUserBotDm
to true
and don't specify any memberships. You can only use this method to set up a DM with the calling
app. To add the calling app as a member of a space or an existing DM between two human users, see Invite or
add a user or app to a space. If a DM already
exists between two users, even when one user blocks the other at the time a request is made, then the
existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message
ALREADY_EXISTS
when setting up a space, try a different displayName
. An existing space within the Google
Workspace organization might already use this display name. Requires user
authentication.
SpacesResource.SpaceEventsResource
The "spaceEvents" collection of methods.
SpacesResource.SpaceEventsResource.GetRequest
Returns an event from a Google Chat space. The event
payload
contains the most recent version of the resource that changed. For example, if you request an event
about a new message but the message was later updated, the server returns the updated Message
resource
in the event payload. Requires user
authentication. To get
an event, the authenticated user must be a member of the space. For an example, see Get details about
an event from a Google Chat space.
SpacesResource.SpaceEventsResource.ListRequest
Lists events from a Google Chat space. For each event, the
payload
contains the most recent version of the Chat resource. For example, if you list events about new space
members, the server returns Membership
resources that contain the latest membership details. If new
members were removed during the requested period, the event payload contains an empty Membership
resource. Requires user
authentication. To list
events, the authenticated user must be a member of the space. For an example, see List events from a
Google Chat space.
UsersResource
The "users" collection of methods.
UsersResource.SpacesResource
The "spaces" collection of methods.
UsersResource.SpacesResource.GetSpaceReadStateRequest
Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see Get details about a user's space read state. Requires user authentication.
UsersResource.SpacesResource.ThreadsResource
The "threads" collection of methods.
UsersResource.SpacesResource.ThreadsResource.GetThreadReadStateRequest
Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see Get details about a user's thread read state. Requires user authentication.
UsersResource.SpacesResource.UpdateSpaceReadStateRequest
Updates a user's read state within a space, used to identify read and unread messages. For an example, see Update a user's space read state. Requires user authentication.
Enums
HangoutsChatBaseServiceRequest<TResponse>.AltEnum
Data format for response.
HangoutsChatBaseServiceRequest<TResponse>.XgafvEnum
V1 error format.
MediaResource.UploadMediaUpload.AltEnum
Data format for response.
MediaResource.UploadMediaUpload.XgafvEnum
V1 error format.
SpacesResource.MessagesResource.CreateRequest.MessageReplyOptionEnum
Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.