com.google.api.services.classroom

Class Classroom.Courses.Announcements

java.lang.Object

com.google.api.services.classroom.Classroom.Courses.Announcements

Enclosing class:

Classroom.Courses

public class Classroom.Courses.Announcements
extends Object

The "announcements" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Classroom.Courses.Announcements.Create
class	Classroom.Courses.Announcements.Delete
class	Classroom.Courses.Announcements.Get
class	Classroom.Courses.Announcements.List
class	Classroom.Courses.Announcements.ModifyAssignees
class	Classroom.Courses.Announcements.Patch

Constructor Summary

Constructors

Constructor and Description
Announcements()

Method Summary

Modifier and Type	Method and Description
Classroom.Courses.Announcements.Create	create(String courseId, Announcement content) Creates an announcement.
Classroom.Courses.Announcements.Delete	delete(String courseId, String id) Deletes an announcement.
Classroom.Courses.Announcements.Get	get(String courseId, String id) Returns an announcement.
Classroom.Courses.Announcements.List	list(String courseId) Returns a list of announcements that the requester is permitted to view.
Classroom.Courses.Announcements.ModifyAssignees	modifyAssignees(String courseId, String id, ModifyAnnouncementAssigneesRequest content) Modifies assignee mode and options of an announcement.
Classroom.Courses.Announcements.Patch	patch(String courseId, String id, Announcement content) Updates one or more fields of an announcement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Announcements

public Announcements()

Method Detail

create

public Classroom.Courses.Announcements.Create create(String courseId,
                                                     Announcement content)
                                              throws IOException

Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible Create a request for the method "announcements.create". This request holds the parameters needed by the classroom server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

courseId - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

content - the Announcement

Returns:

the request

Throws:

IOException

delete

public Classroom.Courses.Announcements.Delete delete(String courseId,
                                                     String id)
                                              throws IOException

Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID. Create a request for the method "announcements.delete". This request holds the parameters needed by the classroom server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

courseId - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

id - Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.

Returns:

the request

Throws:

IOException

get

public Classroom.Courses.Announcements.Get get(String courseId,
                                               String id)
                                        throws IOException

Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist. Create a request for the method "announcements.get". This request holds the parameters needed by the classroom server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

courseId - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

id - Identifier of the announcement.

Returns:

the request

Throws:

IOException

list

public Classroom.Courses.Announcements.List list(String courseId)
                                          throws IOException

Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. Create a request for the method "announcements.list". This request holds the parameters needed by the classroom server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

courseId - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Returns:

the request

Throws:

IOException

modifyAssignees

public Classroom.Courses.Announcements.ModifyAssignees modifyAssignees(String courseId,
                                                                       String id,
                                                                       ModifyAnnouncementAssigneesRequest content)
                                                                throws IOException

Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. Create a request for the method "announcements.modifyAssignees". This request holds the parameters needed by the classroom server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

courseId - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

id - Identifier of the announcement.

content - the ModifyAnnouncementAssigneesRequest

Returns:

the request

Throws:

IOException

patch

public Classroom.Courses.Announcements.Patch patch(String courseId,
                                                   String id,
                                                   Announcement content)
                                            throws IOException

Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist Create a request for the method "announcements.patch". This request holds the parameters needed by the classroom server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

courseId - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

id - Identifier of the announcement.

content - the Announcement

Returns:

the request

Throws:

IOException