Class InvitationsResource

The "invitations" collection of methods.

Inheritance

System.Object

InvitationsResource

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.Classroom.v1

Assembly: Google.Apis.Classroom.v1.dll

Syntax

public class InvitationsResource

Constructors

InvitationsResource(IClientService)

Constructs a new resource.

Declaration

public InvitationsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Accept(String)

Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation.

This method returns the following error codes:

• PERMISSION_DENIED if the requesting user is not permitted to accept the requested invitation or for access errors. * FAILED_PRECONDITION for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * NOT_FOUND if no invitation exists with the requested ID.

Declaration

public virtual InvitationsResource.AcceptRequest Accept(string id)

Parameters

Type	Name	Description
System.String	id	Identifier of the invitation to accept.

Returns

Type	Description
InvitationsResource.AcceptRequest

Create(Invitation)

Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes.

This method returns the following error codes:

• PERMISSION_DENIED if the requesting user is not permitted to create invitations for this course or for access errors. * NOT_FOUND if the course or the user does not exist. * FAILED_PRECONDITION if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * ALREADY_EXISTS if an invitation for the specified user and course already exists.

Declaration

public virtual InvitationsResource.CreateRequest Create(Invitation body)

Parameters

Type	Name	Description
Invitation	body	The body of the request.

Returns

Type	Description
InvitationsResource.CreateRequest

Delete(String)

Deletes an invitation.

This method returns the following error codes:

• PERMISSION_DENIED if the requesting user is not permitted to delete the requested invitation or for access errors. * NOT_FOUND if no invitation exists with the requested ID.

Declaration

public virtual InvitationsResource.DeleteRequest Delete(string id)

Parameters

Type	Name	Description
System.String	id	Identifier of the invitation to delete.

Returns

Type	Description
InvitationsResource.DeleteRequest

Get(String)

Returns an invitation.

This method returns the following error codes:

• PERMISSION_DENIED if the requesting user is not permitted to view the requested invitation or for access errors. * NOT_FOUND if no invitation exists with the requested ID.

Declaration

public virtual InvitationsResource.GetRequest Get(string id)

Parameters

Type	Name	Description
System.String	id	Identifier of the invitation to return.

Returns

Type	Description
InvitationsResource.GetRequest

List()

Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request.

Note: At least one of user_id or course_id must be supplied. Both fields can be supplied.

This method returns the following error codes:

• PERMISSION_DENIED for access errors.

Declaration

public virtual InvitationsResource.ListRequest List()

Returns

Type	Description
InvitationsResource.ListRequest