REST Resource: users.availability

Recurso: disponibilidade

Representa as informações de disponibilidade atuais de um usuário no Google Chat, incluindo o estado (por exemplo, ativo, ausente, não perturbe) e qualquer status personalizado.

Representação JSON 
{
  "name": string,
  "state": enum (State),
  "customStatus": {
    object (CustomStatus)
  },

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

string

Identificador. Nome do recurso da disponibilidade do usuário.

Formato: users/{user}/availability

{user} é o ID da pessoa na API People ou na API Directory do SDK Admin. Por exemplo, users/123456789.

O endereço de e-mail ou o me do usuário também pode ser usado como um alias para se referir ao autor da chamada. Por exemplo, users/user@example.com ou users/me.
state

enum (State)

Apenas saída. O estado de disponibilidade atual do usuário.
customStatus

object (CustomStatus)

Opcional. O status personalizado do usuário.
Metadados adicionais associados ao estado de disponibilidade do usuário. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo, um dos campos será definido em uma resposta:
doNotDisturbMetadata

object (DoNotDisturbMetadata)

Apenas saída. Metadados se o estado do usuário estiver definido como DO_NOT_DISTURB.
Fim dos campos mutuamente exclusivos.

Estado

Representa o estado de disponibilidade atual do usuário.

Tipos enumerados
STATE_UNSPECIFIED Valor padrão. O estado não foi especificado.
ACTIVE O usuário está ativo no momento, com base na atividade recente.
IDLE O usuário está inativo no momento. Esse estado indica um período de inatividade após estar ATIVO, antes de possivelmente passar para AUSENTE.
AWAY O usuário está ausente no momento. Isso pode ser definido automaticamente após um período de inatividade no estado ATIVO ou INATIVO ou manualmente pelo usuário. Quando definido manualmente via availability.markAsAway, esse estado persiste independente da atividade do usuário.
DO_NOT_DISTURB O usuário está no modo Não perturbe, que é definido manualmente.

DoNotDisturbMetadata

Metadados associados ao estado de disponibilidade DO_NOT_DISTURB, especificando quando o estado expira.

Representação JSON 
{
  "expirationTime": string
}
Campos
expirationTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora até o qual o usuário deve ser marcado como "NÃO PERTURBE". Esse período pode ser de até um ano no futuro.

CustomStatus

Representa o status personalizado de um usuário no Google Chat. Isso inclui uma mensagem de texto curta com um emoji opcional que o usuário define para dar mais contexto sobre a disponibilidade.

Representação JSON 
{
  "text": string,
  "emoji": {
    object (Emoji)
  },

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

string

Obrigatório. O texto do status personalizado. Será uma string com comprimento máximo de 64.
emoji

object (Emoji)

Obrigatório. O emoji do status personalizado. Apenas emojis Unicode são aceitos. Emojis personalizados não são compatíveis.
O tempo de expiração do status personalizado. Ele pode ser especificado como um carimbo de data/hora absoluto ou uma duração de tempo de vida. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo, um dos campos será definido em uma resposta:
expireTime

string (Timestamp format)

O carimbo de data/hora em que o status personalizado expira.
ttl

string (Duration format)

Somente entrada. O período de tempo de vida após o qual o status personalizado expira.
Fim dos campos mutuamente exclusivos.

Métodos

get

 Retorna informações de disponibilidade de um usuário humano no Google Chat.

markAsActive

 Marca o usuário como ACTIVE no Google Chat.

markAsAway

 Marca o usuário como AWAY no Google Chat.

markAsDoNotDisturb

 Marca o usuário como DO_NOT_DISTURB no Google Chat.

patch

 Atualiza as informações de disponibilidade de um usuário humano.