Documentation

Google_Service_Classroom_Resource_Invitations extends Google_Service_Resource
in package

Application

The "invitations" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
accept() : Google_Service_Classroom_ClassroomEmpty: 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)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_Classroom_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. (invitations.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Classroom_ClassroomEmpty: 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)
get() : Google_Service_Classroom_Invitation: 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)
listInvitations() : Google_Service_Classroom_ListInvitationsResponse: 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)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

accept()

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)


    public
                accept(string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Classroom_ClassroomEmpty

Parameters

$id : string: Identifier of the invitation to accept.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Classroom_ClassroomEmpty —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

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)


    public
                create(Google_Service_Classroom_Invitation $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Classroom_Invitation

Parameters

$postBody : Google_Service_Classroom_Invitation
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Classroom_Invitation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

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)


    public
                delete(string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Classroom_ClassroomEmpty

Parameters

$id : string: Identifier of the invitation to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Classroom_ClassroomEmpty —

get()

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)


    public
                get(string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Classroom_Invitation

Parameters

$id : string: Identifier of the invitation to return.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Classroom_Invitation —

listInvitations()

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)


    public
                listInvitations([array<string|int, mixed> $optParams = array() ]) : Google_Service_Classroom_ListInvitationsResponse

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Classroom_ListInvitationsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —