Google_PermissionsServiceResource
The "permissions" collection of methods.
Defined (1)
The class is defined in the following location(s).
- /src/contrib/Google_DriveService.php
- class Google_PermissionsServiceResource extends Google_ServiceResource {
- /**
- * Deletes a permission from a file. (permissions.delete)
- *
- * @param string $fileId The ID for the file.
- * @param string $permissionId The ID for the permission.
- * @param array $optParams Optional parameters.
- */
- public function delete($fileId, $permissionId, $optParams = array()) {
- $params = array('fileId' => $fileId, 'permissionId' => $permissionId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('delete', array($params));
- return $data;
- }
- /**
- * Gets a permission by ID. (permissions.get)
- *
- * @param string $fileId The ID for the file.
- * @param string $permissionId The ID for the permission.
- * @param array $optParams Optional parameters.
- * @return Google_Permission
- */
- public function get($fileId, $permissionId, $optParams = array()) {
- $params = array('fileId' => $fileId, 'permissionId' => $permissionId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new Google_Permission($data);
- } else {
- return $data;
- }
- }
- /**
- * Inserts a permission for a file. (permissions.insert)
- *
- * @param string $fileId The ID for the file.
- * @param Google_Permission $postBody
- * @param array $optParams Optional parameters.
- *
- * @opt_param string emailMessage A custom message to include in notification emails.
- * @opt_param bool sendNotificationEmails Whether to send notification emails when sharing to users or groups.
- * @return Google_Permission
- */
- public function insert($fileId, Google_Permission $postBody, $optParams = array()) {
- $params = array('fileId' => $fileId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('insert', array($params));
- if ($this->useObjects()) {
- return new Google_Permission($data);
- } else {
- return $data;
- }
- }
- /**
- * Lists a file's permissions. (permissions.list)
- *
- * @param string $fileId The ID for the file.
- * @param array $optParams Optional parameters.
- * @return Google_PermissionList
- */
- public function listPermissions($fileId, $optParams = array()) {
- $params = array('fileId' => $fileId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new Google_PermissionList($data);
- } else {
- return $data;
- }
- }
- /**
- * Updates a permission. This method supports patch semantics. (permissions.patch)
- *
- * @param string $fileId The ID for the file.
- * @param string $permissionId The ID for the permission.
- * @param Google_Permission $postBody
- * @param array $optParams Optional parameters.
- *
- * @opt_param bool transferOwnership Whether changing a role to 'owner' should also downgrade the current owners to writers.
- * @return Google_Permission
- */
- public function patch($fileId, $permissionId, Google_Permission $postBody, $optParams = array()) {
- $params = array('fileId' => $fileId, 'permissionId' => $permissionId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('patch', array($params));
- if ($this->useObjects()) {
- return new Google_Permission($data);
- } else {
- return $data;
- }
- }
- /**
- * Updates a permission. (permissions.update)
- *
- * @param string $fileId The ID for the file.
- * @param string $permissionId The ID for the permission.
- * @param Google_Permission $postBody
- * @param array $optParams Optional parameters.
- *
- * @opt_param bool transferOwnership Whether changing a role to 'owner' should also downgrade the current owners to writers.
- * @return Google_Permission
- */
- public function update($fileId, $permissionId, Google_Permission $postBody, $optParams = array()) {
- $params = array('fileId' => $fileId, 'permissionId' => $permissionId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('update', array($params));
- if ($this->useObjects()) {
- return new Google_Permission($data);
- } else {
- return $data;
- }
- }
- }