REST Resource: users.availability

Risorsa: Availability

Rappresenta le informazioni sulla disponibilità attuale di un utente in Google Chat, incluso il suo stato (ad esempio, Attivo, Assente, Non disturbare) e qualsiasi stato personalizzato.

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

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

string

Identificatore. Nome risorsa della disponibilità dell'utente.

Formato: users/{user}/availability

{user} è l'ID della persona nell'API People o nell'API Directory dell'SDK Admin. Ad esempio, users/123456789.

L'indirizzo email dell'utente o me può essere utilizzato anche come alias per fare riferimento al chiamante. Ad esempio, users/user@example.com o users/me.
state

enum (State)

Solo output. Lo stato di disponibilità attuale dell'utente.
customStatus

object (CustomStatus)

Facoltativo. Lo stato personalizzato dell'utente.
Campo unione state_metadata. Metadati aggiuntivi associati allo stato di disponibilità dell'utente. state_metadata può essere solo uno dei seguenti tipi:
doNotDisturbMetadata

object (DoNotDisturbMetadata)

Solo output. Metadati se lo stato dell'utente è impostato su DO_NOT_DISTURB.

Stato

Rappresenta lo stato di disponibilità attuale dell'utente.

Enum
STATE_UNSPECIFIED Valore predefinito. Lo stato non è specificato.
ACTIVE L'utente è attualmente attivo, in base all'attività recente.
IDLE L'utente è attualmente inattivo. Questo stato indica un periodo di inattività dopo essere stato ATTIVO, prima di passare potenzialmente a ASSENTE.
AWAY L'utente è attualmente assente. Può essere impostato automaticamente dopo un periodo di inattività nello stato ATTIVO o INATTIVO oppure può essere impostato manualmente dall'utente. Se impostato manualmente tramite availability.markAsAway, questo stato persiste indipendentemente dall'attività dell'utente.
DO_NOT_DISTURB L'utente è in stato Non disturbare, impostato manualmente.

DoNotDisturbMetadata

Metadati associati allo stato di disponibilità DO_NOT_DISTURB, che specificano quando lo stato è impostato per la scadenza.

Rappresentazione JSON 
{
  "expirationTime": string
}
Campi
expirationTime

string (Timestamp format)

Solo output. Timestamp fino al quale l'utente deve essere contrassegnato come DO_NOT_DISTURB. Può essere al massimo di 1 anno in futuro.

CustomStatus

Rappresenta lo stato personalizzato di un utente in Google Chat. Include un breve messaggio di testo con un'emoji facoltativa che un utente imposta per fornire maggiori informazioni sulla sua disponibilità.

Rappresentazione JSON 
{
  "text": string,
  "emoji": {
    object (Emoji)
  },

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

string

Obbligatorio. Il testo dello stato personalizzato. Si tratta di una stringa con una lunghezza massima di 64 caratteri.
emoji

object (Emoji)

Obbligatorio. L'emoji dello stato personalizzato. Sono supportate solo le emoji Unicode; le emoji personalizzate non sono supportate.
Campo unione expiration. L'ora di scadenza dello stato personalizzato. Può essere specificata come timestamp assoluto o come durata di durata. expiration può essere solo uno dei seguenti tipi:
expireTime

string (Timestamp format)

Il timestamp di scadenza dello stato personalizzato.
ttl

string (Duration format)

Solo input. La durata di durata dopo la quale lo stato personalizzato scade.

Metodi

get

 Restituisce le informazioni sulla disponibilità di un utente umano in Google Chat.

markAsActive

 Contrassegna l'utente come ACTIVE in Google Chat.

markAsAway

 Contrassegna l'utente come AWAY in Google Chat.

markAsDoNotDisturb

 Contrassegna l'utente come DO_NOT_DISTURB in Google Chat.

patch

 Aggiorna le informazioni sulla disponibilità di un utente umano.