REST Resource: courses.announcements

منبع: اطلاعیه

اطلاعیه ایجاد شده توسط استاد برای دانش آموزان دوره

نمایندگی 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

شناسه اختصاص داده شده به کلاس درس از این اطلاعیه، منحصر به فرد در هر دوره.

فقط خواندنی

text

string

شرح این اطلاعیه متن باید یک رشته معتبر UTF-8 باشد که بیش از 30000 کاراکتر نداشته باشد.

materials[]

object ( Material )

مواد اضافی.

اطلاعیه ها نباید بیش از 20 مورد مادی داشته باشند.

state

enum ( AnnouncementState )

وضعیت این اطلاعیه اگر مشخص نشده باشد، حالت پیش فرض DRAFT است.

creationTime

string ( Timestamp format)

زمان ایجاد این اعلامیه.

فقط خواندنی

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

مهر زمانی جدیدترین تغییر در این اعلامیه.

فقط خواندنی

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

scheduledTime

string ( Timestamp format)

مهر زمانی اختیاری زمانی که این اطلاعیه قرار است منتشر شود.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

assigneeMode

enum ( AssigneeMode )

حالت تکلیف اعلامیه. اگر مشخص نشده باشد، مقدار پیش‌فرض ALL_STUDENTS است.

individualStudentsOptions

object ( IndividualStudentsOptions )

شناسه دانش آموزان با دسترسی به اطلاعیه. این فیلد فقط در صورتی تنظیم می‌شود که assigneeMode INDIVIDUAL_STUDENTS باشد. اگر assigneeMode INDIVIDUAL_STUDENTS باشد، فقط دانش‌آموزانی که در این قسمت مشخص شده‌اند می‌توانند اعلامیه را ببینند.

creatorUserId

string

شناسه کاربری که اعلامیه را ایجاد کرده است.

فقط خواندنی

اعلام ایالت

وضعیت های احتمالی اعلامیه ها

Enums
ANNOUNCEMENT_STATE_UNSPECIFIED هیچ ایالتی مشخص نشده است. این هرگز برگردانده نمی شود.
PUBLISHED وضعیت اطلاعیه ای که منتشر شده است. این حالت پیش فرض است.
DRAFT وضعیت اطلاعیه ای که هنوز منتشر نشده است. اطلاعیه در این حالت فقط برای معلمان دوره و مدیران دامنه قابل مشاهده است.
DELETED وضعیت اطلاعیه ای که منتشر شد اما اکنون حذف شده است. اطلاعیه در این حالت فقط برای معلمان دوره و مدیران دامنه قابل مشاهده است. اعلان در این حالت پس از مدتی حذف می شود.

روش ها

create

 اعلامیه ایجاد می کند.

delete

 یک اعلامیه را حذف می کند.

get

 اعلامیه ای را برمی گرداند.

getAddOnContext

 فراداده‌های افزونه‌های Classroom را در زمینه یک پست خاص دریافت می‌کند.

list

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

modifyAssignees

 حالت واگذارنده و گزینه های یک اعلامیه را اصلاح می کند.

patch

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