REST Resource: users.availability

Ressource : Availability

Représente les informations de disponibilité actuelles d'un utilisateur dans Google Chat, y compris son état (par exemple, "Actif", "Absent", "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} correspond à 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 peut également être utilisée comme alias pour faire référence à l'appelant. 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.
Champ d'union state_metadata. Métadonnées supplémentaires associées à l'état de disponibilité de l'utilisateur. state_metadata ne peut être qu'un des éléments suivants :
doNotDisturbMetadata

object (DoNotDisturbMetadata)

Uniquement en sortie. Métadonnées si l'état de l'utilisateur est défini sur DO_NOT_DISTURB.

É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, en fonction de son activité récente.
IDLE L'utilisateur est actuellement inactif. Cet état indique une période d'inactivité après avoir été ACTIF, avant de passer potentiellement à ABSENT.
AWAY L'utilisateur est actuellement absent. Cet état peut être défini automatiquement après une période d'inactivité dans l'état ACTIF ou INACTIF, 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, spécifiant la date d'expiration de l'état.

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

string (Timestamp format)

Uniquement en sortie. Timestamp jusqu'à ce que l'utilisateur soit marqué comme DO_NOT_DISTURB. Cette valeur ne peut pas dépasser un an.

CustomStatus

Représente l'état personnalisé d'un utilisateur dans Google Chat. Il s'agit d'un court message texte avec un emoji facultatif qu'un utilisateur définit pour fournir 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 64 caractères maximum.
emoji

object (Emoji)

Obligatoire. Emoji de l'état personnalisé. Seuls les emoji Unicode sont acceptés. Les emoji personnalisés ne sont pas acceptés.
Champ d'union expiration. Date d'expiration de l'état personnalisé. Elle peut être spécifiée sous la forme d'un timestamp absolu ou d'une durée de durée de vie. expiration ne peut être qu'un des éléments suivants :
expireTime

string (Timestamp format)

Timestamp d'expiration de l'état personnalisé.
ttl

string (Duration format)

Uniquement en entrée. Durée de vie après laquelle l'état personnalisé expire.

Méthodes

get

 Affiche les informations de 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.