com.google.api.services.classroom

Class Classroom.Courses.Aliases

java.lang.Object

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

Enclosing class:

Classroom.Courses

public class Classroom.Courses.Aliases
extends Object

The "aliases" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Classroom.Courses.Aliases.Create
class	Classroom.Courses.Aliases.Delete
class	Classroom.Courses.Aliases.List

Constructor Summary

Constructors

Constructor and Description
Aliases()

Method Summary

Modifier and Type	Method and Description
Classroom.Courses.Aliases.Create	create(String courseId, CourseAlias content) Creates an alias for a course.
Classroom.Courses.Aliases.Delete	delete(String courseId, String alias) Deletes an alias of a course.
Classroom.Courses.Aliases.List	list(String courseId) Returns a list of aliases for a course.

Methods inherited from class java.lang.Object

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

Constructor Detail

Aliases

public Aliases()

Method Detail

create

public Classroom.Courses.Aliases.Create create(String courseId,
                                               CourseAlias content)
                                        throws IOException

Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias). Create a request for the method "aliases.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 to alias. This identifier can be either the Classroom-assigned identifier or an alias.

content - the CourseAlias

Returns:

the request

Throws:

IOException

delete

public Classroom.Courses.Aliases.Delete delete(String courseId,
                                               String alias)
                                        throws IOException

Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias). Create a request for the method "aliases.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 whose alias should be deleted. This identifier can be either the Classroom- assigned identifier or an alias.

alias - Alias to delete. This may not be the Classroom-assigned identifier.

Returns:

the request

Throws:

IOException

list

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

Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist. Create a request for the method "aliases.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 - The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Returns:

the request

Throws:

IOException