com.google.api.services.chat.v1

Class HangoutsChat.Users.Availability

java.lang.Object

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

Enclosing class:

HangoutsChat.Users

public class HangoutsChat.Users.Availability
extends Object

The "availability" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HangoutsChat.Users.Availability.Get
class	HangoutsChat.Users.Availability.MarkAsActive
class	HangoutsChat.Users.Availability.MarkAsAway
class	HangoutsChat.Users.Availability.MarkAsDoNotDisturb
class	HangoutsChat.Users.Availability.Patch

Constructor Summary

Constructors

Constructor and Description
Availability()

Method Summary

Modifier and Type	Method and Description
HangoutsChat.Users.Availability.Get	get(String name) Returns availability information for a human user in Google Chat.
HangoutsChat.Users.Availability.MarkAsActive	markAsActive(String name, MarkAsActiveRequest content) Marks user as `ACTIVE` in Google Chat.
HangoutsChat.Users.Availability.MarkAsAway	markAsAway(String name, MarkAsAwayRequest content) Marks user as `AWAY` in Google Chat.
HangoutsChat.Users.Availability.MarkAsDoNotDisturb	markAsDoNotDisturb(String name, MarkAsDoNotDisturbRequest content) Marks user as `DO_NOT_DISTURB` in Google Chat.
HangoutsChat.Users.Availability.Patch	patch(String name, Availability content) Updates availability information for a human user.

Methods inherited from class java.lang.Object

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

Constructor Detail

Availability

public Availability()

Method Detail

get

public HangoutsChat.Users.Availability.Get get(String name)
                                        throws IOException

Returns availability information for a human user in Google Chat. For example, this can be used to check if a user is online or away, or to retrieve their custom status message. This method only retrieves the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability.readonly` - `https://www.googleapis.com/auth/chat.users.availability` Create a request for the method "availability.get". 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 availability to retrieve. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.

Returns:

the request

Throws:

IOException

markAsActive

public HangoutsChat.Users.Availability.MarkAsActive markAsActive(String name,
                                                                 MarkAsActiveRequest content)
                                                          throws IOException

Marks user as `ACTIVE` in Google Chat. Sets the user's availability state to `ACTIVE`. The `ACTIVE` state lasts until the specified expiration, at which point the user's state becomes `AWAY`. Note that if the user is actively using Chat, the `ACTIVE` state duration may extend beyond the provided expiration. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate- authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability` Create a request for the method "availability.markAsActive". 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 availability to mark as active. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.

content - the MarkAsActiveRequest

Returns:

the request

Throws:

IOException

markAsAway

public HangoutsChat.Users.Availability.MarkAsAway markAsAway(String name,
                                                             MarkAsAwayRequest content)
                                                      throws IOException

Marks user as `AWAY` in Google Chat. Sets the user's state to away and is not affected by the user's activity. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate- authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability` Create a request for the method "availability.markAsAway". 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 availability to mark as away. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.

content - the MarkAsAwayRequest

Returns:

the request

Throws:

IOException

markAsDoNotDisturb

public HangoutsChat.Users.Availability.MarkAsDoNotDisturb markAsDoNotDisturb(String name,
                                                                             MarkAsDoNotDisturbRequest content)
                                                                      throws IOException

Marks user as `DO_NOT_DISTURB` in Google Chat. Sets a user's availability state to `DO_NOT_DISTURB` until a specified expiration time. When in `DO_NOT_DISTURB`, users typically won't receive notifications. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate- authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability` Create a request for the method "availability.markAsDoNotDisturb". 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 availability to mark as Do Not Disturb. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.

content - the MarkAsDoNotDisturbRequest

Returns:

the request

Throws:

IOException

patch

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

Updates availability information for a human user. Only the `custom_status` field can be updated through this method. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat- user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability` Create a request for the method "availability.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 user's availability. Format: `users/{user}/availability` `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.

content - the Availability

Returns:

the request

Throws:

IOException