Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_Dfareporting_ContentCategories_Resource Class Reference

The "contentCategories" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_ContentCategories_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($profileId, $id, $optParams=array())
 Deletes an existing content category.
 
 get ($profileId, $id, $optParams=array())
 Gets one content category by ID.
 
 insert ($profileId, Google_Service_Dfareporting_ContentCategory $postBody, $optParams=array())
 Inserts a new content category.
 
 listContentCategories ($profileId, $optParams=array())
 Retrieves a list of content categories, possibly filtered.
 
 patch ($profileId, $id, Google_Service_Dfareporting_ContentCategory $postBody, $optParams=array())
 Updates an existing content category.
 
 update ($profileId, Google_Service_Dfareporting_ContentCategory $postBody, $optParams=array())
 Updates an existing content category.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "contentCategories" collection of methods.

Typical usage is: $dfareportingService = new Google_Service_Dfareporting(...); $contentCategories = $dfareportingService->contentCategories;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ delete()

Google_Service_Dfareporting_ContentCategories_Resource::delete ( $profileId,
$id,
$optParams = array() )

Deletes an existing content category.

(contentCategories.delete)

Parameters
string$profileIdUser profile ID associated with this request.
string$idContent category ID.
array$optParamsOptional parameters.

◆ get()

Google_Service_Dfareporting_ContentCategories_Resource::get ( $profileId,
$id,
$optParams = array() )

Gets one content category by ID.

(contentCategories.get)

Parameters
string$profileIdUser profile ID associated with this request.
string$idContent category ID.
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_ContentCategory

◆ insert()

Google_Service_Dfareporting_ContentCategories_Resource::insert ( $profileId,
Google_Service_Dfareporting_ContentCategory $postBody,
$optParams = array() )

Inserts a new content category.

(contentCategories.insert)

Parameters
string$profileIdUser profile ID associated with this request.
Google_ContentCategory$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_ContentCategory

◆ listContentCategories()

Google_Service_Dfareporting_ContentCategories_Resource::listContentCategories ( $profileId,
$optParams = array() )

Retrieves a list of content categories, possibly filtered.

(contentCategories.listContentCategories)

Parameters
string$profileIdUser profile ID associated with this request.
array$optParamsOptional parameters.

@opt_param string searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". @opt_param string sortField Field by which to sort the list. @opt_param string ids Select only content categories with these IDs. @opt_param int maxResults Maximum number of results to return. @opt_param string pageToken Value of the nextPageToken from the previous result page. @opt_param string sortOrder Order of sorted results, default is ASCENDING.

Return values
Google_Service_Dfareporting_ContentCategoriesListResponse

◆ patch()

Google_Service_Dfareporting_ContentCategories_Resource::patch ( $profileId,
$id,
Google_Service_Dfareporting_ContentCategory $postBody,
$optParams = array() )

Updates an existing content category.

This method supports patch semantics. (contentCategories.patch)

Parameters
string$profileIdUser profile ID associated with this request.
string$idContent category ID.
Google_ContentCategory$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_ContentCategory

◆ update()

Google_Service_Dfareporting_ContentCategories_Resource::update ( $profileId,
Google_Service_Dfareporting_ContentCategory $postBody,
$optParams = array() )

Updates an existing content category.

(contentCategories.update)

Parameters
string$profileIdUser profile ID associated with this request.
Google_ContentCategory$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_ContentCategory

The documentation for this class was generated from the following file: