Resource: Announcement
Announcement created by a teacher for students of the course
JSON representation |
---|
{ "courseId": string, "id": string, "text": string, "materials": [ { object ( |
Fields | |
---|---|
courseId |
Identifier of the course. Read-only. |
id |
Classroom-assigned identifier of this announcement, unique per course. Read-only. |
text |
Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters. |
materials[] |
Additional materials. Announcements must have no more than 20 material items. |
state |
Status of this announcement. If unspecified, the default state is |
alternateLink |
Absolute link to this announcement in the Classroom web UI. This is only populated if Read-only. |
creationTime |
Timestamp when this announcement was created. Read-only. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Timestamp of the most recent change to this announcement. Read-only. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
scheduledTime |
Optional timestamp when this announcement is scheduled to be published. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
assigneeMode |
Assignee mode of the announcement. If unspecified, the default value is |
individualStudentsOptions |
Identifiers of students with access to the announcement. This field is set only if |
creatorUserId |
Identifier for the user that created the announcement. Read-only. |
AnnouncementState
Possible states of announcements
Enums | |
---|---|
ANNOUNCEMENT_STATE_UNSPECIFIED |
No state specified. This is never returned. |
PUBLISHED |
Status for announcement that has been published. This is the default state. |
DRAFT |
Status for an announcement that is not yet published. Announcement in this state is visible only to course teachers and domain administrators. |
DELETED |
Status for announcement that was published but is now deleted. Announcement in this state is visible only to course teachers and domain administrators. Announcement in this state is deleted after some time. |
Methods |
|
---|---|
|
Creates an announcement. |
|
Deletes an announcement. |
|
Returns an announcement. |
|
Gets metadata for Classroom add-ons in the context of a specific post. |
|
Returns a list of announcements that the requester is permitted to view. |
|
Modifies assignee mode and options of an announcement. |
|
Updates one or more fields of an announcement. |