Google_Service_Classroom_Invitations_Resource Class Reference

The "invitations" collection of methods. More...

Inheritance diagram for Google_Service_Classroom_Invitations_Resource:

Public Member Functions
	accept ($id, $optParams=array())
	Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course.
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	create (Google_Service_Classroom_Invitation $postBody, $optParams=array())
	Creates an invitation.
	delete ($id, $optParams=array())
	Deletes an invitation.
	get ($id, $optParams=array())
	Returns an invitation.
	listInvitations ($optParams=array())
	Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "invitations" collection of methods.

Typical usage is: $classroomService = new Google_Service_Classroom(...); $invitations = $classroomService->invitations;

Member Function Documentation

accept()

Google_Service_Classroom_Invitations_Resource::accept	(		$id,
			$optParams = array() )

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. (invitations.accept)

Parameters

string	$id	Identifier of the invitation to accept.
array	$optParams	Optional parameters.

Return values

Google_Service_Classroom_Empty

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

create()

Google_Service_Classroom_Invitations_Resource::create	(	Google_Service_Classroom_Invitation	$postBody,
			$optParams = array() )

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. (invitations.create)

Parameters

Google_Invitation	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Classroom_Invitation

delete()

Google_Service_Classroom_Invitations_Resource::delete	(		$id,
			$optParams = array() )

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. (invitations.delete)

Parameters

string	$id	Identifier of the invitation to delete.
array	$optParams	Optional parameters.

Return values

Google_Service_Classroom_Empty

get()

Google_Service_Classroom_Invitations_Resource::get	(		$id,
			$optParams = array() )

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. (invitations.get)

Parameters

string	$id	Identifier of the invitation to return.
array	$optParams	Optional parameters.

Return values

Google_Service_Classroom_Invitation

listInvitations()

Google_Service_Classroom_Invitations_Resource::listInvitations

(

$optParams = array()

)

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. (invitations.listInvitations)

Parameters

array

$optParams

Optional parameters.

@opt_param string courseId Restricts returned invitations to those for a course with the specified identifier. @opt_param string pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. @opt_param string userId Restricts returned invitations to those for a specific user. 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 @opt_param int pageSize Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.

Return values

Google_Service_Classroom_ListInvitationsResponse

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Classroom.php