REST Resource: users.availability

Recurso: Disponibilidad

Representa la información de disponibilidad actual de un usuario en Google Chat, incluido su estado (por ejemplo, Activo, Ausente, No interrumpir) y cualquier estado personalizado.

Representación JSON 
{
  "name": string,
  "state": enum (State),
  "customStatus": {
    object (CustomStatus)
  },

  "doNotDisturbMetadata": {
    object (DoNotDisturbMetadata)
  }
}
Campos
name

string

Es el identificador. Es el nombre del recurso de la disponibilidad del usuario.

Formato: users/{user}/availability

{user} es el ID de la persona en la API de People o en la API de Directory del SDK de Admin. Por ejemplo, users/123456789

La dirección de correo electrónico del usuario o me también se pueden usar como alias para hacer referencia a la persona que llama. Por ejemplo, users/user@example.com o users/me.
state

enum (State)

Solo salida. Es el estado de disponibilidad actual del usuario.
customStatus

object (CustomStatus)

Opcional. Es el estado personalizado del usuario.
Campo de unión state_metadata. Son metadatos adicionales asociados con el estado de disponibilidad del usuario. state_metadata puede ser solo uno de los parámetros siguientes:
doNotDisturbMetadata

object (DoNotDisturbMetadata)

Solo salida. Son metadatos si el estado del usuario se establece en DO_NOT_DISTURB.

Estado

Representa el estado de disponibilidad actual del usuario.

Enums
STATE_UNSPECIFIED Valor predeterminado El estado no se especifica.
ACTIVE El usuario está activo actualmente, según su actividad reciente.
IDLE El usuario está inactivo en este momento. Este estado indica un período de inactividad después de estar en ACTIVE, antes de pasar potencialmente a AWAY.
AWAY El usuario no está disponible en este momento. Se puede configurar automáticamente después de un período de inactividad en estado ACTIVE o IDLE, o bien el usuario puede configurarlo de forma manual. Cuando se establece manualmente a través de availability.markAsAway, este estado persiste independientemente de la actividad del usuario.
DO_NOT_DISTURB El usuario está en el estado No interrumpir, que se configuró manualmente.

DoNotDisturbMetadata

Son los metadatos asociados con el estado de disponibilidad DO_NOT_DISTURB, que especifican cuándo vence el estado.

Representación JSON 
{
  "expirationTime": string
}
Campos
expirationTime

string (Timestamp format)

Solo salida. Es la marca de tiempo hasta la que se debe marcar al usuario como NO_MOLESTAR. Puede ser como máximo 1 año en el futuro.

CustomStatus

Representa el estado personalizado de un usuario en Google Chat. Esto incluye un mensaje de texto corto con un emoji opcional que el usuario configura para brindar más contexto sobre su disponibilidad.

Representación JSON 
{
  "text": string,
  "emoji": {
    object (Emoji)
  },

  "expireTime": string,
  "ttl": string
}
Campos
text

string

Obligatorio. Es el texto del estado personalizado. Será una cadena con una longitud máxima de 64.
emoji

object (Emoji)

Obligatorio. Emoji del estado personalizado. Solo se admiten emojis Unicode. No se admiten emojis personalizados.
Campo de unión expiration. Es la hora de vencimiento del estado personalizado. Se puede especificar como una marca de tiempo absoluta o como una duración de tiempo de actividad. expiration puede ser solo uno de los parámetros siguientes:
expireTime

string (Timestamp format)

Es la marca de tiempo en la que vence el estado personalizado.
ttl

string (Duration format)

Solo entrada. Es la duración del período de vida después del cual vence el estado personalizado.

Métodos

get

 Devuelve información de disponibilidad para un usuario humano en Google Chat.

markAsActive

 Marca al usuario como ACTIVE en Google Chat.

markAsAway

 Marca al usuario como AWAY en Google Chat.

markAsDoNotDisturb

 Marca al usuario comoDO_NOT_DISTURBen Google Chat.

patch

 Actualiza la información de disponibilidad de un usuario humano.