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. على سبيل المثال، 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

 تعدِّل هذه الطريقة معلومات حالة التوفّر لمستخدم بشري.