Show / Hide Table of Contents

Class CoursesResource.TeachersResource

The "teachers" collection of methods.

Inheritance
object
CoursesResource.TeachersResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Classroom.v1
Assembly: Google.Apis.Classroom.v1.dll
Syntax
public class CoursesResource.TeachersResource

Constructors

TeachersResource(IClientService)

Constructs a new resource.

Declaration
public TeachersResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Create(Teacher, string)

Creates a teacher of a course. Domain administrators are permitted to directly add users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to create teachers in this course or for access errors. * NOT_FOUND if the requested course ID does not exist. * FAILED_PRECONDITION if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * InactiveCourseOwner * ALREADY_EXISTS if the user is already a teacher or student in the course.

Declaration
public virtual CoursesResource.TeachersResource.CreateRequest Create(Teacher body, string courseId)
Parameters
Type Name Description
Teacher body

The body of the request.

string courseId

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

Returns
Type Description
CoursesResource.TeachersResource.CreateRequest

Delete(string, string)

Removes the specified teacher from the specified course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to delete teachers of this course or for access errors. * NOT_FOUND if no teacher of this course has the requested ID or if the course does not exist. * FAILED_PRECONDITION if the requested ID belongs to the primary teacher of this course. * FAILED_PRECONDITION if the requested ID belongs to the owner of the course Drive folder. * FAILED_PRECONDITION if the course no longer has an active owner.
Declaration
public virtual CoursesResource.TeachersResource.DeleteRequest Delete(string courseId, string userId)
Parameters
Type Name Description
string courseId

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

string userId

Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

Returns
Type Description
CoursesResource.TeachersResource.DeleteRequest

Get(string, string)

Returns a teacher of a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to view teachers of this course or for access errors. * NOT_FOUND if no teacher of this course has the requested ID or if the course does not exist.

Declaration
public virtual CoursesResource.TeachersResource.GetRequest Get(string courseId, string userId)
Parameters
Type Name Description
string courseId

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

string userId

Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

Returns
Type Description
CoursesResource.TeachersResource.GetRequest

List(string)

Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * NOT_FOUND if the course does not exist. * PERMISSION_DENIED for access errors.

Declaration
public virtual CoursesResource.TeachersResource.ListRequest List(string courseId)
Parameters
Type Name Description
string courseId

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

Returns
Type Description
CoursesResource.TeachersResource.ListRequest
In this article
Back to top Generated by DocFX