REST Resource: courses.announcements

Tài nguyên: Thông báo

Thông báo do giáo viên tạo cho học viên của khoá học

Biểu diễn dưới dạng JSON 
{
  "courseId": string,
  "id": string,
  "text": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "state": enum (AnnouncementState),
  "alternateLink": string,
  "creationTime": string,
  "updateTime": string,
  "scheduledTime": string,
  "assigneeMode": enum (AssigneeMode),
  "individualStudentsOptions": {
    object (IndividualStudentsOptions)
  },
  "creatorUserId": string
}
Trường
courseId

string

Giá trị nhận dạng của khoá học.

Chỉ đọc.
id

string

Giá trị nhận dạng do Lớp học chỉ định cho thông báo này, là giá trị duy nhất cho mỗi khoá học.

Chỉ đọc.
text

string

Nội dung mô tả về thông báo này. Văn bản phải là một chuỗi UTF-8 hợp lệ,không được chứa quá 30.000 ký tự.
materials[]

object (Material)

Tài liệu bổ sung.

Thông báo không được có quá 20 mục tài liệu.
state

enum (AnnouncementState)

Trạng thái của thông báo này. Nếu bạn không chỉ định, trạng thái mặc định sẽ là DRAFT.
creationTime

string (Timestamp format)

Dấu thời gian cho biết thời điểm tạo thông báo này.

Chỉ đọc.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Dấu thời gian của thay đổi gần đây nhất đối với thông báo này.

Chỉ đọc.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
scheduledTime

string (Timestamp format)

Dấu thời gian không bắt buộc khi thông báo này được lên lịch xuất bản.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
assigneeMode

enum (AssigneeMode)

Chế độ người được giao của thông báo. Nếu bạn không chỉ định, giá trị mặc định sẽ là ALL_STUDENTS.
individualStudentsOptions

object (IndividualStudentsOptions)

Mã nhận dạng của những học viên có quyền truy cập vào thông báo. Trường này chỉ được đặt nếu assigneeMode là INDIVIDUAL_STUDENTS. Nếu assigneeMode là INDIVIDUAL_STUDENTS, thì chỉ những học viên được chỉ định trong trường này mới có thể xem thông báo.
creatorUserId

string

Giá trị nhận dạng của người dùng đã tạo thông báo.

Chỉ đọc.

AnnouncementState

Các trạng thái có thể có của thông báo

Enum
ANNOUNCEMENT_STATE_UNSPECIFIED Chưa chỉ định tiểu bang. Giá trị này không bao giờ được trả về.
PUBLISHED Trạng thái của thông báo đã được xuất bản. Đây là trạng thái mặc định.
DRAFT Trạng thái của một thông báo chưa được xuất bản. Thông báo ở trạng thái này chỉ có giáo viên của khoá học và quản trị viên miền mới nhìn thấy.
DELETED Trạng thái của thông báo đã được xuất bản nhưng hiện đã bị xoá. Thông báo ở trạng thái này chỉ có giáo viên của khoá học và quản trị viên miền mới nhìn thấy. Thông báo ở trạng thái này sẽ bị xoá sau một khoảng thời gian.

Phương thức

create

 Tạo thông báo.

delete

 Xoá một thông báo.

get

 Trả về một thông báo.

getAddOnContext

 Lấy siêu dữ liệu cho các tiện ích bổ sung của Lớp học trong bối cảnh của một bài đăng cụ thể.

list

 Trả về danh sách thông báo mà người yêu cầu được phép xem.

modifyAssignees

 Sửa đổi chế độ người được giao và các lựa chọn của thông báo.

patch

 Cập nhật một hoặc nhiều trường của một thông báo.