REST Resource: users.sections

منبع: بخش

نشان‌دهنده‌ی بخشی در گوگل چت است. بخش‌ها به کاربران کمک می‌کنند تا فضاهای خود را سازماندهی کنند. دو نوع بخش وجود دارد:

  1. بخش‌های سیستم: این‌ها بخش‌های از پیش تعریف‌شده‌ای هستند که توسط گوگل چت مدیریت می‌شوند. نام منابع آن‌ها ثابت است و نمی‌توان آن‌ها را ایجاد، حذف یا displayName آن‌ها را تغییر داد. مثال‌ها عبارتند از:

    • users/{user}/sections/default-direct-messages
    • users/{user}/sections/default-spaces
    • users/{user}/sections/default-apps
  2. بخش‌های سفارشی: این‌ها بخش‌هایی هستند که توسط کاربر ایجاد و مدیریت می‌شوند. ایجاد یک بخش سفارشی با استفاده از sections.create نیاز به یک displayName دارد. بخش‌های سفارشی را می‌توان با استفاده از sections.patch به‌روزرسانی و با استفاده از sections.delete حذف کرد.

نمایش JSON
{
  "name": string,
  "displayName": string,
  "sortOrder": integer,
  "type": enum (SectionType)
}
فیلدها
name

string

شناسه. نام منبع بخش.

برای بخش‌های سیستم، شناسه بخش یک رشته ثابت است:

  • پیام‌های مستقیم پیش‌فرض: users/{user}/sections/default-direct-messages
  • فاصله‌های پیش‌فرض: users/{user}/sections/default-spaces
  • DEFAULT_APPS: users/{user}/sections/default-apps

قالب: users/{user}/sections/{section}

displayName

string

الزامی. نام نمایشی بخش. فقط برای بخش‌هایی از نوع CUSTOM_SECTION پر می‌شود. حداکثر ۸۰ کاراکتر را پشتیبانی می‌کند. هنگام ایجاد یک CUSTOM_SECTION الزامی است.

sortOrder

integer

فقط خروجی. ترتیب بخش نسبت به سایر بخش‌ها. بخش‌هایی که مقدار sortOrder پایین‌تری دارند، قبل از بخش‌هایی با مقدار بالاتر ظاهر می‌شوند.

type

enum ( SectionType )

الزامی. نوع بخش.

نوع بخش

انواع بخش.

انوم‌ها
SECTION_TYPE_UNSPECIFIED نوع بخش نامشخص
CUSTOM_SECTION بخش سفارشی.
DEFAULT_DIRECT_MESSAGES بخش پیش‌فرض شامل DIRECT_MESSAGE بین دو کاربر انسانی یا فضاهای GROUP_CHAT که به هیچ بخش سفارشی تعلق ندارند.
DEFAULT_SPACES فضاهای پیش‌فرض که به هیچ بخش سفارشی تعلق ندارند.
DEFAULT_APPS بخش پیش‌فرض شامل برنامه‌های نصب‌شده‌ی کاربر.

روش‌ها

create

یک بخش در گوگل چت ایجاد می‌کند.

delete

یک بخش از نوع CUSTOM_SECTION را حذف می‌کند.

list

بخش‌های موجود برای کاربر چت را فهرست می‌کند.

patch

یک بخش را به‌روزرسانی می‌کند.

position

ترتیب مرتب‌سازی یک بخش را تغییر می‌دهد.