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

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>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Drive.Permissions.Insert(String fileId, Permission content) Inserts a permission for a file or Team Drive.

Method Summary

Methods

Modifier and Type	Method and Description
String	getEmailMessage() A custom message to include in notification emails.
String	getFileId() The ID for the file or Team Drive.
Boolean	getSendNotificationEmails() Whether to send notification emails when sharing to users or groups.
Boolean	getSupportsTeamDrives() Whether the requesting application supports Team Drives.
Boolean	getUseDomainAdminAccess() Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.
boolean	isSendNotificationEmails() 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	setAlt(String alt) Data format for the response.
Drive.Permissions.Insert	setEmailMessage(String emailMessage) A custom message to include in notification emails.
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 Team Drive.
Drive.Permissions.Insert	setKey(String key) API key.
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	setSupportsTeamDrives(Boolean supportsTeamDrives) Whether the requesting application supports Team Drives.
Drive.Permissions.Insert	setUseDomainAdminAccess(Boolean useDomainAdminAccess) Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.
Drive.Permissions.Insert	setUserIp(String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.drive.DriveRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Drive.Permissions.Insert

protected Drive.Permissions.Insert(String fileId,
                        Permission content)

Inserts a permission for a file or Team Drive. 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 Team Drive.

content - the Permission

Since:

1.13

Method Detail

setAlt

public Drive.Permissions.Insert setAlt(String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt 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 userIp if both are provided.

Overrides:

setQuotaUser in class DriveRequest<Permission>

setUserIp

public Drive.Permissions.Insert setUserIp(String userIp)

Description copied from class: DriveRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class DriveRequest<Permission>

getFileId

public String getFileId()

The ID for the file or Team Drive.

setFileId

public Drive.Permissions.Insert setFileId(String fileId)

The ID for the file or Team Drive.

getEmailMessage

public String getEmailMessage()

A custom message to include in notification emails.

setEmailMessage

public Drive.Permissions.Insert setEmailMessage(String emailMessage)

A custom message to include in notification emails.

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.

getSupportsTeamDrives

public Boolean getSupportsTeamDrives()

Whether the requesting application supports Team Drives. [default: false]

setSupportsTeamDrives

public Drive.Permissions.Insert setSupportsTeamDrives(Boolean supportsTeamDrives)

Whether the requesting application supports Team Drives.

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.

Whether the requesting application supports Team Drives.

getUseDomainAdminAccess

public Boolean getUseDomainAdminAccess()

Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. [default: false]

setUseDomainAdminAccess

public Drive.Permissions.Insert setUseDomainAdminAccess(Boolean useDomainAdminAccess)

Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item 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.

Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.

set

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

Overrides:

set in class DriveRequest<Permission>