com.google.api.services.chat.v1

Class HangoutsChat.Users.Sections

java.lang.Object

com.google.api.services.chat.v1.HangoutsChat.Users.Sections

Enclosing class:

HangoutsChat.Users

public class HangoutsChat.Users.Sections
extends Object

The "sections" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HangoutsChat.Users.Sections.Create
class	HangoutsChat.Users.Sections.Delete
class	HangoutsChat.Users.Sections.Items The "items" collection of methods.
class	HangoutsChat.Users.Sections.List
class	HangoutsChat.Users.Sections.Patch
class	HangoutsChat.Users.Sections.Position

Constructor Summary

Constructors

Constructor and Description
Sections()

Method Summary

Modifier and Type	Method and Description
HangoutsChat.Users.Sections.Create	create(String parent, GoogleChatV1Section content) [Developer Preview](https://developers.google.com/workspace/preview): Creates a section in Google Chat.
HangoutsChat.Users.Sections.Delete	delete(String name) [Developer Preview](https://developers.google.com/workspace/preview): Deletes a section of type `CUSTOM_SECTION`.
HangoutsChat.Users.Sections.Items	items() An accessor for creating requests from the Items collection.
HangoutsChat.Users.Sections.List	list(String parent) [Developer Preview](https://developers.google.com/workspace/preview): Lists sections available to the Chat user.
HangoutsChat.Users.Sections.Patch	patch(String name, GoogleChatV1Section content) [Developer Preview](https://developers.google.com/workspace/preview): Updates a section.
HangoutsChat.Users.Sections.Position	position(String name, PositionSectionRequest content) [Developer Preview](https://developers.google.com/workspace/preview): Changes the sort order of a section.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Sections

public Sections()

Method Detail

create

public HangoutsChat.Users.Sections.Create create(String parent,
                                                 GoogleChatV1Section content)
                                          throws IOException

[Developer Preview](https://developers.google.com/workspace/preview): Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type `CUSTOM_SECTION` can be created. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat- user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate- authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` Create a request for the method "sections.create". This request holds the parameters needed by the chat server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent resource name where the section is created. Format: `users/{user}`

content - the GoogleChatV1Section

Returns:

the request

Throws:

IOException

delete

public HangoutsChat.Users.Sections.Delete delete(String name)
                                          throws IOException

[Developer Preview](https://developers.google.com/workspace/preview): Deletes a section of type `CUSTOM_SECTION`. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate- authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` Create a request for the method "sections.delete". This request holds the parameters needed by the chat server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the section to delete. Format: `users/{user}/sections/{section}`

Returns:

the request

Throws:

IOException

list

public HangoutsChat.Users.Sections.List list(String parent)
                                      throws IOException

[Developer Preview](https://developers.google.com/workspace/preview): Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate- authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly` Create a request for the method "sections.list". This request holds the parameters needed by the chat server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me`. - Their Workspace email address. For example, `users/user@example.com`. - Their user id. For example, `users/123456789`. Format: `users/{user}`

Returns:

the request

Throws:

IOException

patch

public HangoutsChat.Users.Sections.Patch patch(String name,
                                               GoogleChatV1Section content)
                                        throws IOException

[Developer Preview](https://developers.google.com/workspace/preview): Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate- authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` Create a request for the method "sections.patch". This request holds the parameters needed by the chat server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`

content - the GoogleChatV1Section

Returns:

the request

Throws:

IOException

position

public HangoutsChat.Users.Sections.Position position(String name,
                                                     PositionSectionRequest content)
                                              throws IOException

[Developer Preview](https://developers.google.com/workspace/preview): Changes the sort order of a section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate- authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` Create a request for the method "sections.position". This request holds the parameters needed by the chat server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the section to position. Format: `users/{user}/sections/{section}`

content - the PositionSectionRequest

Returns:

the request

Throws:

IOException

items

public HangoutsChat.Users.Sections.Items items()

An accessor for creating requests from the Items collection.

The typical use is:

    HangoutsChat chat = new HangoutsChat(...);
    HangoutsChat.Items.List request = chat.items().list(parameters ...)
 

Returns:

the resource collection