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

The "subscriptions" collection of methods. More...

Inheritance diagram for Google_Service_Mirror_Subscriptions_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($id, $optParams=array())
 Deletes a subscription.
 
 insert (Google_Service_Mirror_Subscription $postBody, $optParams=array())
 Creates a new subscription.
 
 listSubscriptions ($optParams=array())
 Retrieves a list of subscriptions for the authenticated user and service.
 
 update ($id, Google_Service_Mirror_Subscription $postBody, $optParams=array())
 Updates an existing subscription in place.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "subscriptions" collection of methods.

Typical usage is: $mirrorService = new Google_Service_Mirror(...); $subscriptions = $mirrorService->subscriptions;

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_Mirror_Subscriptions_Resource::delete ( $id,
$optParams = array() )

Deletes a subscription.

(subscriptions.delete)

Parameters
string$idThe ID of the subscription.
array$optParamsOptional parameters.

◆ insert()

Google_Service_Mirror_Subscriptions_Resource::insert ( Google_Service_Mirror_Subscription $postBody,
$optParams = array() )

Creates a new subscription.

(subscriptions.insert)

Parameters
Google_Subscription$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Mirror_Subscription

◆ listSubscriptions()

Google_Service_Mirror_Subscriptions_Resource::listSubscriptions ( $optParams = array())

Retrieves a list of subscriptions for the authenticated user and service.

(subscriptions.listSubscriptions)

Parameters
array$optParamsOptional parameters.
Return values
Google_Service_Mirror_SubscriptionsListResponse

◆ update()

Google_Service_Mirror_Subscriptions_Resource::update ( $id,
Google_Service_Mirror_Subscription $postBody,
$optParams = array() )

Updates an existing subscription in place.

(subscriptions.update)

Parameters
string$idThe ID of the subscription.
Google_Subscription$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Mirror_Subscription

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