• Home
• com.google.apis
• google-api-services-drive
• v2-rev20240730-2.0.0
• source code
• Drive.Permissions.Insert.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.drive.Drive.Permissions.Insert.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.drive
Class Drive.Permissions.Insert



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>


com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>


com.google.api.services.drive.DriveRequest<Permission>


com.google.api.services.drive.Drive.Permissions.Insert

















All Implemented Interfaces:
Cloneable, Map<String,Object>


Enclosing class:
Drive.Permissions




public class Drive.Permissions.Insert
extends DriveRequest<Permission>











Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Field Summary




Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
API_VERSION_HEADER, USER_AGENT_SUFFIX








Constructor Summary

Constructors 

Modifier
Constructor and Description


protected 
Insert(String fileId,
      Permission content)
Inserts a permission for a file or shared drive.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


String
getEmailMessage()
A plain text custom message to include in notification emails.



Boolean
getEnforceSingleParent()
Deprecated: See `moveToNewOwnersRoot` for details.



String
getFileId()
The ID for the file or shared drive.



Boolean
getMoveToNewOwnersRoot()
This parameter will only take effect if the item is not in a shared drive and the request is
     attempting to transfer the ownership of the item.



Boolean
getSendNotificationEmails()
Whether to send notification emails when sharing to users or groups.



Boolean
getSupportsAllDrives()
Whether the requesting application supports both My Drives and shared drives.



Boolean
getSupportsTeamDrives()
Deprecated: Use `supportsAllDrives` instead.



Boolean
getUseDomainAdminAccess()
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.



boolean
isEnforceSingleParent()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.



boolean
isMoveToNewOwnersRoot()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.



boolean
isSendNotificationEmails()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.



boolean
isSupportsAllDrives()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.



boolean
isSupportsTeamDrives()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.



boolean
isUseDomainAdminAccess()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.



Drive.Permissions.Insert
set(String parameterName,
   Object value) 


Drive.Permissions.Insert
set$Xgafv(String $Xgafv)
V1 error format.



Drive.Permissions.Insert
setAccessToken(String accessToken)
OAuth access token.



Drive.Permissions.Insert
setAlt(String alt)
Data format for response.



Drive.Permissions.Insert
setCallback(String callback)
JSONP



Drive.Permissions.Insert
setEmailMessage(String emailMessage)
A plain text custom message to include in notification emails.



Drive.Permissions.Insert
setEnforceSingleParent(Boolean enforceSingleParent)
Deprecated: See `moveToNewOwnersRoot` for details.



Drive.Permissions.Insert
setFields(String fields)
Selector specifying which fields to include in a partial response.



Drive.Permissions.Insert
setFileId(String fileId)
The ID for the file or shared drive.



Drive.Permissions.Insert
setKey(String key)
API key.



Drive.Permissions.Insert
setMoveToNewOwnersRoot(Boolean moveToNewOwnersRoot)
This parameter will only take effect if the item is not in a shared drive and the request
 is attempting to transfer the ownership of the item.



Drive.Permissions.Insert
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.



Drive.Permissions.Insert
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.



Drive.Permissions.Insert
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.



Drive.Permissions.Insert
setSendNotificationEmails(Boolean sendNotificationEmails)
Whether to send notification emails when sharing to users or groups.



Drive.Permissions.Insert
setSupportsAllDrives(Boolean supportsAllDrives)
Whether the requesting application supports both My Drives and shared drives.



Drive.Permissions.Insert
setSupportsTeamDrives(Boolean supportsTeamDrives)
Deprecated: Use `supportsAllDrives` instead.



Drive.Permissions.Insert
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.



Drive.Permissions.Insert
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.



Drive.Permissions.Insert
setUseDomainAdminAccess(Boolean useDomainAdminAccess)
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.







Methods inherited from class com.google.api.services.drive.DriveRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders





Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue





Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream





Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





Insert
protected Insert(String fileId,
                 Permission content)
Inserts a permission for a file or shared drive. **Warning:** Concurrent permissions operations
 on the same file are not supported; only the last update is applied.

 Create a request for the method "permissions.insert".

 This request holds the parameters needed by the the drive server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation. 
 Drive.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must
 be called to initialize this instance immediately after invoking the constructor. 

Parameters:
fileId - The ID for the file or shared drive.
content - the Permission
Since:
1.13










Method Detail





set$Xgafv
public Drive.Permissions.Insert set$Xgafv(String $Xgafv)
Description copied from class: DriveRequest
V1 error format.

Overrides:
set$Xgafv in class DriveRequest<Permission>








setAccessToken
public Drive.Permissions.Insert setAccessToken(String accessToken)
Description copied from class: DriveRequest
OAuth access token.

Overrides:
setAccessToken in class DriveRequest<Permission>








setAlt
public Drive.Permissions.Insert setAlt(String alt)
Description copied from class: DriveRequest
Data format for response.

Overrides:
setAlt in class DriveRequest<Permission>








setCallback
public Drive.Permissions.Insert setCallback(String callback)
Description copied from class: DriveRequest
JSONP

Overrides:
setCallback in class DriveRequest<Permission>








setFields
public Drive.Permissions.Insert setFields(String fields)
Description copied from class: DriveRequest
Selector specifying which fields to include in a partial response.

Overrides:
setFields in class DriveRequest<Permission>








setKey
public Drive.Permissions.Insert setKey(String key)
Description copied from class: DriveRequest
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.

Overrides:
setKey in class DriveRequest<Permission>








setOauthToken
public Drive.Permissions.Insert setOauthToken(String oauthToken)
Description copied from class: DriveRequest
OAuth 2.0 token for the current user.

Overrides:
setOauthToken in class DriveRequest<Permission>








setPrettyPrint
public Drive.Permissions.Insert setPrettyPrint(Boolean prettyPrint)
Description copied from class: DriveRequest
Returns response with indentations and line breaks.

Overrides:
setPrettyPrint in class DriveRequest<Permission>








setQuotaUser
public Drive.Permissions.Insert setQuotaUser(String quotaUser)
Description copied from class: DriveRequest
Available to use for quota purposes for server-side applications. Can be any arbitrary string
 assigned to a user, but should not exceed 40 characters.

Overrides:
setQuotaUser in class DriveRequest<Permission>








setUploadType
public Drive.Permissions.Insert setUploadType(String uploadType)
Description copied from class: DriveRequest
Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:
setUploadType in class DriveRequest<Permission>








setUploadProtocol
public Drive.Permissions.Insert setUploadProtocol(String uploadProtocol)
Description copied from class: DriveRequest
Upload protocol for media (e.g. "raw", "multipart").

Overrides:
setUploadProtocol in class DriveRequest<Permission>








getFileId
public String getFileId()
The ID for the file or shared drive.







setFileId
public Drive.Permissions.Insert setFileId(String fileId)
The ID for the file or shared drive.







getEmailMessage
public String getEmailMessage()
A plain text custom message to include in notification emails.







setEmailMessage
public Drive.Permissions.Insert setEmailMessage(String emailMessage)
A plain text custom message to include in notification emails.







getEnforceSingleParent
public Boolean getEnforceSingleParent()
Deprecated: See `moveToNewOwnersRoot` for details. [default: false]







setEnforceSingleParent
public Drive.Permissions.Insert setEnforceSingleParent(Boolean enforceSingleParent)
Deprecated: See `moveToNewOwnersRoot` for details.







isEnforceSingleParent
public boolean isEnforceSingleParent()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

 

 Boolean properties can have four possible values:
 null, Data.NULL_BOOLEAN, Boolean.TRUE
 or Boolean.FALSE.
 

 

 This method returns Boolean.TRUE if the default of the property is Boolean.TRUE
 and it is null or Data.NULL_BOOLEAN.
 Boolean.FALSE is returned if the default of the property is Boolean.FALSE and
 it is null or Data.NULL_BOOLEAN.
 

 

 Deprecated: See `moveToNewOwnersRoot` for details.
 







getMoveToNewOwnersRoot
public Boolean getMoveToNewOwnersRoot()
This parameter will only take effect if the item is not in a shared drive and the request is
     attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the
     new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not
     changed. [default: false]







setMoveToNewOwnersRoot
public Drive.Permissions.Insert setMoveToNewOwnersRoot(Boolean moveToNewOwnersRoot)
This parameter will only take effect if the item is not in a shared drive and the request
 is attempting to transfer the ownership of the item. If set to `true`, the item will be
 moved to the new owner's My Drive root folder and all prior parents removed. If set to
 `false`, parents are not changed.







isMoveToNewOwnersRoot
public boolean isMoveToNewOwnersRoot()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

 

 Boolean properties can have four possible values:
 null, Data.NULL_BOOLEAN, Boolean.TRUE
 or Boolean.FALSE.
 

 

 This method returns Boolean.TRUE if the default of the property is Boolean.TRUE
 and it is null or Data.NULL_BOOLEAN.
 Boolean.FALSE is returned if the default of the property is Boolean.FALSE and
 it is null or Data.NULL_BOOLEAN.
 

 

 This parameter will only take effect if the item is not in a shared drive and the request is
     attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the
     new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not
     changed.
 







getSendNotificationEmails
public Boolean getSendNotificationEmails()
Whether to send notification emails when sharing to users or groups. This parameter is ignored and
     an email is sent if the `role` is `owner`. [default: true]







setSendNotificationEmails
public Drive.Permissions.Insert setSendNotificationEmails(Boolean sendNotificationEmails)
Whether to send notification emails when sharing to users or groups. This parameter is
 ignored and an email is sent if the `role` is `owner`.







isSendNotificationEmails
public boolean isSendNotificationEmails()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

 

 Boolean properties can have four possible values:
 null, Data.NULL_BOOLEAN, Boolean.TRUE
 or Boolean.FALSE.
 

 

 This method returns Boolean.TRUE if the default of the property is Boolean.TRUE
 and it is null or Data.NULL_BOOLEAN.
 Boolean.FALSE is returned if the default of the property is Boolean.FALSE and
 it is null or Data.NULL_BOOLEAN.
 

 

 Whether to send notification emails when sharing to users or groups. This parameter is ignored and
     an email is sent if the `role` is `owner`.
 







getSupportsAllDrives
public Boolean getSupportsAllDrives()
Whether the requesting application supports both My Drives and shared drives. [default: false]







setSupportsAllDrives
public Drive.Permissions.Insert setSupportsAllDrives(Boolean supportsAllDrives)
Whether the requesting application supports both My Drives and shared drives.







isSupportsAllDrives
public boolean isSupportsAllDrives()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

 

 Boolean properties can have four possible values:
 null, Data.NULL_BOOLEAN, Boolean.TRUE
 or Boolean.FALSE.
 

 

 This method returns Boolean.TRUE if the default of the property is Boolean.TRUE
 and it is null or Data.NULL_BOOLEAN.
 Boolean.FALSE is returned if the default of the property is Boolean.FALSE and
 it is null or Data.NULL_BOOLEAN.
 

 

 Whether the requesting application supports both My Drives and shared drives.
 







getSupportsTeamDrives
public Boolean getSupportsTeamDrives()
Deprecated: Use `supportsAllDrives` instead. [default: false]







setSupportsTeamDrives
public Drive.Permissions.Insert setSupportsTeamDrives(Boolean supportsTeamDrives)
Deprecated: Use `supportsAllDrives` instead.







isSupportsTeamDrives
public boolean isSupportsTeamDrives()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

 

 Boolean properties can have four possible values:
 null, Data.NULL_BOOLEAN, Boolean.TRUE
 or Boolean.FALSE.
 

 

 This method returns Boolean.TRUE if the default of the property is Boolean.TRUE
 and it is null or Data.NULL_BOOLEAN.
 Boolean.FALSE is returned if the default of the property is Boolean.FALSE and
 it is null or Data.NULL_BOOLEAN.
 

 

 Deprecated: Use `supportsAllDrives` instead.
 







getUseDomainAdminAccess
public Boolean getUseDomainAdminAccess()
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. [default: false]







setUseDomainAdminAccess
public Drive.Permissions.Insert setUseDomainAdminAccess(Boolean useDomainAdminAccess)
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.







isUseDomainAdminAccess
public boolean isUseDomainAdminAccess()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

 

 Boolean properties can have four possible values:
 null, Data.NULL_BOOLEAN, Boolean.TRUE
 or Boolean.FALSE.
 

 

 This method returns Boolean.TRUE if the default of the property is Boolean.TRUE
 and it is null or Data.NULL_BOOLEAN.
 Boolean.FALSE is returned if the default of the property is Boolean.FALSE and
 it is null or Data.NULL_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.
 







set
public Drive.Permissions.Insert set(String parameterName,
                                    Object value)

Overrides:
set in class DriveRequest<Permission>














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.