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

The "roleAssignments" collection of methods. More...

Inheritance diagram for Google_Service_Directory_RoleAssignments_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($customer, $roleAssignmentId, $optParams=array())
 Deletes a role assignment.
 
 get ($customer, $roleAssignmentId, $optParams=array())
 Retrieve a role assignment.
 
 insert ($customer, Google_Service_Directory_RoleAssignment $postBody, $optParams=array())
 Creates a role assignment.
 
 listRoleAssignments ($customer, $optParams=array())
 Retrieves a paginated list of all roleAssignments.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "roleAssignments" collection of methods.

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

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

Deletes a role assignment.

(roleAssignments.delete)

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

◆ get()

Google_Service_Directory_RoleAssignments_Resource::get ( $customer,
$roleAssignmentId,
$optParams = array() )

Retrieve a role assignment.

(roleAssignments.get)

Parameters
string$customerImmutable ID of the Google Apps account.
string$roleAssignmentIdImmutable ID of the role assignment.
array$optParamsOptional parameters.
Return values
Google_Service_Directory_RoleAssignment

◆ insert()

Google_Service_Directory_RoleAssignments_Resource::insert ( $customer,
Google_Service_Directory_RoleAssignment $postBody,
$optParams = array() )

Creates a role assignment.

(roleAssignments.insert)

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

◆ listRoleAssignments()

Google_Service_Directory_RoleAssignments_Resource::listRoleAssignments ( $customer,
$optParams = array() )

Retrieves a paginated list of all roleAssignments.

(roleAssignments.listRoleAssignments)

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 string userKey The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user. @opt_param int maxResults Maximum number of results to return. @opt_param string roleId Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.

Return values
Google_Service_Directory_RoleAssignments

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