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. مثلاً: 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 عليه حتى ذلك الوقت يمكن أن يصل الحد الأقصى إلى عام واحد في المستقبل.

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 Chat.

markAsAway

 يضع علامة AWAY على المستخدم في Google Chat.

markAsDoNotDisturb

 يضع علامة DO_NOT_DISTURB على المستخدم في Google Chat.

patch

 تعديل معلومات مدى التوفّر لمستخدم بشري