REST Resource: registrations

المرجع: التسجيل

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

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

  // Union field destination can be only one of the following:
  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field destination.
}
الحقول
registrationId

string

تمثّل هذه السمة المعرّف الفريد الذي ينشئه الخادم لهذه Registration.

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

object (Feed)

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

string (Timestamp format)

تمثّل هذه السمة الوقت الذي تسري فيه السمة Registration.

هذا الحقل للقراءة فقط تم تخصيصه من قِبل الخادم.

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"
حقل الاتحاد destination العنوان الذي يجب إرسال الإشعارات إليه يمكن أن تكون السمة "destination" واحدة فقط مما يلي:
cloudPubsubTopic

object (CloudPubsubTopic)

موضوع Cloud Pub/Sub الذي سيتم إرسال الإشعارات إليه.

الخلاصة

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

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

  // Union field info can be only one of the following:
  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
  // End of list of possible types for union field info.
}
الحقول
feedType

enum (FeedType)

نوع الخلاصة
حقل الاتحاد info معلَمات إضافية عن الخلاصة. يمكن أن تكون السمة "info" واحدة فقط مما يلي:
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.