REST Resource: registrations

المورد: التسجيل

تعليمات إلى Classroom لإرسال إشعارات من feed إلى الوجهة المحدّدة

تمثيل JSON 
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
الحقول
registrationId

string

معرّف فريد تم إنشاؤه من خلال الخادم لـ Registration.

للقراءة فقط.
feed

object (Feed)

مواصفات فئة الإشعارات التي يجب أن يرسلها Classroom إلى الوجهة
expiryTime

string (Timestamp format)

الوقت الذي يظل فيه Registration ساريًا.

هذا حقل للقراءة فقط يحدّده الخادم.

يستخدم المعيار 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"
العنوان الذي يجب إرسال الإشعارات إليه في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
cloudPubsubTopic

object (CloudPubsubTopic)

موضوع Cloud Pub/Sub الذي سيتم إرسال الإشعارات إليه
نهاية الحقول التي يستبعد كلّ منها الآخر

الخلاصة

فئة من الإشعارات يمكن للتطبيق التسجيل لتلقّيها على سبيل المثال: "جميع التغييرات في قائمة الطلاب المسجّلين لنطاق معيّن".

تمثيل JSON 
{
  "feedType": enum (FeedType),

  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
}
الحقول
feedType

enum (FeedType)

نوع الخلاصة
مَعلمات إضافية حول الخلاصة في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

معلومات حول Feed مع feedType من COURSE_ROSTER_CHANGES. يجب تحديد هذا الحقل إذا كانت قيمة feedType هي COURSE_ROSTER_CHANGES.
courseWorkChangesInfo

object (CourseWorkChangesInfo)

معلومات حول Feed مع feedType من COURSE_WORK_CHANGES. يجب تحديد هذا الحقل إذا كانت قيمة feedType هي COURSE_WORK_CHANGES.
نهاية الحقول التي يستبعد كلّ منها الآخر

FeedType

نوع من الخلاصات يمكن للتطبيق التسجيل فيه لتلقّي الإشعارات منه

عمليات التعداد
FEED_TYPE_UNSPECIFIED يجب عدم عرضها أو تقديمها مطلقًا.
DOMAIN_ROSTER_CHANGES

جميع التغييرات في قائمة الطلاب المسجّلين لنطاق معيّن

سيتم إنشاء إشعارات عندما ينضم مستخدم إلى دورة تدريبية أو يغادرها.

لن يتم إنشاء أي إشعارات عند إنشاء دعوة أو حذفها، ولكن سيتم إنشاء إشعارات عندما ينضم مستخدم إلى دورة تدريبية من خلال قبول دعوة.
COURSE_ROSTER_CHANGES

جميع التغييرات في قائمة الطلاب المسجّلين لدورة تدريبية معيّنة

سيتم إنشاء إشعارات عندما ينضم مستخدم إلى دورة تدريبية أو يغادرها.

لن يتم إنشاء أي إشعارات عند إنشاء دعوة أو حذفها، ولكن سيتم إنشاء إشعارات عندما ينضم مستخدم إلى دورة تدريبية من خلال قبول دعوة.
COURSE_WORK_CHANGES

جميع أنشطة الواجبات الدراسية لدورة تدريبية معيّنة

سيتم إنشاء الإشعارات عند إنشاء عنصر CourseWork أو StudentSubmission أو تعديله. لن يتم إنشاء أي إشعار عند إنشاء عنصر StudentSubmission مرتبط بإنشاء عنصر CourseWork الرئيسي أو تعديله (ولكن سيتم إنشاء إشعار لإنشاء عنصر CourseWork أو تعديله).

CourseRosterChangesInfo

معلومات حول Feed مع feedType من COURSE_ROSTER_CHANGES.

تمثيل JSON 
{
  "courseId": string
}
الحقول
courseId

string

‫courseId الدورة التدريبية التي تريد الاشتراك في تغييرات قائمة الطلاب المسجّلين فيها

CourseWorkChangesInfo

معلومات حول Feed مع feedType من COURSE_WORK_CHANGES.

تمثيل JSON 
{
  "courseId": string
}
الحقول
courseId

string

تمثّل هذه السمة courseId الدورة التدريبية التي تريد الاشتراك فيها لتلقّي إشعارات بشأن التغييرات في العمل.

CloudPubsubTopic

مرجع لموضوع Cloud Pub/Sub.

للتسجيل لتلقّي الإشعارات، يجب أن يمنح مالك الموضوع classroom-notifications@system.gserviceaccount.com الإذن projects.topics.publish.

تمثيل JSON 
{
  "topicName": string
}
الحقول
topicName

string

حقل name في موضوع Cloud Pub/Sub.

الطُرق

create

 تنشئ هذه الطريقة Registration، ما يؤدي إلى بدء Classroom في إرسال الإشعارات من feed المقدَّم إلى الوجهة المقدَّمة في cloudPubSubTopic.

delete

 يؤدي هذا الإجراء إلى حذف Registration، ما يؤدي إلى توقّف Classroom عن إرسال إشعارات بشأن Registration.