Class CoursesResource.StudentGroupsResource

The "studentGroups" collection of methods.

Inheritance

object

CoursesResource.StudentGroupsResource

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.StudentGroupsResource

Constructors

StudentGroupsResource(IClientService)

Constructs a new resource.

Declaration

public StudentGroupsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

StudentGroupMembers

Gets the StudentGroupMembers resource.

Declaration

public virtual CoursesResource.StudentGroupsResource.StudentGroupMembersResource StudentGroupMembers { get; }

Property Value

Type	Description
CoursesResource.StudentGroupsResource.StudentGroupMembersResource

Methods

Create(StudentGroup, string)

Creates a student group for a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to create the student group or for access errors. * NOT_FOUND if the course does not exist or the requesting user doesn't have access to the course. * FAILED_PRECONDITION if creating the student group would exceed the maximum number of student groups per course.

Declaration

public virtual CoursesResource.StudentGroupsResource.CreateRequest Create(StudentGroup body, string courseId)

Parameters

Type	Name	Description
StudentGroup	body	The body of the request.
string	courseId	Required. The identifier of the course.

Returns

Type	Description
CoursesResource.StudentGroupsResource.CreateRequest

Delete(string, string)

Deletes a student group. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to delete the requested student group or for access errors. * NOT_FOUND if the student group does not exist or the user does not have access to the student group.

Declaration

public virtual CoursesResource.StudentGroupsResource.DeleteRequest Delete(string courseId, string id)

Parameters

Type	Name	Description
string	courseId	Required. The identifier of the course containing the student group to delete.
string	id	Required. The identifier of the student group to delete.

Returns

Type	Description
CoursesResource.StudentGroupsResource.DeleteRequest

List(string)

Returns a list of groups in a course. This method returns the following error codes: * NOT_FOUND if the course does not exist.

Declaration

public virtual CoursesResource.StudentGroupsResource.ListRequest List(string courseId)

Parameters

Type	Name	Description
string	courseId	Required. The identifier of the course.

Returns

Type	Description
CoursesResource.StudentGroupsResource.ListRequest

Patch(StudentGroup, string, string)

Updates one or more fields in a student group. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to modify the requested student group or for access errors. * NOT_FOUND if the student group does not exist or the user does not have access to the student group. * INVALID_ARGUMENT if invalid fields are specified in the update mask or if no update mask is supplied.

Declaration

public virtual CoursesResource.StudentGroupsResource.PatchRequest Patch(StudentGroup body, string courseId, string id)

Parameters

Type	Name	Description
StudentGroup	body	The body of the request.
string	courseId	Required. Identifier of the course.
string	id	Required. Identifier of the student group.

Returns

Type	Description
CoursesResource.StudentGroupsResource.PatchRequest