REST Resource: users.sections

संसाधन: सेक्शन

यह Google Chat में मौजूद सेक्शन को दिखाता है. सेक्शन की मदद से, उपयोगकर्ता अपने स्पेस को व्यवस्थित कर सकते हैं. सेक्शन दो तरह के होते हैं:

  1. सिस्टम सेक्शन: ये पहले से तय किए गए सेक्शन होते हैं, जिन्हें Google Chat मैनेज करता है. इनके संसाधन के नाम तय होते हैं. इन्हें न तो बनाया जा सकता है और न ही मिटाया जा सकता है. साथ ही, इनके 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

आइडेंटिफ़ायर. सेक्शन के संसाधन का नाम.

सिस्टम सेक्शन के लिए, सेक्शन आईडी एक कॉन्स्टेंट स्ट्रिंग होती है:

  • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
  • DEFAULT_SPACES: users/{user}/sections/default-spaces
  • DEFAULT_APPS: users/{user}/sections/default-apps

फ़ॉर्मैट: users/{user}/sections/{section}
displayName

string

ज़रूरी है. सेक्शन का डिसप्ले नेम. यह सिर्फ़ CUSTOM_SECTION टाइप के सेक्शन के लिए अपने-आप भरता है. इसमें ज़्यादा से ज़्यादा 80 वर्ण डाले जा सकते हैं. CUSTOM_SECTION बनाते समय यह एट्रिब्यूट ज़रूरी है.
sortOrder

integer

सिर्फ़ आउटपुट के लिए. अन्य सेक्शन के मुकाबले, सेक्शन का क्रम. कम sortOrder वैल्यू वाले सेक्शन, ज़्यादा वैल्यू वाले सेक्शन से पहले दिखते हैं.
type

enum (SectionType)

ज़रूरी है. सेक्शन किस तरह का है.

SectionType

सेक्शन के टाइप.

Enums
SECTION_TYPE_UNSPECIFIED सेक्शन का टाइप तय नहीं किया गया है.
CUSTOM_SECTION कस्टम सेक्शन.
DEFAULT_DIRECT_MESSAGES डिफ़ॉल्ट सेक्शन में, दो लोगों के बीच हुए DIRECT_MESSAGE या ऐसे GROUP_CHAT स्पेस होते हैं जो किसी कस्टम सेक्शन से जुड़े नहीं होते.
DEFAULT_SPACES डिफ़ॉल्ट स्पेस, जो किसी कस्टम सेक्शन से नहीं जुड़े हैं.
DEFAULT_APPS डिफ़ॉल्ट सेक्शन में, उपयोगकर्ता के इंस्टॉल किए गए ऐप्लिकेशन शामिल होते हैं.

तरीके

create

 Google Chat में सेक्शन बनाता है.

delete

 यह CUSTOM_SECTION टाइप के सेक्शन को मिटाता है.

list

 Chat उपयोगकर्ता के लिए उपलब्ध सेक्शन की सूची बनाता है.

patch

 किसी सेक्शन को अपडेट करता है.

position

 इससे किसी सेक्शन के क्रम में बदलाव होता है.