Class UsersResource.AvailabilityResource

The "availability" collection of methods.

Inheritance

object

UsersResource.AvailabilityResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.HangoutsChat.v1

Assembly: Google.Apis.HangoutsChat.v1.dll

Syntax

public class UsersResource.AvailabilityResource

Constructors

AvailabilityResource(IClientService)

Constructs a new resource.

Declaration

public AvailabilityResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

GetAvailability(string)

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 with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.users.availability.readonly - https://www.googleapis.com/auth/chat.users.availability

Declaration

public virtual UsersResource.AvailabilityResource.GetAvailabilityRequest GetAvailability(string name)

Parameters

Type	Name	Description
string	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

Type	Description
UsersResource.AvailabilityResource.GetAvailabilityRequest

MarkAsActive(MarkAsActiveRequest, string)

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 with authorization scope: - https://www.googleapis.com/auth/chat.users.availability

Declaration

public virtual UsersResource.AvailabilityResource.MarkAsActiveRequest MarkAsActive(MarkAsActiveRequest body, string name)

Parameters

Type	Name	Description
MarkAsActiveRequest	body	The body of the request.
string	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.

Returns

Type	Description
UsersResource.AvailabilityResource.MarkAsActiveRequest

MarkAsAway(MarkAsAwayRequest, string)

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 with authorization scope: - https://www.googleapis.com/auth/chat.users.availability

Declaration

public virtual UsersResource.AvailabilityResource.MarkAsAwayRequest MarkAsAway(MarkAsAwayRequest body, string name)

Parameters

Type	Name	Description
MarkAsAwayRequest	body	The body of the request.
string	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.

Returns

Type	Description
UsersResource.AvailabilityResource.MarkAsAwayRequest

MarkAsDoNotDisturb(MarkAsDoNotDisturbRequest, string)

Marks user asDO_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 with authorization scope: - https://www.googleapis.com/auth/chat.users.availability

Declaration

public virtual UsersResource.AvailabilityResource.MarkAsDoNotDisturbRequest MarkAsDoNotDisturb(MarkAsDoNotDisturbRequest body, string name)

Parameters

Type	Name	Description
MarkAsDoNotDisturbRequest	body	The body of the request.
string	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.

Returns

Type	Description
UsersResource.AvailabilityResource.MarkAsDoNotDisturbRequest

UpdateAvailability(Availability, string)

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 with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.users.availability

Declaration

public virtual UsersResource.AvailabilityResource.UpdateAvailabilityRequest UpdateAvailability(Availability body, string name)

Parameters

Type	Name	Description
Availability	body	The body of the request.
string	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.

Returns

Type	Description
UsersResource.AvailabilityResource.UpdateAvailabilityRequest