Documentation

Google_Service_Classroom_Resource_CoursesTopics extends Google_Service_Resource
in package

Application

The "topics" collection of methods.

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

$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_Topic: Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. (topics.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Classroom_ClassroomEmpty: Deletes a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. * `FAILED_PRECONDITION` if the requested topic has already been deleted. * `NOT_FOUND` if no course or topic exists with the requested ID. (topics.delete)
get() : Google_Service_Classroom_Topic: Returns a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist. (topics.get)
listCoursesTopics() : Google_Service_Classroom_ListTopicResponse: Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. (topics.listCoursesTopics)
patch() : Google_Service_Classroom_Topic: Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist (topics.patch)
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 —

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 a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. (topics.create)


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

Parameters

$courseId : string: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$postBody : Google_Service_Classroom_Topic
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Classroom_Topic —

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 a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. * `FAILED_PRECONDITION` if the requested topic has already been deleted. * `NOT_FOUND` if no course or topic exists with the requested ID. (topics.delete)


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

Parameters

$courseId : string: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$id : string: Identifier of the topic to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Classroom_ClassroomEmpty —

get()

Returns a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist. (topics.get)


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

Parameters

$courseId : string: Identifier of the course.
$id : string: Identifier of the topic.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Classroom_Topic —

listCoursesTopics()

Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. (topics.listCoursesTopics)


    public
                listCoursesTopics(string $courseId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Classroom_ListTopicResponse

Parameters

$courseId : string: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Classroom_ListTopicResponse —

patch()

Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist (topics.patch)


    public
                patch(string $courseId, string $id, Google_Service_Classroom_Topic $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Classroom_Topic

Parameters

$courseId : string: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$id : string: Identifier of the topic.
$postBody : Google_Service_Classroom_Topic
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Classroom_Topic —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —