Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Calendar_Settings_Resource Class Reference

The "settings" collection of methods. More...

Inheritance diagram for Google_Service_Calendar_Settings_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($setting, $optParams=array())
 Returns a single user setting.
 
 listSettings ($optParams=array())
 Returns all user settings for the authenticated user.
 
 watch (Google_Service_Calendar_Channel $postBody, $optParams=array())
 Watch for changes to Settings resources.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "settings" collection of methods.

Typical usage is: $calendarService = new Google_Service_Calendar(...); $settings = $calendarService->settings;

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

◆ get()

Google_Service_Calendar_Settings_Resource::get ( $setting,
$optParams = array() )

Returns a single user setting.

(settings.get)

Parameters
string$settingThe id of the user setting.
array$optParamsOptional parameters.
Return values
Google_Service_Calendar_Setting

◆ listSettings()

Google_Service_Calendar_Settings_Resource::listSettings ( $optParams = array())

Returns all user settings for the authenticated user.

(settings.listSettings)

Parameters
array$optParamsOptional parameters.

@opt_param string pageToken Token specifying which result page to return. Optional. @opt_param int maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. @opt_param string syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

Return values
Google_Service_Calendar_Settings

◆ watch()

Google_Service_Calendar_Settings_Resource::watch ( Google_Service_Calendar_Channel $postBody,
$optParams = array() )

Watch for changes to Settings resources.

(settings.watch)

Parameters
Google_Channel$postBody
array$optParamsOptional parameters.

@opt_param string pageToken Token specifying which result page to return. Optional. @opt_param int maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. @opt_param string syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

Return values
Google_Service_Calendar_Channel

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