REST Resource: users.availability

Zasób: dostępność

Zawiera informacje o bieżącej dostępności użytkownika w Google Chat, w tym jego stan (np. Aktywny, Nieobecny, Nie przeszkadzać) i dowolny stan niestandardowy.

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

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

string

Identyfikator. Nazwa zasobu dostępności użytkownika.

Format: users/{user}/availability

{user} to identyfikator osoby w interfejsie People API lub Directory API z pakietu Admin SDK. Na przykład: users/123456789.

Adres e-mail użytkownika lub me może być również używany jako alias do odwoływania się do rozmówcy. Na przykład users/user@example.com lub users/me.
state

enum (State)

Tylko dane wyjściowe. bieżący stan dostępności użytkownika;
customStatus

object (CustomStatus)

Opcjonalnie. Stan niestandardowy użytkownika.
Pole zbiorcze state_metadata. Dodatkowe metadane powiązane ze stanem dostępności użytkownika. state_metadata może mieć tylko jedną z tych wartości:
doNotDisturbMetadata

object (DoNotDisturbMetadata)

Tylko dane wyjściowe. Metadane, jeśli stan użytkownika to DO_NOT_DISTURB.

Stan

Reprezentuje bieżący stan dostępności użytkownika.

Wartości w polu enum
STATE_UNSPECIFIED Wartość domyślna. Stan jest nieokreślony.
ACTIVE Użytkownik jest obecnie aktywny na podstawie ostatniej aktywności.
IDLE Użytkownik jest obecnie nieaktywny. Ten stan oznacza okres bezczynności po stanie AKTYWNY, zanim potencjalnie przejdzie w stan NIEDOSTĘPNY.
AWAY Użytkownik jest obecnie nieobecny. Może to nastąpić automatycznie po okresie braku aktywności w stanie AKTYWNY lub BEZCZYNNOŚĆ albo może zostać ustawione ręcznie przez użytkownika. Gdy jest ustawiony ręcznie za pomocą availability.markAsAway, ten stan utrzymuje się niezależnie od aktywności użytkownika.
DO_NOT_DISTURB Użytkownik jest w trybie „Nie przeszkadzać”, który został ustawiony ręcznie.

DoNotDisturbMetadata

Metadane powiązane ze stanem dostępności DO_NOT_DISTURB, określające, kiedy stan wygaśnie.

Zapis JSON 
{
  "expirationTime": string
}
Pola
expirationTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa, do której użytkownik powinien być oznaczony jako DO_NOT_DISTURB. Może to być maksymalnie 1 rok w przyszłości.

CustomStatus

Reprezentuje stan niestandardowy użytkownika w Google Chat. Obejmuje to krótki tekst z opcjonalnym emoji, który użytkownik ustawia, aby podać więcej informacji o swojej dostępności.

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

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

string

Wymagane. Tekst własnego opisu. Będzie to ciąg znaków o maksymalnej długości 64.
emoji

object (Emoji)

Wymagane. Emotikon własnego opisu. Obsługiwane są tylko emotikony Unicode, a niestandardowe emotikony nie są obsługiwane.
Pole zbiorcze expiration. Czas wygaśnięcia własnego stanu. Można go określić jako bezwzględny sygnaturę czasową lub czas życia. expiration może mieć tylko jedną z tych wartości:
expireTime

string (Timestamp format)

Sygnatura czasowa wygaśnięcia własnego opisu.
ttl

string (Duration format)

Tylko dane wejściowe. Czas życia, po którym własny opis wygasa.

Metody

get

 Zwraca informacje o dostępności użytkownika w Google Chat.

markAsActive

 Oznacza użytkownika jako ACTIVE w Google Chat.

markAsAway

 Oznacza użytkownika jako AWAY w Google Chat.

markAsDoNotDisturb

 Oznacza użytkownika jakoDO_NOT_DISTURB w Google Chat.

patch

 Aktualizuje informacje o dostępności użytkownika.