REST Resource: users.availability

Disponibilité des ressources

Représente les informations de disponibilité actuelles d'un utilisateur dans Google Chat, y compris son état (par exemple, "Actif", "Absent" ou "Ne pas déranger") et tout état personnalisé.

Représentation JSON 
{
  "name": string,
  "state": enum (State),
  "customStatus": {
    object (CustomStatus)
  },

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

string

Identifiant. Nom de ressource de la disponibilité de l'utilisateur.

Format : users/{user}/availability

{user} est l'ID de la personne dans l'API People ou l'API Admin SDK Directory. Exemple :users/123456789

L'adresse e-mail de l'utilisateur ou me peuvent également être utilisées comme alias pour désigner l'appelant. Par exemple, users/user@example.com ou users/me.
state

enum (State)

Uniquement en sortie. État de disponibilité actuel de l'utilisateur.
customStatus

object (CustomStatus)

Facultatif. État personnalisé de l'utilisateur.
Métadonnées supplémentaires associées à l'état de disponibilité de l'utilisateur. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
doNotDisturbMetadata

object (DoNotDisturbMetadata)

Uniquement en sortie. Métadonnées si l'état de l'utilisateur est défini sur DO_NOT_DISTURB.
Fin des champs qui s'excluent mutuellement.

État

Représente l'état de disponibilité actuel de l'utilisateur.

Enums
STATE_UNSPECIFIED Valeur par défaut. L'état n'est pas spécifié.
ACTIVE L'utilisateur est actuellement actif, d'après son activité récente.
IDLE L'utilisateur est actuellement inactif. Cet état indique une période d'inactivité après l'état ACTIF, avant de passer potentiellement à l'état ABSENT.
AWAY L'utilisateur est actuellement absent. Cette valeur peut être définie automatiquement après une période d'inactivité à l'état ACTIVE ou IDLE, ou manuellement par l'utilisateur. Lorsqu'il est défini manuellement via availability.markAsAway, cet état persiste quelle que soit l'activité de l'utilisateur.
DO_NOT_DISTURB L'utilisateur est en mode Ne pas déranger, qui est défini manuellement.

DoNotDisturbMetadata

Métadonnées associées à l'état de disponibilité DO_NOT_DISTURB, qui spécifient la date d'expiration de l'état.

Représentation JSON 
{
  "expirationTime": string
}
Champs
expirationTime

string (Timestamp format)

Uniquement en sortie. Code temporel jusqu'auquel l'utilisateur doit être marqué comme "NE PAS DÉRANGER". Cette date peut être postérieure d'un an maximum à la date du jour.

CustomStatus

Représente l'état personnalisé d'un utilisateur dans Google Chat. Il s'agit d'un court message texte avec un emoji facultatif que l'utilisateur définit pour donner plus de contexte sur sa disponibilité.

Représentation JSON 
{
  "text": string,
  "emoji": {
    object (Emoji)
  },

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

string

Obligatoire. Texte de l'état personnalisé. Il s'agit d'une chaîne de caractères d'une longueur maximale de 64.
emoji

object (Emoji)

Obligatoire. Emoji de l'état personnalisé. Seuls les emoji Unicode sont acceptés. Les emoji personnalisés ne le sont pas.
Heure d'expiration de l'état personnalisé. Elle peut être spécifiée sous la forme d'un code temporel absolu ou d'une durée de vie. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
expireTime

string (Timestamp format)

Code temporel d'expiration de l'état personnalisé.
ttl

string (Duration format)

Uniquement en entrée. Durée de vie au terme de laquelle l'état personnalisé expire.
Fin des champs qui s'excluent mutuellement.

Méthodes

get

 Affiche des informations sur la disponibilité d'un utilisateur humain dans Google Chat.

markAsActive

 Marque l'utilisateur comme ACTIVE dans Google Chat.

markAsAway

 Marque l'utilisateur comme AWAY dans Google Chat.

markAsDoNotDisturb

 Marque l'utilisateur comme DO_NOT_DISTURB dans Google Chat.

patch

 Met à jour les informations de disponibilité d'un utilisateur humain.