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

The "roles" collection of methods. More...

Inheritance diagram for Google_Service_Directory_Roles_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($customer, $roleId, $optParams=array())
 Deletes a role.
 
 get ($customer, $roleId, $optParams=array())
 Retrieves a role.
 
 insert ($customer, Google_Service_Directory_Role $postBody, $optParams=array())
 Creates a role.
 
 listRoles ($customer, $optParams=array())
 Retrieves a paginated list of all the roles in a domain.
 
 patch ($customer, $roleId, Google_Service_Directory_Role $postBody, $optParams=array())
 Updates a role.
 
 update ($customer, $roleId, Google_Service_Directory_Role $postBody, $optParams=array())
 Updates a role.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "roles" collection of methods.

Typical usage is: $adminService = new Google_Service_Directory(...); $roles = $adminService->roles;

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_Directory_Roles_Resource::delete ( $customer,
$roleId,
$optParams = array() )

Deletes a role.

(roles.delete)

Parameters
string$customerImmutable ID of the Google Apps account.
string$roleIdImmutable ID of the role.
array$optParamsOptional parameters.

◆ get()

Google_Service_Directory_Roles_Resource::get ( $customer,
$roleId,
$optParams = array() )

Retrieves a role.

(roles.get)

Parameters
string$customerImmutable ID of the Google Apps account.
string$roleIdImmutable ID of the role.
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Role

◆ insert()

Google_Service_Directory_Roles_Resource::insert ( $customer,
Google_Service_Directory_Role $postBody,
$optParams = array() )

Creates a role.

(roles.insert)

Parameters
string$customerImmutable ID of the Google Apps account.
Google_Role$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Role

◆ listRoles()

Google_Service_Directory_Roles_Resource::listRoles ( $customer,
$optParams = array() )

Retrieves a paginated list of all the roles in a domain.

(roles.listRoles)

Parameters
string$customerImmutable id of the Google Apps account.
array$optParamsOptional parameters.

@opt_param string pageToken Token to specify the next page in the list. @opt_param int maxResults Maximum number of results to return.

Return values
Google_Service_Directory_Roles

◆ patch()

Google_Service_Directory_Roles_Resource::patch ( $customer,
$roleId,
Google_Service_Directory_Role $postBody,
$optParams = array() )

Updates a role.

This method supports patch semantics. (roles.patch)

Parameters
string$customerImmutable ID of the Google Apps account.
string$roleIdImmutable ID of the role.
Google_Role$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Role

◆ update()

Google_Service_Directory_Roles_Resource::update ( $customer,
$roleId,
Google_Service_Directory_Role $postBody,
$optParams = array() )

Updates a role.

(roles.update)

Parameters
string$customerImmutable ID of the Google Apps account.
string$roleIdImmutable ID of the role.
Google_Role$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Role

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