google_api_drive v0.15.0 GoogleApi.Drive.V3.Api.Permissions View Source

API calls for all endpoints tagged Permissions.

Link to this section Summary

Functions

drive_permissions_create(connection, file_id, optional_params \\ [], opts \\ [])

Creates a permission for a file or shared drive.

drive_permissions_delete(connection, file_id, permission_id, optional_params \\ [], opts \\ [])

Deletes a permission.

drive_permissions_get(connection, file_id, permission_id, optional_params \\ [], opts \\ [])

Gets a permission by ID.

drive_permissions_list(connection, file_id, optional_params \\ [], opts \\ [])

Lists a file's or shared drive's permissions.

drive_permissions_update(connection, file_id, permission_id, optional_params \\ [], opts \\ [])

Updates a permission with patch semantics.

Link to this section Functions

drive_permissions_create(connection, file_id, optional_params \\ [], opts \\ [])

Specs

drive_permissions_create(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.Permission.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a permission for a file or shared drive.

Parameters

connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
file_id (type: String.t) - The ID of the file or shared drive.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :emailMessage (type: String.t) - A plain text custom message to include in the notification email.
- :enforceSingleParent (type: boolean()) - Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. See moveToNewOwnersRoot for details.
- :moveToNewOwnersRoot (type: boolean()) - This parameter only takes effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. When set to true, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to false, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive.
- :sendNotificationEmail (type: boolean()) - Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.
- :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
- :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
- :transferOwnership (type: boolean()) - Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.
- :useDomainAdminAccess (type: boolean()) - Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
- :body (type: GoogleApi.Drive.V3.Model.Permission.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Drive.V3.Model.Permission{}} on success
{:error, info} on failure

drive_permissions_delete(connection, file_id, permission_id, optional_params \\ [], opts \\ [])

Specs

drive_permissions_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

Deletes a permission.

Parameters

connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
file_id (type: String.t) - The ID of the file or shared drive.
permission_id (type: String.t) - The ID of the permission.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
- :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
- :useDomainAdminAccess (type: boolean()) - Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

drive_permissions_get(connection, file_id, permission_id, optional_params \\ [], opts \\ [])

Specs

drive_permissions_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Drive.V3.Model.Permission.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a permission by ID.

Parameters

connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
file_id (type: String.t) - The ID of the file.
permission_id (type: String.t) - The ID of the permission.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
- :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
- :useDomainAdminAccess (type: boolean()) - Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Drive.V3.Model.Permission{}} on success
{:error, info} on failure

drive_permissions_list(connection, file_id, optional_params \\ [], opts \\ [])

Specs

drive_permissions_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.PermissionList.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists a file's or shared drive's permissions.

Parameters

connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
file_id (type: String.t) - The ID of the file or shared drive.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :pageSize (type: integer()) - The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.
- :pageToken (type: String.t) - The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
- :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
- :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
- :useDomainAdminAccess (type: boolean()) - Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Drive.V3.Model.PermissionList{}} on success
{:error, info} on failure

drive_permissions_update(connection, file_id, permission_id, optional_params \\ [], opts \\ [])

Specs

drive_permissions_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Drive.V3.Model.Permission.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates a permission with patch semantics.

Parameters

connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
file_id (type: String.t) - The ID of the file or shared drive.
permission_id (type: String.t) - The ID of the permission.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :removeExpiration (type: boolean()) - Whether to remove the expiration date.
- :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
- :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
- :transferOwnership (type: boolean()) - Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.
- :useDomainAdminAccess (type: boolean()) - Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
- :body (type: GoogleApi.Drive.V3.Model.Permission.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Drive.V3.Model.Permission{}} on success
{:error, info} on failure