REST Resource: users.availability

Ресурс: Доступность

Отображает информацию о текущей доступности пользователя в Google Chat, включая его состояние (например, Активен, Нет, Не беспокоить) и любой пользовательский статус.

JSON-представление 
{
  "name": string,
  "state": enum (State),
  "customStatus": {
    object (CustomStatus)
  },

  "doNotDisturbMetadata": {
    object (DoNotDisturbMetadata)
  }
}
Поля
name

string

Идентификатор. Название ресурса, определяющее доступность пользователя.

Формат: users/{user}/availability

{user} — это идентификатор пользователя в API для работы с людьми или в API каталога Admin SDK. Например, users/123456789 .

Адрес электронной почты пользователя или имя пользователя me также могут использоваться в качестве псевдонима для обращения к вызывающему абоненту. Например, users/user@example.com или users/me .

state

enum ( State )

Только вывод. Текущее состояние доступности пользователя.

customStatus

object ( CustomStatus )

Необязательно. Пользовательский статус.

Поле объединения state_metadata . Дополнительные метаданные, связанные с состоянием доступности пользователя. state_metadata может принимать только одно из следующих значений:
doNotDisturbMetadata

object ( DoNotDisturbMetadata )

Только для вывода. Метаданные, если состояние пользователя установлено на DO_NOT_DISTURB.

Состояние

Отражает текущее состояние доступности пользователя.

Перечисления
STATE_UNSPECIFIED Значение по умолчанию. Штат не указан.
ACTIVE Судя по недавней активности, пользователь в данный момент активен.
IDLE В данный момент пользователь находится в режиме ожидания. Это состояние указывает на период бездействия после состояния АКТИВНОСТИ, перед возможным переходом в состояние ОТСУТСТВИЯ.
AWAY Пользователь в данный момент отсутствует. Это состояние может устанавливаться автоматически после периода бездействия в состоянии ACTIVE или IDLE, либо вручную пользователем. При ручной установке с помощью availability.markAsAway это состояние сохраняется независимо от активности пользователя.
DO_NOT_DISTURB Пользователь находится в режиме «Не беспокоить», который установлен вручную.

DoNotDisturbMetadata

Метаданные, связанные с состоянием доступности DO_NOT_DISTURB , указывающие, когда это состояние должно истечь.

JSON-представление 
{
  "expirationTime": string
}
Поля
expirationTime

string ( Timestamp format)

Только для вывода. Временная метка, до которой пользователь должен быть помечен как «НЕ БЕСПОКОИТЬ». Максимально может быть 1 год в будущем.

CustomStatus

Отображает пользовательский статус пользователя в Google Chat. Он включает короткое текстовое сообщение с дополнительным смайликом, который пользователь выбирает для большей ясности относительно своей доступности.

JSON-представление 
{
  "text": string,
  "emoji": {
    object (Emoji)
  },

  "expireTime": string,
  "ttl": string
}
Поля
text

string

Обязательно. Текст пользовательского статуса. Это будет строка максимальной длиной 64 символа.

emoji

object ( Emoji )

Обязательно. Эмодзи пользовательского статуса. Поддерживаются только эмодзи Unicode; пользовательские эмодзи не поддерживаются.

Поле объединения « expiration . Время истечения срока действия пользовательского статуса. Может быть указано либо в виде абсолютной метки времени, либо в виде продолжительности жизни. expiration может быть только одним из следующих:
expireTime

string ( Timestamp format)

Отметка времени, когда истекает срок действия пользовательского статуса.

ttl

string ( Duration format)

Только для ввода. Продолжительность жизни, по истечении которой пользовательский статус утрачивает силу.

Методы

get

 Возвращает информацию о доступности для пользователя в Google Chat.

markAsActive

 Отмечает пользователя как ACTIVE в чате Google.

markAsAway

 Отмечает пользователя как AWAY в Google Chat.

markAsDoNotDisturb

 Помечает пользователя как DO_NOT_DISTURB в чате Google.

patch

 Обновляет информацию о доступности для пользователя.