View Source GoogleApi.Classroom.V1.Model.Announcement (google_api_classroom v0.21.2)

Announcement created by a teacher for students of the course

Attributes

  • alternateLink (type: String.t, default: nil) - Absolute link to this announcement in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only.
  • assigneeMode (type: String.t, default: nil) - Assignee mode of the announcement. If unspecified, the default value is ALL_STUDENTS.
  • courseId (type: String.t, default: nil) - Identifier of the course. Read-only.
  • creationTime (type: DateTime.t, default: nil) - Timestamp when this announcement was created. Read-only.
  • creatorUserId (type: String.t, default: nil) - Identifier for the user that created the announcement. Read-only.
  • id (type: String.t, default: nil) - Classroom-assigned identifier of this announcement, unique per course. Read-only.
  • individualStudentsOptions (type: GoogleApi.Classroom.V1.Model.IndividualStudentsOptions.t, default: nil) - Identifiers of students with access to the announcement. This field is set only if assigneeMode is INDIVIDUAL_STUDENTS. If the assigneeMode is INDIVIDUAL_STUDENTS, then only students specified in this field can see the announcement.
  • materials (type: list(GoogleApi.Classroom.V1.Model.Material.t), default: nil) - Additional materials. Announcements must have no more than 20 material items.
  • scheduledTime (type: DateTime.t, default: nil) - Optional timestamp when this announcement is scheduled to be published.
  • state (type: String.t, default: nil) - Status of this announcement. If unspecified, the default state is DRAFT.
  • text (type: String.t, default: nil) - Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
  • updateTime (type: DateTime.t, default: nil) - Timestamp of the most recent change to this announcement. Read-only.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

Link to this type

t()

View Source 
@type t() :: %GoogleApi.Classroom.V1.Model.Announcement{
  alternateLink: String.t() | nil,
  assigneeMode: String.t() | nil,
  courseId: String.t() | nil,
  creationTime: DateTime.t() | nil,
  creatorUserId: String.t() | nil,
  id: String.t() | nil,
  individualStudentsOptions:
    GoogleApi.Classroom.V1.Model.IndividualStudentsOptions.t() | nil,
  materials: [GoogleApi.Classroom.V1.Model.Material.t()] | nil,
  scheduledTime: DateTime.t() | nil,
  state: String.t() | nil,
  text: String.t() | nil,
  updateTime: DateTime.t() | nil
}

Functions

Link to this function

decode(value, options)

View Source 
@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.