Announcement (Google Classroom API v1 (Rev. 386) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.classroom.model.Announcement

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Announcement
extends com.google.api.client.json.GenericJson
```
Announcement created by a teacher for students of the course
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Classroom API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Announcement()

Constructors
Constructor and Description
`Announcement()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Announcement`	`clone()`
`java.lang.String`	`getAlternateLink()` Absolute link to this announcement in the Classroom web UI.
`java.lang.String`	`getAssigneeMode()` Assignee mode of the announcement.
`java.lang.String`	`getCourseId()` Identifier of the course.
`java.lang.String`	`getCreationTime()` Timestamp when this announcement was created.
`java.lang.String`	`getCreatorUserId()` Identifier for the user that created the announcement.
`java.lang.String`	`getId()` Classroom-assigned identifier of this announcement, unique per course.
`IndividualStudentsOptions`	`getIndividualStudentsOptions()` Identifiers of students with access to the announcement.
`java.util.List<Material>`	`getMaterials()` Additional materials.
`java.lang.String`	`getScheduledTime()` Optional timestamp when this announcement is scheduled to be published.
`java.lang.String`	`getState()` Status of this announcement.
`java.lang.String`	`getText()` Description of this announcement.
`java.lang.String`	`getUpdateTime()` Timestamp of the most recent change to this announcement.
`Announcement`	`set(java.lang.String fieldName, java.lang.Object value)`
`Announcement`	`setAlternateLink(java.lang.String alternateLink)` Absolute link to this announcement in the Classroom web UI.
`Announcement`	`setAssigneeMode(java.lang.String assigneeMode)` Assignee mode of the announcement.
`Announcement`	`setCourseId(java.lang.String courseId)` Identifier of the course.
`Announcement`	`setCreationTime(java.lang.String creationTime)` Timestamp when this announcement was created.
`Announcement`	`setCreatorUserId(java.lang.String creatorUserId)` Identifier for the user that created the announcement.
`Announcement`	`setId(java.lang.String id)` Classroom-assigned identifier of this announcement, unique per course.
`Announcement`	`setIndividualStudentsOptions(IndividualStudentsOptions individualStudentsOptions)` Identifiers of students with access to the announcement.
`Announcement`	`setMaterials(java.util.List<Material> materials)` Additional materials.
`Announcement`	`setScheduledTime(java.lang.String scheduledTime)` Optional timestamp when this announcement is scheduled to be published.
`Announcement`	`setState(java.lang.String state)` Status of this announcement.
`Announcement`	`setText(java.lang.String text)` Description of this announcement.
`Announcement`	`setUpdateTime(java.lang.String updateTime)` Timestamp of the most recent change to this announcement.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Announcement
```
public Announcement()
```
- Method Detail
  - getAlternateLink
```
public java.lang.String getAlternateLink()
```
    Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
    
    Returns:
    
    value or null for none
  - setAlternateLink
```
public Announcement setAlternateLink(java.lang.String alternateLink)
```
    Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
    
    Parameters:
    
    alternateLink - alternateLink or null for none
  - getAssigneeMode
```
public java.lang.String getAssigneeMode()
```
    Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
    
    Returns:
    
    value or null for none
  - setAssigneeMode
```
public Announcement setAssigneeMode(java.lang.String assigneeMode)
```
    Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
    
    Parameters:
    
    assigneeMode - assigneeMode or null for none
  - getCourseId
```
public java.lang.String getCourseId()
```
    Identifier of the course. Read-only.
    
    Returns:
    
    value or null for none
  - setCourseId
```
public Announcement setCourseId(java.lang.String courseId)
```
    Identifier of the course. Read-only.
    
    Parameters:
    
    courseId - courseId or null for none
  - getCreationTime
```
public java.lang.String getCreationTime()
```
    Timestamp when this announcement was created. Read-only.
    
    Returns:
    
    value or null for none
  - setCreationTime
```
public Announcement setCreationTime(java.lang.String creationTime)
```
    Timestamp when this announcement was created. Read-only.
    
    Parameters:
    
    creationTime - creationTime or null for none
  - getCreatorUserId
```
public java.lang.String getCreatorUserId()
```
    Identifier for the user that created the announcement. Read-only.
    
    Returns:
    
    value or null for none
  - setCreatorUserId
```
public Announcement setCreatorUserId(java.lang.String creatorUserId)
```
    Identifier for the user that created the announcement. Read-only.
    
    Parameters:
    
    creatorUserId - creatorUserId or null for none
  - getId
```
public java.lang.String getId()
```
    Classroom-assigned identifier of this announcement, unique per course. Read-only.
    
    Returns:
    
    value or null for none
  - setId
```
public Announcement setId(java.lang.String id)
```
    Classroom-assigned identifier of this announcement, unique per course. Read-only.
    
    Parameters:
    
    id - id or null for none
  - getIndividualStudentsOptions
```
public IndividualStudentsOptions getIndividualStudentsOptions()
```
    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 will be able to see the announcement.
    
    Returns:
    
    value or null for none
  - setIndividualStudentsOptions
```
public Announcement setIndividualStudentsOptions(IndividualStudentsOptions individualStudentsOptions)
```
    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 will be able to see the announcement.
    
    Parameters:
    
    individualStudentsOptions - individualStudentsOptions or null for none
  - getMaterials
```
public java.util.List<Material> getMaterials()
```
    Additional materials. Announcements must have no more than 20 material items.
    
    Returns:
    
    value or null for none
  - setMaterials
```
public Announcement setMaterials(java.util.List<Material> materials)
```
    Additional materials. Announcements must have no more than 20 material items.
    
    Parameters:
    
    materials - materials or null for none
  - getScheduledTime
```
public java.lang.String getScheduledTime()
```
    Optional timestamp when this announcement is scheduled to be published.
    
    Returns:
    
    value or null for none
  - setScheduledTime
```
public Announcement setScheduledTime(java.lang.String scheduledTime)
```
    Optional timestamp when this announcement is scheduled to be published.
    
    Parameters:
    
    scheduledTime - scheduledTime or null for none
  - getState
```
public java.lang.String getState()
```
    Status of this announcement. If unspecified, the default state is `DRAFT`.
    
    Returns:
    
    value or null for none
  - setState
```
public Announcement setState(java.lang.String state)
```
    Status of this announcement. If unspecified, the default state is `DRAFT`.
    
    Parameters:
    
    state - state or null for none
  - getText
```
public java.lang.String getText()
```
    Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
    
    Returns:
    
    value or null for none
  - setText
```
public Announcement setText(java.lang.String text)
```
    Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
    
    Parameters:
    
    text - text or null for none
  - getUpdateTime
```
public java.lang.String getUpdateTime()
```
    Timestamp of the most recent change to this announcement. Read-only.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public Announcement setUpdateTime(java.lang.String updateTime)
```
    Timestamp of the most recent change to this announcement. Read-only.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public Announcement set(java.lang.String fieldName,
                        java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Announcement clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Google Classroom API v1 (revision 386)

Class Announcement

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Announcement

Method Detail

getAlternateLink

setAlternateLink

getAssigneeMode

setAssigneeMode

getCourseId

setCourseId

getCreationTime

setCreationTime

getCreatorUserId

setCreatorUserId

getId

setId

getIndividualStudentsOptions

setIndividualStudentsOptions

getMaterials

setMaterials

getScheduledTime

setScheduledTime

getState

setState

getText

setText

getUpdateTime

setUpdateTime

set

clone