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 باشد، این فیلد باید مشخص شود.

نوع خوراک

نوعی فید که یک برنامه می تواند برای اعلان ها ثبت نام کند.

Enums
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 Topic .

روش ها

create

 یک Registration ایجاد می کند و باعث می شود Classroom شروع به ارسال اعلان ها از feed ارائه شده به مقصد ارائه شده در cloudPubSubTopic کند.

delete

 یک Registration حذف می کند و باعث می شود Classroom ارسال اعلان برای آن Registration را متوقف کند.