REST Resource: courses.announcements

संसाधन: Announcement

किसी शिक्षक ने कोर्स में शामिल छात्र-छात्राओं के लिए सूचना बनाई है

JSON के काेड में दिखाना
{
  "courseId": string,
  "id": string,
  "text": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "state": enum (AnnouncementState),
  "alternateLink": string,
  "creationTime": string,
  "updateTime": string,
  "scheduledTime": string,
  "assigneeMode": enum (AssigneeMode),
  "individualStudentsOptions": {
    object (IndividualStudentsOptions)
  },
  "creatorUserId": string
}
फ़ील्ड
courseId

string

कोर्स का आइडेंटिफ़ायर.

सिर्फ़ पढ़ने के लिए.

id

string

यह सूचना के लिए Classroom की ओर से असाइन किया गया आइडेंटिफ़ायर है. यह हर कोर्स के लिए यूनीक होता है.

सिर्फ़ पढ़ने के लिए.

text

string

इस सूचना का ब्यौरा. टेक्स्ट, मान्य UTF-8 स्ट्रिंग होना चाहिए. इसमें 30,000 से ज़्यादा वर्ण नहीं होने चाहिए.

materials[]

object (Material)

अतिरिक्त संसाधन.

सूचनाओं में 20 से ज़्यादा मटीरियल आइटम नहीं होने चाहिए.

state

enum (AnnouncementState)

इस सूचना की स्थिति. अगर इसे तय नहीं किया गया है, तो डिफ़ॉल्ट स्थिति DRAFT होती है.

creationTime

string (Timestamp format)

इस सूचना को बनाए जाने का टाइमस्टैंप.

सिर्फ़ पढ़ने के लिए.

यह RFC 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

इस सूचना में सबसे हाल ही में किए गए बदलाव का टाइमस्टैंप.

सिर्फ़ पढ़ने के लिए.

यह RFC 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".

scheduledTime

string (Timestamp format)

यह टाइमस्टैंप तब इस्तेमाल किया जाता है, जब इस सूचना को पब्लिश करने का समय तय किया गया हो. हालांकि, यह ज़रूरी नहीं है.

यह RFC 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".

assigneeMode

enum (AssigneeMode)

सूचना देने वाले व्यक्ति का मोड. अगर कोई वैल्यू तय नहीं की गई है, तो डिफ़ॉल्ट वैल्यू ALL_STUDENTS होती है.

individualStudentsOptions

object (IndividualStudentsOptions)

सूचना का ऐक्सेस रखने वाले छात्र-छात्राओं के आइडेंटिफ़ायर. इस फ़ील्ड को सिर्फ़ तब सेट किया जाता है, जब assigneeMode को INDIVIDUAL_STUDENTS पर सेट किया गया हो. अगर assigneeMode INDIVIDUAL_STUDENTS है, तो इस फ़ील्ड में बताए गए छात्र-छात्राएं ही सूचना देख सकते हैं.

creatorUserId

string

सूचना बनाने वाले उपयोगकर्ता के लिए आइडेंटिफ़ायर.

सिर्फ़ पढ़ने के लिए.

AnnouncementState

सूचनाओं की संभावित स्थितियां

Enums
ANNOUNCEMENT_STATE_UNSPECIFIED कोई राज्य नहीं चुना गया है. यह कभी वापस नहीं मिलता.
PUBLISHED सूचना के पब्लिश होने का स्टेटस. यह डिफ़ॉल्ट स्थिति है.
DRAFT यह सूचना के लिए ऐसा स्टेटस है जिसे अब तक पब्लिश नहीं किया गया है. इस स्थिति में सूचना सिर्फ़ कोर्स के शिक्षकों और डोमेन एडमिन को दिखती है.
DELETED सूचना का स्टेटस, जिसे पब्लिश किया गया था, लेकिन अब मिटा दिया गया है. इस स्थिति में सूचना सिर्फ़ कोर्स के शिक्षकों और डोमेन एडमिन को दिखती है. इस स्थिति में सूचना को कुछ समय बाद मिटा दिया जाता है.

तरीके

create

सूचना बनाता है.

delete

इस कुकी का इस्तेमाल, किसी सूचना को मिटाने के लिए किया जाता है.

get

इस फ़ंक्शन से कोई सूचना मिलती है.

getAddOnContext

किसी पोस्ट के संदर्भ में, Classroom ऐड-ऑन के लिए मेटाडेटा मिलता है.

list

अनुरोध करने वाले व्यक्ति को जिन सूचनाओं को देखने की अनुमति है उनकी सूची दिखाता है.

modifyAssignees

इस कुकी का इस्तेमाल, सूचना असाइन करने के मोड और विकल्पों में बदलाव करने के लिए किया जाता है.

patch

इस तरीके का इस्तेमाल करके, सूचना के एक या उससे ज़्यादा फ़ील्ड अपडेट किए जा सकते हैं.