REST Resource: users.availability

资源：可用性

表示用户在 Google Chat 中的当前可用性信息，包括其状态（例如“活跃”“离开”“勿扰”）和任何自定义状态。

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

  "doNotDisturbMetadata": {
    object (DoNotDisturbMetadata)
  }
}
字段
name

string

标识符。用户可用性的资源名称。

格式：users/{user}/availability

{user} 是 People API 或 Admin SDK Directory API 中人员的 ID。例如，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 用户目前处于空闲状态。此状态表示在处于 ACTIVE 状态后的一段不活动时间，之后可能会转换为 AWAY 状态。
AWAY 用户目前处于离开状态。此状态可以是在处于 ACTIVE 或 IDLE 状态一段时间后自动设置的，也可以由用户手动设置。如果通过 availability.markAsAway 手动设置，则无论用户活动如何，此状态都会持续存在。
DO_NOT_DISTURB 用户处于“勿扰”状态，此状态是手动设置的。

DoNotDisturbMetadata

与 DO_NOT_DISTURB 可用性状态关联的元数据，用于指定状态的失效时间。

JSON 表示法 
{
  "expirationTime": string
}
字段
expirationTime

string (Timestamp format)

仅限输出。用户应被标记为 DO_NOT_DISTURB 的时间戳。此时间戳最长可为未来 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

 将用户在 Google Chat 中标记为 ACTIVE。

markAsAway

 将用户在 Google Chat 中标记为 AWAY。

markAsDoNotDisturb

 将用户在 Google Chat 中标记为 DO_NOT_DISTURB。

patch

 更新人类用户的可用性信息。