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.