Documentation

Google_Service_Classroom_Resource_Registrations extends Google_Service_Resource
in package

The "registrations" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Classroom_Registration
Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Classroom_ClassroomEmpty
Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`. (registrations.delete)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

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
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`.

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

Returns the created Registration. Currently, this will be the same as the argument, but with server-assigned fields such as expiry_time and id filled in. Note that any value specified for the expiry_time or id fields will be ignored. While Classroom may validate the cloudPubSubTopic and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * PERMISSION_DENIED if: * the authenticated user does not have permission to receive notifications from the requested field; or * the current user has not granted access to the current Cloud project with the appropriate scope for the requested feed. Note that domain-wide delegation of authority is not currently supported for this purpose. If the request has the appropriate scope, but no grant exists, a Request Errors is returned. * another access error is encountered. * INVALID_ARGUMENT if: * no cloudPubsubTopic is specified, or the specified cloudPubsubTopic is not valid; or * no feed is specified, or the specified feed is not valid. * NOT_FOUND if: * the specified feed cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified cloudPubsubTopic cannot be located, or Classroom has not been granted permission to publish to it. (registrations.create)

Parameters
$postBody : Google_Service_Classroom_Registration
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Classroom_Registration —

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>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`. (registrations.delete)

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

The registration_id of the Registration to be deleted.

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

Optional parameters.

Return values
Google_Service_Classroom_ClassroomEmpty —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results