REST Resource: users.availability

Kaynak: Stok durumu

Kullanıcının Google Chat'teki mevcut müsaitlik durumu bilgilerini (ör. durumu: Etkin, Dışarıda, Rahatsız Etmeyin ve özel durum) gösterir.

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

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

string

Tanımlayıcı. Kullanıcının uygunluk durumunun kaynak adı.

Biçim: users/{user}/availability

{user}, People API veya Admin SDK Directory API'deki Kişi'nin kimliğidir. Örneğin, users/123456789.

Kullanıcının e-posta adresi veya me, arayanı belirtmek için takma ad olarak da kullanılabilir. Örneğin, users/user@example.com veya users/me

state

enum (State)

Yalnızca çıkış. Kullanıcının mevcut müsaitlik durumu.

customStatus

object (CustomStatus)

İsteğe bağlı. Kullanıcının özel durumu.

state_metadata birleşik alanı. Kullanıcının müsaitlik durumuyla ilişkili ek meta veriler. state_metadata aşağıdakilerden yalnızca biri olabilir:
doNotDisturbMetadata

object (DoNotDisturbMetadata)

Yalnızca çıkış. Kullanıcı durumu DO_NOT_DISTURB olarak ayarlanmışsa meta veriler.

Eyalet

Kullanıcının mevcut müsaitlik durumunu gösterir.

Sıralamalar
STATE_UNSPECIFIED Varsayılan değer. Durum belirtilmemiş.
ACTIVE Kullanıcı, son etkinliğe göre şu anda etkin.
IDLE Kullanıcı şu anda boşta. Bu durum, ETKİN olduktan sonra UZAKTA durumuna geçmeden önceki etkinlik olmama süresini gösterir.
AWAY Kullanıcı şu anda dışarıda. Bu süre, ETKİN veya BOŞTA durumunda bir süre işlem yapılmadığında otomatik olarak ayarlanabilir ya da kullanıcı tarafından manuel olarak ayarlanabilir. availability.markAsAway aracılığıyla manuel olarak ayarlandığında bu durum, kullanıcı etkinliğinden bağımsız olarak devam eder.
DO_NOT_DISTURB Kullanıcı, manuel olarak ayarlanan Rahatsız Etmeyin durumundadır.

DoNotDisturbMetadata

DO_NOT_DISTURB stok durumuyla ilişkili meta veriler. Durumun geçerliliğinin ne zaman sona ereceğini belirtir.

JSON gösterimi
{
  "expirationTime": string
}
Alanlar
expirationTime

string (Timestamp format)

Yalnızca çıkış. Kullanıcının DO_NOT_DISTURB olarak işaretlenmesi gereken zaman damgası. Bu tarih en fazla 1 yıl sonrası olabilir.

CustomStatus

Google Chat'teki kullanıcının özel durumunu gösterir. Bu, kullanıcının müsaitlik durumu hakkında daha fazla bilgi vermek için ayarladığı isteğe bağlı bir emoji içeren kısa bir metin mesajını içerir.

JSON gösterimi
{
  "text": string,
  "emoji": {
    object (Emoji)
  },

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

string

Zorunlu. Özel durumun metni. Bu, maksimum 64 karakter uzunluğunda bir dize olacaktır.

emoji

object (Emoji)

Zorunlu. Özel durumun emojisi. Yalnızca Unicode emojileri desteklenir. Özel emojiler desteklenmez.

expiration birleşik alanı. Özel durumun son kullanma zamanı. Mutlak zaman damgası veya geçerlilik süresi olarak belirtilebilir. expiration aşağıdakilerden yalnızca biri olabilir:
expireTime

string (Timestamp format)

Özel durumun süresinin dolduğu zaman damgası.

ttl

string (Duration format)

Yalnızca giriş. Özel durumun sona ereceği süre.

Yöntemler

get

Google Chat'teki bir kullanıcı için müsaitlik durumu bilgilerini döndürür.

markAsActive

Kullanıcıyı Google Chat'te ACTIVE olarak işaretler.

markAsAway

Kullanıcıyı Google Chat'te AWAY olarak işaretler.

markAsDoNotDisturb

Google Chat'te kullanıcıyı DO_NOT_DISTURB olarak işaretler.

patch

Gerçek bir kullanıcının müsaitlik durumu bilgilerini günceller.