Invitations
class Invitations extends Resource (View source)
The "invitations" collection of methods.
Typical usage is:
$classroomService = new Google\Service\Classroom(...);
$invitations = $classroomService->invitations;Methods
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)
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. if
the user already has this role or a role with greater permissions. for the
following request errors: IneligibleOwner ALREADY_EXISTS if an
invitation for the specified user and course already exists.
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)
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)
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)
Details
ClassroomEmpty
accept(string $id, array $optParams = [])
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)
Invitation
create(Invitation $postBody, array $optParams = [])
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. if
the user already has this role or a role with greater permissions. for the
following request errors: IneligibleOwner ALREADY_EXISTS if an
invitation for the specified user and course already exists.
(invitations.create)
ClassroomEmpty
delete(string $id, array $optParams = [])
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)
Invitation
get(string $id, array $optParams = [])
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)
ListInvitationsResponse
listInvitations(array $optParams = [])
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)