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

The "edits" collection of methods. More...

Inheritance diagram for Google_Service_AndroidPublisher_Edits_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 commit ($packageName, $editId, $optParams=array())
 Commits/applies the changes made in this edit back to the app.
 
 delete ($packageName, $editId, $optParams=array())
 Deletes an edit for an app.
 
 get ($packageName, $editId, $optParams=array())
 Returns information about the edit specified.
 
 insert ($packageName, Google_Service_AndroidPublisher_AppEdit $postBody, $optParams=array())
 Creates a new edit for an app, populated with the app's current state.
 
 validate ($packageName, $editId, $optParams=array())
 Checks that the edit can be successfully committed.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "edits" collection of methods.

Typical usage is: $androidpublisherService = new Google_Service_AndroidPublisher(...); $edits = $androidpublisherService->edits;

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

◆ commit()

Google_Service_AndroidPublisher_Edits_Resource::commit ( $packageName,
$editId,
$optParams = array() )

Commits/applies the changes made in this edit back to the app.

(edits.commit)

Parameters
string$packageNameUnique identifier for the Android app that is being updated; for example, "com.spiffygame".
string$editIdUnique identifier for this edit.
array$optParamsOptional parameters.
Return values
Google_Service_AndroidPublisher_AppEdit

◆ delete()

Google_Service_AndroidPublisher_Edits_Resource::delete ( $packageName,
$editId,
$optParams = array() )

Deletes an edit for an app.

Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit. (edits.delete)

Parameters
string$packageNameUnique identifier for the Android app that is being updated; for example, "com.spiffygame".
string$editIdUnique identifier for this edit.
array$optParamsOptional parameters.

◆ get()

Google_Service_AndroidPublisher_Edits_Resource::get ( $packageName,
$editId,
$optParams = array() )

Returns information about the edit specified.

Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired). (edits.get)

Parameters
string$packageNameUnique identifier for the Android app that is being updated; for example, "com.spiffygame".
string$editIdUnique identifier for this edit.
array$optParamsOptional parameters.
Return values
Google_Service_AndroidPublisher_AppEdit

◆ insert()

Google_Service_AndroidPublisher_Edits_Resource::insert ( $packageName,
Google_Service_AndroidPublisher_AppEdit $postBody,
$optParams = array() )

Creates a new edit for an app, populated with the app's current state.

(edits.insert)

Parameters
string$packageNameUnique identifier for the Android app that is being updated; for example, "com.spiffygame".
Google_AppEdit$postBody
array$optParamsOptional parameters.
Return values
Google_Service_AndroidPublisher_AppEdit

◆ validate()

Google_Service_AndroidPublisher_Edits_Resource::validate ( $packageName,
$editId,
$optParams = array() )

Checks that the edit can be successfully committed.

The edit's changes are not applied to the live app. (edits.validate)

Parameters
string$packageNameUnique identifier for the Android app that is being updated; for example, "com.spiffygame".
string$editIdUnique identifier for this edit.
array$optParamsOptional parameters.
Return values
Google_Service_AndroidPublisher_AppEdit

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