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

The "transfers" collection of methods. More...

Inheritance diagram for Google_Service_DataTransfer_Transfers_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($dataTransferId, $optParams=array())
 Retrieves a data transfer request by its resource ID.
 
 insert (Google_Service_DataTransfer_DataTransfer $postBody, $optParams=array())
 Inserts a data transfer request.
 
 listTransfers ($optParams=array())
 Lists the transfers for a customer by source user, destination user, or status.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "transfers" collection of methods.

Typical usage is: $adminService = new Google_Service_DataTransfer(...); $transfers = $adminService->transfers;

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_DataTransfer_Transfers_Resource::get ( $dataTransferId,
$optParams = array() )

Retrieves a data transfer request by its resource ID.

(transfers.get)

Parameters
string$dataTransferIdID of the resource to be retrieved. This is returned in the response from the insert method.
array$optParamsOptional parameters.
Return values
Google_Service_DataTransfer_DataTransfer

◆ insert()

Google_Service_DataTransfer_Transfers_Resource::insert ( Google_Service_DataTransfer_DataTransfer $postBody,
$optParams = array() )

Inserts a data transfer request.

(transfers.insert)

Parameters
Google_DataTransfer$postBody
array$optParamsOptional parameters.
Return values
Google_Service_DataTransfer_DataTransfer

◆ listTransfers()

Google_Service_DataTransfer_Transfers_Resource::listTransfers ( $optParams = array())

Lists the transfers for a customer by source user, destination user, or status.

(transfers.listTransfers)

Parameters
array$optParamsOptional parameters.

@opt_param string status Status of the transfer. @opt_param int maxResults Maximum number of results to return. Default is 100. @opt_param string newOwnerUserId Destination user's profile ID. @opt_param string oldOwnerUserId Source user's profile ID. @opt_param string pageToken Token to specify the next page in the list. @opt_param string customerId Immutable ID of the Google Apps account.

Return values
Google_Service_DataTransfer_DataTransfersListResponse

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