REST Resource: users.availability

منبع: در دسترس بودن

اطلاعات در دسترس بودن فعلی کاربر در Google Chat، از جمله وضعیت او (مثلاً فعال، دور از دسترس، مزاحم نشوید) و هرگونه وضعیت سفارشی را نشان می‌دهد.

نمایش JSON 
{
  "name": string,
  "state": enum (State),
  "customStatus": {
    object (CustomStatus)
  },

  "doNotDisturbMetadata": {
    object (DoNotDisturbMetadata)
  }
}
فیلدها
name

string

شناسه. نام منبع در دسترس بودن کاربر.

قالب: users/{user}/availability

{user} شناسه‌ی Person در People API یا Admin SDK directory API است. برای مثال، users/123456789 .

آدرس ایمیل کاربر یا me نیز می‌تواند به عنوان نام مستعار برای اشاره به تماس‌گیرنده استفاده شود. برای مثال، users/user@example.com یا users/me .

state

enum ( State )

فقط خروجی. وضعیت فعلی دسترسی کاربر.

customStatus

object ( CustomStatus )

اختیاری. وضعیت سفارشی کاربر.

فراداده‌های اضافی مرتبط با وضعیت دسترسی کاربر. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
doNotDisturbMetadata

object ( DoNotDisturbMetadata )

فقط خروجی. فراداده در صورتی که وضعیت کاربر روی DO_NOT_DISTURB تنظیم شده باشد.

پایان میدان‌های ناسازگار.

ایالت

وضعیت فعلی دسترسی کاربر را نشان می‌دهد.

انوم‌ها
STATE_UNSPECIFIED مقدار پیش‌فرض. وضعیت نامشخص است.
ACTIVE بر اساس فعالیت‌های اخیر، کاربر در حال حاضر فعال است.
IDLE کاربر در حال حاضر بیکار است. این وضعیت نشان دهنده یک دوره عدم فعالیت پس از فعال بودن، قبل از انتقال بالقوه به حالت OUTY است.
AWAY کاربر در حال حاضر غایب است. این وضعیت می‌تواند یا به صورت خودکار پس از مدتی عدم فعالیت در حالت ACTIVE یا IDLE تنظیم شود، یا می‌تواند به صورت دستی توسط کاربر تنظیم شود. در صورت تنظیم دستی از طریق availability.markAsAway ، این وضعیت صرف نظر از فعالیت کاربر، حفظ می‌شود.
DO_NOT_DISTURB کاربر در حالت «مزاحم نشوید» است که به صورت دستی تنظیم شده است.

مزاحم نشویدفراداده

فراداده مرتبط با وضعیت در دسترس بودن DO_NOT_DISTURB ، که مشخص می‌کند وضعیت مورد نظر چه زمانی منقضی می‌شود.

نمایش JSON 
{
  "expirationTime": string
}
فیلدها
expirationTime

string ( Timestamp format)

فقط خروجی. مهر زمانی که تا آن زمان کاربر باید به عنوان DO_NOT_DISTURB علامت گذاری شود. این حداکثر می‌تواند ۱ سال آینده باشد.

وضعیت سفارشی

وضعیت سفارشی کاربر را در گوگل چت نشان می‌دهد. این شامل یک پیام متنی کوتاه با یک ایموجی اختیاری است که کاربر برای ارائه اطلاعات بیشتر در مورد در دسترس بودن خود تنظیم می‌کند.

نمایش JSON 
{
  "text": string,
  "emoji": {
    object (Emoji)
  },

  "expireTime": string,
  "ttl": string
}
فیلدها
text

string

الزامی. متن وضعیت سفارشی. این یک رشته با حداکثر طول ۶۴ خواهد بود.

emoji

object ( Emoji )

الزامی. ایموجی وضعیت سفارشی. فقط ایموجی‌های یونیکد پشتیبانی می‌شوند؛ ایموجی‌های سفارشی پشتیبانی نمی‌شوند.

زمان انقضای وضعیت سفارشی. می‌تواند به صورت یک مهر زمانی مطلق یا یک مدت زمان برای زنده ماندن مشخص شود. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در یک پاسخ تنظیم می‌شود:
expireTime

string ( Timestamp format)

مهر زمانی که وضعیت سفارشی منقضی می‌شود.

ttl

string ( Duration format)

فقط ورودی. مدت زمان ماندگاری که پس از آن وضعیت سفارشی منقضی می‌شود.

پایان میدان‌های ناسازگار.

روش‌ها

get

 اطلاعات در دسترس بودن برای یک کاربر انسانی در Google Chat را برمی‌گرداند.

markAsActive

 کاربر را در گوگل چت به عنوان ACTIVE علامت‌گذاری می‌کند.

markAsAway

 کاربر را در Google Chat به عنوان AWAY علامت‌گذاری می‌کند.

markAsDoNotDisturb

 کاربر را در چت گوگل به عنوان DO_NOT_DISTURB علامت‌گذاری می‌کند.

patch

 اطلاعات در دسترس بودن را برای یک کاربر انسانی به‌روزرسانی می‌کند.