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

The "inventoryItems" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_InventoryItems_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($profileId, $projectId, $id, $optParams=array())
 Gets one inventory item by ID.
 
 listInventoryItems ($profileId, $projectId, $optParams=array())
 Retrieves a list of inventory items, possibly filtered.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "inventoryItems" collection of methods.

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

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_Dfareporting_InventoryItems_Resource::get ( $profileId,
$projectId,
$id,
$optParams = array() )

Gets one inventory item by ID.

(inventoryItems.get)

Parameters
string$profileIdUser profile ID associated with this request.
string$projectIdProject ID for order documents.
string$idInventory item ID.
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_InventoryItem

◆ listInventoryItems()

Google_Service_Dfareporting_InventoryItems_Resource::listInventoryItems ( $profileId,
$projectId,
$optParams = array() )

Retrieves a list of inventory items, possibly filtered.

(inventoryItems.listInventoryItems)

Parameters
string$profileIdUser profile ID associated with this request.
string$projectIdProject ID for order documents.
array$optParamsOptional parameters.

@opt_param string orderId Select only inventory items that belong to specified orders. @opt_param string ids Select only inventory items 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 siteId Select only inventory items that are associated with these sites. @opt_param bool inPlan Select only inventory items that are in plan. @opt_param string sortField Field by which to sort the list. @opt_param string sortOrder Order of sorted results, default is ASCENDING.

Return values
Google_Service_Dfareporting_InventoryItemsListResponse

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