REST Resource: users.availability

Zasób: Availability

Reprezentuje aktualne informacje o dostępności użytkownika w Google Chat, w tym jego stan (np. Aktywny, Nieobecny, Nie przeszkadzać) i własny opis.

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 interfejsie Admin SDK Directory API. Na przykład users/123456789.

Adres e-mail użytkownika lub me może też służyć jako alias do odwoływania się do dzwoniącego. Na przykład users/user@example.com lub users/me.
state

enum (State)

Tylko dane wyjściowe. Aktualny stan dostępności użytkownika.
customStatus

object (CustomStatus)

Opcjonalnie. Własny opis 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 jest ustawiony na DO_NOT_DISTURB.

Stan

Reprezentuje aktualny 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 braku aktywności po stanie ACTIVE, zanim użytkownik przejdzie do stanu AWAY.
AWAY Użytkownik jest obecnie nieobecny. Ten stan można ustawić automatycznie po okresie braku aktywności w stanie ACTIVE lub IDLE albo ręcznie przez użytkownika. Gdy ten stan jest ustawiony ręcznie za pomocą availability.markAsAway, utrzymuje się niezależnie od aktywności użytkownika.
DO_NOT_DISTURB Użytkownik jest w stanie Nie przeszkadzać, który jest ustawiany ręcznie.

DoNotDisturbMetadata

Metadane powiązane ze stanem dostępności DO_NOT_DISTURB, określające, kiedy ten stan ma wygasnąć.

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 własny opis użytkownika w Google Chat. Obejmuje to krótką wiadomość tekstową z opcjonalnym emotikonem, który użytkownik ustawia, aby zapewnić więcej kontekstu na temat 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 znaków.
emoji

object (Emoji)

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

string (Timestamp format)

Sygnatura czasowa, kiedy własny opis wygasa.
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 jako DO_NOT_DISTURB w Google Chat.

patch

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