REST Resource: courses.announcements

Ресурс: Объявление

Объявление созданное преподавателем для студентов курса

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
}
Поля
courseId

string

Идентификатор курса.

Только для чтения.

id

string

Идентификатор этого объявления, присвоенный классом, уникальный для каждого курса.

Только для чтения.

text

string

Описание этого объявления. Текст должен представлять собой действительную строку UTF-8, содержащую не более 30 000 символов.

materials[]

object ( Material )

Дополнительные материалы.

Объявления должны содержать не более 20 существенных пунктов.

state

enum ( AnnouncementState )

Статус этого объявления. Если не указано, состояние по умолчанию — DRAFT .

creationTime

string ( Timestamp format)

Временная метка создания этого объявления.

Только для чтения.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

Временная метка последнего изменения этого объявления.

Только для чтения.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

scheduledTime

string ( Timestamp format)

Необязательная временная метка, когда планируется опубликовать это объявление.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

assigneeMode

enum ( AssigneeMode )

Режим правопреемника объявления. Если не указано, значение по умолчанию — ALL_STUDENTS .

individualStudentsOptions

object ( IndividualStudentsOptions )

Идентификаторы студентов, имеющих доступ к объявлению. Это поле устанавливается только в том случае, если assigneeMode имеет INDIVIDUAL_STUDENTS . Если assigneeMode имеет INDIVIDUAL_STUDENTS , то объявление смогут видеть только учащиеся, указанные в этом поле.

creatorUserId

string

Идентификатор пользователя, создавшего объявление.

Только для чтения.

Состояние объявления

Возможные состояния объявлений

Перечисления
ANNOUNCEMENT_STATE_UNSPECIFIED Штат не указан. Это никогда не возвращается.
PUBLISHED Статус опубликованного объявления. Это состояние по умолчанию.
DRAFT Статус объявления, которое еще не опубликовано. Объявление в этом состоянии видно только преподавателям курса и администраторам домена.
DELETED Статус объявления, которое было опубликовано, но сейчас удалено. Объявление в этом состоянии видно только преподавателям курса и администраторам домена. Объявление в таком состоянии через некоторое время удаляется.

Методы

create

 Создает объявление.

delete

 Удаляет объявление.

get

 Возвращает объявление.

getAddOnContext

 Получает метаданные для надстроек Класса в контексте определенного сообщения.

list

 Возвращает список объявлений, которые запрашивающему разрешено просматривать.

modifyAssignees

 Изменяет режим ответственного и параметры объявления.

patch

 Обновляет одно или несколько полей объявления.