com.google.api.services.drive.model

Class File.Capabilities

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.drive.model.File.Capabilities

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

File

public static final class File.Capabilities
extends com.google.api.client.json.GenericJson

Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

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>

Constructor Summary

Constructors

Constructor and Description
Capabilities()

Method Summary

Modifier and Type	Method and Description
File.Capabilities	clone()
Boolean	getCanAddChildren() Whether the current user can add children to this folder.
Boolean	getCanChangeCopyRequiresWriterPermission() Whether the current user can change the copyRequiresWriterPermission restriction of this file.
Boolean	getCanChangeViewersCanCopyContent() Deprecated
Boolean	getCanComment() Whether the current user can comment on this file.
Boolean	getCanCopy() Whether the current user can copy this file.
Boolean	getCanDelete() Whether the current user can delete this file.
Boolean	getCanDeleteChildren() Whether the current user can delete children of this folder.
Boolean	getCanDownload() Whether the current user can download this file.
Boolean	getCanEdit() Whether the current user can edit this file.
Boolean	getCanListChildren() Whether the current user can list the children of this folder.
Boolean	getCanMoveChildrenOutOfTeamDrive() Whether the current user can move children of this folder outside of the Team Drive.
Boolean	getCanMoveChildrenWithinTeamDrive() Whether the current user can move children of this folder within the Team Drive.
Boolean	getCanMoveItemIntoTeamDrive() Whether the current user can move this item into a Team Drive.
Boolean	getCanMoveItemOutOfTeamDrive() Whether the current user can move this Team Drive item outside of this Team Drive by changing its parent.
Boolean	getCanMoveItemWithinTeamDrive() Whether the current user can move this Team Drive item within this Team Drive.
Boolean	getCanMoveTeamDriveItem() Deprecated - use canMoveItemWithinTeamDrive or canMoveItemOutOfTeamDrive instead.
Boolean	getCanReadRevisions() Whether the current user can read the revisions resource of this file.
Boolean	getCanReadTeamDrive() Whether the current user can read the Team Drive to which this file belongs.
Boolean	getCanRemoveChildren() Whether the current user can remove children from this folder.
Boolean	getCanRename() Whether the current user can rename this file.
Boolean	getCanShare() Whether the current user can modify the sharing settings for this file.
Boolean	getCanTrash() Whether the current user can move this file to trash.
Boolean	getCanTrashChildren() Whether the current user can trash children of this folder.
Boolean	getCanUntrash() Whether the current user can restore this file from trash.
File.Capabilities	set(String fieldName, Object value)
File.Capabilities	setCanAddChildren(Boolean canAddChildren) Whether the current user can add children to this folder.
File.Capabilities	setCanChangeCopyRequiresWriterPermission(Boolean canChangeCopyRequiresWriterPermission) Whether the current user can change the copyRequiresWriterPermission restriction of this file.
File.Capabilities	setCanChangeViewersCanCopyContent(Boolean canChangeViewersCanCopyContent) Deprecated
File.Capabilities	setCanComment(Boolean canComment) Whether the current user can comment on this file.
File.Capabilities	setCanCopy(Boolean canCopy) Whether the current user can copy this file.
File.Capabilities	setCanDelete(Boolean canDelete) Whether the current user can delete this file.
File.Capabilities	setCanDeleteChildren(Boolean canDeleteChildren) Whether the current user can delete children of this folder.
File.Capabilities	setCanDownload(Boolean canDownload) Whether the current user can download this file.
File.Capabilities	setCanEdit(Boolean canEdit) Whether the current user can edit this file.
File.Capabilities	setCanListChildren(Boolean canListChildren) Whether the current user can list the children of this folder.
File.Capabilities	setCanMoveChildrenOutOfTeamDrive(Boolean canMoveChildrenOutOfTeamDrive) Whether the current user can move children of this folder outside of the Team Drive.
File.Capabilities	setCanMoveChildrenWithinTeamDrive(Boolean canMoveChildrenWithinTeamDrive) Whether the current user can move children of this folder within the Team Drive.
File.Capabilities	setCanMoveItemIntoTeamDrive(Boolean canMoveItemIntoTeamDrive) Whether the current user can move this item into a Team Drive.
File.Capabilities	setCanMoveItemOutOfTeamDrive(Boolean canMoveItemOutOfTeamDrive) Whether the current user can move this Team Drive item outside of this Team Drive by changing its parent.
File.Capabilities	setCanMoveItemWithinTeamDrive(Boolean canMoveItemWithinTeamDrive) Whether the current user can move this Team Drive item within this Team Drive.
File.Capabilities	setCanMoveTeamDriveItem(Boolean canMoveTeamDriveItem) Deprecated - use canMoveItemWithinTeamDrive or canMoveItemOutOfTeamDrive instead.
File.Capabilities	setCanReadRevisions(Boolean canReadRevisions) Whether the current user can read the revisions resource of this file.
File.Capabilities	setCanReadTeamDrive(Boolean canReadTeamDrive) Whether the current user can read the Team Drive to which this file belongs.
File.Capabilities	setCanRemoveChildren(Boolean canRemoveChildren) Whether the current user can remove children from this folder.
File.Capabilities	setCanRename(Boolean canRename) Whether the current user can rename this file.
File.Capabilities	setCanShare(Boolean canShare) Whether the current user can modify the sharing settings for this file.
File.Capabilities	setCanTrash(Boolean canTrash) Whether the current user can move this file to trash.
File.Capabilities	setCanTrashChildren(Boolean canTrashChildren) Whether the current user can trash children of this folder.
File.Capabilities	setCanUntrash(Boolean canUntrash) Whether the current user can restore this file from trash.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

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

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

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, 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

Capabilities

public Capabilities()

Method Detail

getCanAddChildren

public Boolean getCanAddChildren()

Whether the current user can add children to this folder. This is always false when the item is not a folder.

Returns:

value or null for none

setCanAddChildren

public File.Capabilities setCanAddChildren(Boolean canAddChildren)

Whether the current user can add children to this folder. This is always false when the item is not a folder.

Parameters:

canAddChildren - canAddChildren or null for none

getCanChangeCopyRequiresWriterPermission

public Boolean getCanChangeCopyRequiresWriterPermission()

Whether the current user can change the copyRequiresWriterPermission restriction of this file.

Returns:

value or null for none

setCanChangeCopyRequiresWriterPermission

public File.Capabilities setCanChangeCopyRequiresWriterPermission(Boolean canChangeCopyRequiresWriterPermission)

Whether the current user can change the copyRequiresWriterPermission restriction of this file.

Parameters:

canChangeCopyRequiresWriterPermission - canChangeCopyRequiresWriterPermission or null for none

getCanChangeViewersCanCopyContent

public Boolean getCanChangeViewersCanCopyContent()

Deprecated

Returns:

value or null for none

setCanChangeViewersCanCopyContent

public File.Capabilities setCanChangeViewersCanCopyContent(Boolean canChangeViewersCanCopyContent)

Deprecated

Parameters:

canChangeViewersCanCopyContent - canChangeViewersCanCopyContent or null for none

getCanComment

public Boolean getCanComment()

Whether the current user can comment on this file.

Returns:

value or null for none

setCanComment

public File.Capabilities setCanComment(Boolean canComment)

Whether the current user can comment on this file.

Parameters:

canComment - canComment or null for none

getCanCopy

public Boolean getCanCopy()

Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.

Returns:

value or null for none

setCanCopy

public File.Capabilities setCanCopy(Boolean canCopy)

Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.

Parameters:

canCopy - canCopy or null for none

getCanDelete

public Boolean getCanDelete()

Whether the current user can delete this file.

Returns:

value or null for none

setCanDelete

public File.Capabilities setCanDelete(Boolean canDelete)

Whether the current user can delete this file.

Parameters:

canDelete - canDelete or null for none

getCanDeleteChildren

public Boolean getCanDeleteChildren()

Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for Team Drive items.

Returns:

value or null for none

setCanDeleteChildren

public File.Capabilities setCanDeleteChildren(Boolean canDeleteChildren)

Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for Team Drive items.

Parameters:

canDeleteChildren - canDeleteChildren or null for none

getCanDownload

public Boolean getCanDownload()

Whether the current user can download this file.

Returns:

value or null for none

setCanDownload

public File.Capabilities setCanDownload(Boolean canDownload)

Whether the current user can download this file.

Parameters:

canDownload - canDownload or null for none

getCanEdit

public Boolean getCanEdit()

Whether the current user can edit this file.

Returns:

value or null for none

setCanEdit

public File.Capabilities setCanEdit(Boolean canEdit)

Whether the current user can edit this file.

Parameters:

canEdit - canEdit or null for none

getCanListChildren

public Boolean getCanListChildren()

Whether the current user can list the children of this folder. This is always false when the item is not a folder.

Returns:

value or null for none

setCanListChildren

public File.Capabilities setCanListChildren(Boolean canListChildren)

Whether the current user can list the children of this folder. This is always false when the item is not a folder.

Parameters:

canListChildren - canListChildren or null for none

getCanMoveChildrenOutOfTeamDrive

public Boolean getCanMoveChildrenOutOfTeamDrive()

Whether the current user can move children of this folder outside of the Team Drive. This is false when the item is not a folder. Only populated for Team Drive items.

Returns:

value or null for none

setCanMoveChildrenOutOfTeamDrive

public File.Capabilities setCanMoveChildrenOutOfTeamDrive(Boolean canMoveChildrenOutOfTeamDrive)

Whether the current user can move children of this folder outside of the Team Drive. This is false when the item is not a folder. Only populated for Team Drive items.

Parameters:

canMoveChildrenOutOfTeamDrive - canMoveChildrenOutOfTeamDrive or null for none

getCanMoveChildrenWithinTeamDrive

public Boolean getCanMoveChildrenWithinTeamDrive()

Whether the current user can move children of this folder within the Team Drive. This is false when the item is not a folder. Only populated for Team Drive items.

Returns:

value or null for none

setCanMoveChildrenWithinTeamDrive

public File.Capabilities setCanMoveChildrenWithinTeamDrive(Boolean canMoveChildrenWithinTeamDrive)

Whether the current user can move children of this folder within the Team Drive. This is false when the item is not a folder. Only populated for Team Drive items.

Parameters:

canMoveChildrenWithinTeamDrive - canMoveChildrenWithinTeamDrive or null for none

getCanMoveItemIntoTeamDrive

public Boolean getCanMoveItemIntoTeamDrive()

Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem.

Returns:

value or null for none

setCanMoveItemIntoTeamDrive

public File.Capabilities setCanMoveItemIntoTeamDrive(Boolean canMoveItemIntoTeamDrive)

Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem.

Parameters:

canMoveItemIntoTeamDrive - canMoveItemIntoTeamDrive or null for none

getCanMoveItemOutOfTeamDrive

public Boolean getCanMoveItemOutOfTeamDrive()

Whether the current user can move this Team Drive item outside of this Team Drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for Team Drive items.

Returns:

value or null for none

setCanMoveItemOutOfTeamDrive

public File.Capabilities setCanMoveItemOutOfTeamDrive(Boolean canMoveItemOutOfTeamDrive)

Whether the current user can move this Team Drive item outside of this Team Drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for Team Drive items.

Parameters:

canMoveItemOutOfTeamDrive - canMoveItemOutOfTeamDrive or null for none

getCanMoveItemWithinTeamDrive

public Boolean getCanMoveItemWithinTeamDrive()

Whether the current user can move this Team Drive item within this Team Drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for Team Drive items.

Returns:

value or null for none

setCanMoveItemWithinTeamDrive

public File.Capabilities setCanMoveItemWithinTeamDrive(Boolean canMoveItemWithinTeamDrive)

Whether the current user can move this Team Drive item within this Team Drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for Team Drive items.

Parameters:

canMoveItemWithinTeamDrive - canMoveItemWithinTeamDrive or null for none

getCanMoveTeamDriveItem

public Boolean getCanMoveTeamDriveItem()

Deprecated - use canMoveItemWithinTeamDrive or canMoveItemOutOfTeamDrive instead.

Returns:

value or null for none

setCanMoveTeamDriveItem

public File.Capabilities setCanMoveTeamDriveItem(Boolean canMoveTeamDriveItem)

Deprecated - use canMoveItemWithinTeamDrive or canMoveItemOutOfTeamDrive instead.

Parameters:

canMoveTeamDriveItem - canMoveTeamDriveItem or null for none

getCanReadRevisions

public Boolean getCanReadRevisions()

Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.

Returns:

value or null for none

setCanReadRevisions

public File.Capabilities setCanReadRevisions(Boolean canReadRevisions)

Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.

Parameters:

canReadRevisions - canReadRevisions or null for none

getCanReadTeamDrive

public Boolean getCanReadTeamDrive()

Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files.

Returns:

value or null for none

setCanReadTeamDrive

public File.Capabilities setCanReadTeamDrive(Boolean canReadTeamDrive)

Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files.

Parameters:

canReadTeamDrive - canReadTeamDrive or null for none

getCanRemoveChildren

public Boolean getCanRemoveChildren()

Whether the current user can remove children from this folder. This is always false when the item is not a folder. For Team Drive items, use canDeleteChildren or canTrashChildren instead.

Returns:

value or null for none

setCanRemoveChildren

public File.Capabilities setCanRemoveChildren(Boolean canRemoveChildren)

Whether the current user can remove children from this folder. This is always false when the item is not a folder. For Team Drive items, use canDeleteChildren or canTrashChildren instead.

Parameters:

canRemoveChildren - canRemoveChildren or null for none

getCanRename

public Boolean getCanRename()

Whether the current user can rename this file.

Returns:

value or null for none

setCanRename

public File.Capabilities setCanRename(Boolean canRename)

Whether the current user can rename this file.

Parameters:

canRename - canRename or null for none

getCanShare

public Boolean getCanShare()

Whether the current user can modify the sharing settings for this file.

Returns:

value or null for none

setCanShare

public File.Capabilities setCanShare(Boolean canShare)

Whether the current user can modify the sharing settings for this file.

Parameters:

canShare - canShare or null for none

getCanTrash

public Boolean getCanTrash()

Whether the current user can move this file to trash.

Returns:

value or null for none

setCanTrash

public File.Capabilities setCanTrash(Boolean canTrash)

Whether the current user can move this file to trash.

Parameters:

canTrash - canTrash or null for none

getCanTrashChildren

public Boolean getCanTrashChildren()

Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for Team Drive items.

Returns:

value or null for none

setCanTrashChildren

public File.Capabilities setCanTrashChildren(Boolean canTrashChildren)

Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for Team Drive items.

Parameters:

canTrashChildren - canTrashChildren or null for none

getCanUntrash

public Boolean getCanUntrash()

Whether the current user can restore this file from trash.

Returns:

value or null for none

setCanUntrash

public File.Capabilities setCanUntrash(Boolean canUntrash)

Whether the current user can restore this file from trash.

Parameters:

canUntrash - canUntrash or null for none

set

public File.Capabilities set(String fieldName,
                             Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public File.Capabilities clone()

Overrides:

clone in class com.google.api.client.json.GenericJson