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

المعرّف الذي يحدّده Classroom لهذا الإشعار، وهو معرّف فريد لكل دورة تدريبية.

للقراءة فقط.

text

string

وصف هذا الإشعار يجب أن يكون النص سلسلة UTF-8 صالحة لا تحتوي على أكثر من 30,000 حرف.

materials[]

object (Material)

مواد إضافية

يجب ألا تحتوي الإشعارات على أكثر من 20 عنصرًا من عناصر المواد.

state

enum (AnnouncementState)

تمثّل هذه السمة حالة الإشعار. إذا لم يتم تحديدها، تكون الحالة التلقائية هي DRAFT.

creationTime

string (Timestamp format)

الطابع الزمني لوقت إنشاء هذا الإشعار.

للقراءة فقط.

يستخدم هذا النوع RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا Z-normalized ويستخدم 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-normalized ويستخدم 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-normalized ويستخدم 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

الحالات المحتملة للإشعارات

عمليات التعداد
ANNOUNCEMENT_STATE_UNSPECIFIED لم يتم تحديد أي ولاية. لا يتم عرض هذه القيمة أبدًا.
PUBLISHED حالة الإعلان الذي تم نشره هذه هي الحالة التلقائية.
DRAFT حالة إشعار لم يتم نشره بعد. لا يظهر الإشعار في هذه الحالة إلا لمعلّمي الدورة التدريبية ومشرفي النطاق.
DELETED حالة الإشعار الذي تم نشره ولكن تم حذفه الآن لا يظهر الإشعار في هذه الحالة إلا لمعلّمي الدورة التدريبية ومشرفي النطاق. يتم حذف الإشعار في هذه الحالة بعد مرور بعض الوقت.

الطُرق

create

تنشئ هذه الطريقة إشعارًا.

delete

لحذف إشعار

get

تعرض هذه الطريقة إشعارًا.

getAddOnContext

تعرض هذه الطريقة البيانات الوصفية الخاصة بإضافات Classroom في سياق مشاركة معيّنة.

list

تعرض هذه الطريقة قائمة بالإشعارات التي يُسمح لمقدّم الطلب بعرضها.

modifyAssignees

تعديل وضع المستخدم المعيّن وخيارات إشعار

patch

تعدّل هذه الطريقة حقلًا واحدًا أو أكثر من حقول الإشعار.