The "guardianInvitations" collection of methods. Typical usage is:
$classroomService = new Google_Service_Classroom(...);
$guardianInvitations = $classroomService->guardianInvitations;
Methods summary
public
Google_Service_Classroom_GuardianInvitation
|
#
create( string $studentId, Google_Service_Classroom_GuardianInvitation $postBody, array $optParams = array() )
Creates a guardian invitation, and sends an email to the guardian asking them
to confirm that they are the student's guardian.
Creates a guardian invitation, and sends an email to the guardian asking them
to confirm that they are the student's guardian.
Once the guardian accepts the invitation, their state will
change to COMPLETED and they will start receiving guardian
notifications. A Guardian resource will also be created to
represent the active guardian.
The request object must have the student_id and
invited_email_address fields set. Failing to set these fields, or
setting any other fields in the request, will result in an error.
This method returns the following error codes:
PERMISSION_DENIED if the current user does not have permission
to
manage guardians, if the guardian in question has already rejected too many
requests for that student, if guardians are not enabled for the domain in
question, or for other access errors. * RESOURCE_EXHAUSTED if the
student or guardian has exceeded the guardian link limit. *
INVALID_ARGUMENT if the guardian email address is not valid (for
example, if it is too long), or if the format of the student ID provided cannot
be recognized (it is not an email address, nor a user_id from this
API). This error will also be returned if read-only fields are set, or if the
state field is set to to a value other than PENDING. *
NOT_FOUND if the student ID provided is a valid student ID, but
Classroom has no record of that student. * ALREADY_EXISTS if there
is already a pending guardian invitation for the student and
invited_email_address provided, or if the provided
invited_email_address matches the Google account of an existing
Guardian for this user. (guardianInvitations.create)
Parameters
- $studentId
- ID of the student (in standard format)
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_GuardianInvitation
|
#
get( string $studentId, string $invitationId, array $optParams = array() )
Returns a specific guardian invitation.
Returns a specific guardian invitation.
This method returns the following error codes:
PERMISSION_DENIED if the requesting user is not permitted to
view
guardian invitations for the student identified by the
student_id, if guardians are not enabled for the domain in
question, or for other access errors. * INVALID_ARGUMENT if a
student_id is specified, but its format cannot be recognized (it is
not an email address, nor a student_id from the API, nor the
literal string me). * NOT_FOUND if Classroom cannot
find any record of the given student or invitation_id. May also be
returned if the student exists, but the requesting user does not have access to
see that student. (guardianInvitations.get)
Parameters
- $studentId
- The ID of the student whose guardian invitation is being requested.
- $invitationId
- The <code>id</code> field of the <code>GuardianInvitation</code> being
requested.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_ListGuardianInvitationsResponse
|
#
listUserProfilesGuardianInvitations( string $studentId, array $optParams = array() )
Returns a list of guardian invitations that the requesting user is permitted
to view, filtered by the parameters provided.
Returns a list of guardian invitations that the requesting user is permitted
to view, filtered by the parameters provided.
This method returns the following error codes:
PERMISSION_DENIED if a student_id is specified,
and the requesting
user is not permitted to view guardian invitations for that student, if
"-" is specified as the student_id and the user is not
a domain administrator, if guardians are not enabled for the domain in question,
or for other access errors. * INVALID_ARGUMENT if a
student_id is specified, but its format cannot be recognized (it is
not an email address, nor a student_id from the API, nor the
literal string me). May also be returned if an invalid
page_token or state is provided. *
NOT_FOUND if a student_id is specified, and its format
can be recognized, but Classroom has no record of that student.
(guardianInvitations.listUserProfilesGuardianInvitations)
Parameters
- $studentId
- The ID of the student whose guardian invitations are to be returned. The
identifier can be one of the following: * the numeric identifier for the user *
the email address of the user * the string literal <code>"me"</code>, indicating
the requesting user * the string literal <code>"-"</code>, indicating that
results should be returned for all students that the requesting user is
permitted to view guardian invitations.
- $optParams
- Optional parameters.
Returns
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.
string invitedEmailAddress If specified, only results with the specified
invited_email_address are returned.
string states If specified, only results with the specified state
values are returned. Otherwise, results with a state of
PENDING are returned.
int pageSize Maximum number of items to return. Zero or unspecified indicates
that the server may assign a maximum. The server may return fewer than the
specified number of results.
|
public
Google_Service_Classroom_GuardianInvitation
|
#
patch( string $studentId, string $invitationId, Google_Service_Classroom_GuardianInvitation $postBody, array $optParams = array() )
Modifies a guardian invitation.
Modifies a guardian invitation.
Currently, the only valid modification is to change the state
from PENDING to COMPLETE. This has the effect of
withdrawing the invitation.
This method returns the following error codes:
PERMISSION_DENIED if the current user does not have permission
to
manage guardians, if guardians are not enabled for the domain in question or
for other access errors. * FAILED_PRECONDITION if the guardian link
is not in the PENDING state. * INVALID_ARGUMENT if the
format of the student ID provided cannot be recognized (it is not an email
address, nor a user_id from this API), or if the passed
GuardianInvitation has a state other than
COMPLETE, or if it modifies fields other than
state.
NOT_FOUND if the student ID provided is a valid student ID,
but
Classroom has no record of that student, or if the id field does
not refer to a guardian invitation known to Classroom.
(guardianInvitations.patch)
Parameters
- $studentId
- The ID of the student whose guardian invitation is to be modified.
- $invitationId
- The <code>id</code> field of the <code>GuardianInvitation</code> to be modified.
- $postBody
- $optParams
- Optional parameters.
Returns
Opt_param
string updateMask Mask that identifies which fields on the course to update.
This field is required to do an update. The update fails if invalid fields are
specified. The following fields are valid: * state When set in a
query parameter, this field should be specified as updateMask=,,...
|
Google_Service_Classroom_UserProfilesGuardianInvitations_Resource