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 ساريًا

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

يستخدم هذا النوع 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".
حقل الدمج 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