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

The "directorySiteContacts" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_DirectorySiteContacts_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($profileId, $id, $optParams=array())
 Gets one directory site contact by ID.
 
 listDirectorySiteContacts ($profileId, $optParams=array())
 Retrieves a list of directory site contacts, possibly filtered.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "directorySiteContacts" collection of methods.

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

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

Gets one directory site contact by ID.

(directorySiteContacts.get)

Parameters
string$profileIdUser profile ID associated with this request.
string$idDirectory site contact ID.
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_DirectorySiteContact

◆ listDirectorySiteContacts()

Google_Service_Dfareporting_DirectorySiteContacts_Resource::listDirectorySiteContacts ( $profileId,
$optParams = array() )

Retrieves a list of directory site contacts, possibly filtered.

(directorySiteContacts.listDirectorySiteContacts)

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

@opt_param string searchString Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 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 "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact". @opt_param string directorySiteIds Select only directory site contacts with these directory site IDs. This is a required field. @opt_param string sortField Field by which to sort the list. @opt_param string ids Select only directory site contacts 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_DirectorySiteContactsListResponse

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