Class Google_Service_Classroom_Invitations_Resource
The "invitations" collection of methods. Typical usage is:
$classroomService = new Google_Service_Classroom(...);
$invitations = $classroomService->invitations;
-
Google_Service_Resource
-
Google_Service_Classroom_Invitations_Resource
Located at Classroom.php
Methods summary
public
Google_Service_Classroom_ClassroomEmpty
|
#
accept( string $id, array $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.
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
- $id
- Identifier of the invitation to accept.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_Invitation
|
#
create( Google_Service_Classroom_Invitation $postBody, array $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.
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
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_ClassroomEmpty
|
#
delete( string $id, array $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
- $id
- Identifier of the invitation to delete.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_Invitation
|
#
get( string $id, array $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
- $id
- Identifier of the invitation to return.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_ListInvitationsResponse
|
#
listInvitations( array $optParams = array() )
Returns a list of invitations that the requesting user is permitted to view,
restricted to those that match the list request.
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
- $optParams
- Optional parameters.
Returns
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
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.
int pageSize Maximum number of items to return. Zero means no maximum. The
server may return fewer than the specified number of results.
string courseId Restricts returned invitations to those for a course with the
specified identifier.
|