google_api_classroom v0.5.0 GoogleApi.Classroom.V1.Model.Announcement View Source
Announcement created by a teacher for students of the course
Attributes
- alternateLink (String.t): Absolute link to this announcement in the Classroom web UI.
This is only populated if
state
isPUBLISHED
.
Read-only. Defaults to nil
.
- assigneeMode (String.t): Assignee mode of the announcement.
If unspecified, the default value is
ALL_STUDENTS
. Defaults tonil
. - courseId (String.t): Identifier of the course.
Read-only. Defaults to nil
.
- creationTime (DateTime.t): Timestamp when this announcement was created.
Read-only. Defaults to nil
.
- creatorUserId (String.t): Identifier for the user that created the announcement.
Read-only. Defaults to nil
.
- id (String.t): Classroom-assigned identifier of this announcement, unique per course.
Read-only. Defaults to nil
.
- individualStudentsOptions (GoogleApi.Classroom.V1.Model.IndividualStudentsOptions.t): Identifiers of students with access to the announcement.
This field is set only if
assigneeMode
isINDIVIDUAL_STUDENTS
. If theassigneeMode
isINDIVIDUAL_STUDENTS
, then only students specified in this field will be able to see the announcement. Defaults tonil
. - materials (list(GoogleApi.Classroom.V1.Model.Material.t)): Additional materials.
Announcements must have no more than 20 material items. Defaults to nil
.
- scheduledTime (DateTime.t): Optional timestamp when this announcement is scheduled to be published. Defaults to
nil
. - state (String.t): Status of this announcement.
If unspecified, the default state is
DRAFT
. Defaults tonil
. - text (String.t): Description of this announcement.
The text must be a valid UTF-8 string containing no more
than 30,000 characters. Defaults to
nil
. - updateTime (DateTime.t): Timestamp of the most recent change to this announcement.
Read-only. Defaults to nil
.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Link to this type
t()
View Source
t()
View Source
t() :: %GoogleApi.Classroom.V1.Model.Announcement{
alternateLink: String.t(),
assigneeMode: String.t(),
courseId: String.t(),
creationTime: DateTime.t(),
creatorUserId: String.t(),
id: String.t(),
individualStudentsOptions:
GoogleApi.Classroom.V1.Model.IndividualStudentsOptions.t(),
materials: [GoogleApi.Classroom.V1.Model.Material.t()],
scheduledTime: DateTime.t(),
state: String.t(),
text: String.t(),
updateTime: DateTime.t()
}
t() :: %GoogleApi.Classroom.V1.Model.Announcement{ alternateLink: String.t(), assigneeMode: String.t(), courseId: String.t(), creationTime: DateTime.t(), creatorUserId: String.t(), id: String.t(), individualStudentsOptions: GoogleApi.Classroom.V1.Model.IndividualStudentsOptions.t(), materials: [GoogleApi.Classroom.V1.Model.Material.t()], scheduledTime: DateTime.t(), state: String.t(), text: String.t(), updateTime: DateTime.t() }
Link to this section Functions
Link to this function
decode(value, options) View Source
Unwrap a decoded JSON object into its complex fields.