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

The "collectionviewers" collection of methods. More...

Inheritance diagram for Google_Service_AndroidEnterprise_Collectionviewers_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($enterpriseId, $collectionId, $userId, $optParams=array())
 Removes the user from the list of those specifically allowed to see the collection.
 
 get ($enterpriseId, $collectionId, $userId, $optParams=array())
 Retrieves the ID of the user if they have been specifically allowed to see the collection.
 
 listCollectionviewers ($enterpriseId, $collectionId, $optParams=array())
 Retrieves the IDs of the users who have been specifically allowed to see the collection.
 
 patch ($enterpriseId, $collectionId, $userId, Google_Service_AndroidEnterprise_User $postBody, $optParams=array())
 Adds the user to the list of those specifically allowed to see the collection.
 
 update ($enterpriseId, $collectionId, $userId, Google_Service_AndroidEnterprise_User $postBody, $optParams=array())
 Adds the user to the list of those specifically allowed to see the collection.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "collectionviewers" collection of methods.

Typical usage is: $androidenterpriseService = new Google_Service_AndroidEnterprise(...); $collectionviewers = $androidenterpriseService->collectionviewers;

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_AndroidEnterprise_Collectionviewers_Resource::delete ( $enterpriseId,
$collectionId,
$userId,
$optParams = array() )

Removes the user from the list of those specifically allowed to see the collection.

If the collection's visibility is set to viewersOnly then only such users will see the collection. (collectionviewers.delete)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$collectionIdThe ID of the collection.
string$userIdThe ID of the user.
array$optParamsOptional parameters.

◆ get()

Google_Service_AndroidEnterprise_Collectionviewers_Resource::get ( $enterpriseId,
$collectionId,
$userId,
$optParams = array() )

Retrieves the ID of the user if they have been specifically allowed to see the collection.

If the collection's visibility is set to viewersOnly then only these users will see the collection. (collectionviewers.get)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$collectionIdThe ID of the collection.
string$userIdThe ID of the user.
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_User

◆ listCollectionviewers()

Google_Service_AndroidEnterprise_Collectionviewers_Resource::listCollectionviewers ( $enterpriseId,
$collectionId,
$optParams = array() )

Retrieves the IDs of the users who have been specifically allowed to see the collection.

If the collection's visibility is set to viewersOnly then only these users will see the collection. (collectionviewers.listCollectionviewers)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$collectionIdThe ID of the collection.
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_CollectionViewersListResponse

◆ patch()

Google_Service_AndroidEnterprise_Collectionviewers_Resource::patch ( $enterpriseId,
$collectionId,
$userId,
Google_Service_AndroidEnterprise_User $postBody,
$optParams = array() )

Adds the user to the list of those specifically allowed to see the collection.

If the collection's visibility is set to viewersOnly then only such users will see the collection. This method supports patch semantics. (collectionviewers.patch)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$collectionIdThe ID of the collection.
string$userIdThe ID of the user.
Google_User$postBody
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_User

◆ update()

Google_Service_AndroidEnterprise_Collectionviewers_Resource::update ( $enterpriseId,
$collectionId,
$userId,
Google_Service_AndroidEnterprise_User $postBody,
$optParams = array() )

Adds the user to the list of those specifically allowed to see the collection.

If the collection's visibility is set to viewersOnly then only such users will see the collection. (collectionviewers.update)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$collectionIdThe ID of the collection.
string$userIdThe ID of the user.
Google_User$postBody
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_User

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