org.springframework.social.google.api.drive

Interface DriveOperations

All Known Implementing Classes:

DriveTemplate

public interface DriveOperations

Defines operations for integrating with Google Drive. Requires OAuth scope(s) from the following:

• https://www.googleapis.com/auth/drive.file
• https://www.googleapis.com/auth/drive
• https://www.googleapis.com/auth/drive.apps.readonly
• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive.readonly.metadata

See https://developers.google .com/drive/scopes for details about the different scopes

Method Summary

Modifier and Type	Method and Description
FileComment	addComment(java.lang.String fileId, FileComment comment) Adds a comment to a file
UserPermission	addPermission(java.lang.String fileId, UserPermission permission, boolean sendNotificationEmails) Adds a permission to a file
FileProperty	addProperty(java.lang.String fileId, FileProperty property) Adds a new property to a file
CommentReply	addReply(java.lang.String fileId, java.lang.String commentId, CommentReply reply) Adds a reply to a file comment
DriveFile	copy(java.lang.String id) Create a copy of a file
DriveFile	copy(java.lang.String id, java.lang.String[] parentIds) Create a copy of a file
DriveFile	copy(java.lang.String id, java.lang.String[] parentIds, java.lang.String title) Create a copy of a file
DriveFile	createFileMetadata(DriveFile metadata) Creates an empty file with metadata
DriveFile	createFolder(java.lang.String parentId, java.lang.String name) Creates a folder
void	delete(java.lang.String id) Permanently deletes a file
org.springframework.core.io.Resource	downloadFile(DriveFile file) Downloads a file from Google Drive.
org.springframework.core.io.Resource	downloadFile(java.lang.String id) Downloads a file from Google Drive.
DriveFileQueryBuilder	driveFileQuery() Creates a DriveFileQueryBuilder
FileCommentQueryBuilder	fileCommentQueryBuilder(java.lang.String fileId) Returns a FileCommentQueryBuilder for listing the comments of a file
DriveAbout	getAbout() Get general Google Drive details for the current user
DriveApp	getApp(java.lang.String id) Returns an application by its ID
java.util.List<DriveApp>	getApps() Returns the applications authorized by the user to access Google Drive API
FileCommentsPage	getComments(java.lang.String fileId, java.lang.String pageToken) Returns the first default page of comments on a file
DriveFile	getFile(java.lang.String id) Retrieves a file by its ID
DriveFilesPage	getFiles(java.lang.String parent, java.lang.String pageToken) Returns the files and folders under a specified folder
java.util.List<UserPermission>	getPermissions(java.lang.String fileId) Returns the permissions of a file
java.util.List<FileProperty>	getProperties(java.lang.String fileId) Get the custom properties applied to this file
FileProperty	getProperty(java.lang.String fileId, java.lang.String propertyKey) Get a specific custom property applied to this file
java.util.List<FileRevision>	getRevisions(java.lang.String fileId) Returns the revisions of a file
DriveFilesPage	getRootFiles(java.lang.String pageToken) Returns files and folders under the root folder
DriveFilesPage	getTrashedFiles(java.lang.String pageToken) Returns trashed files and folders
DriveFile	hide(java.lang.String id) Hides a file
DriveFile	move(java.lang.String id, java.lang.String parentId) Move a file into a different folder
void	removeComment(java.lang.String fileId, java.lang.String commentId) Removes a comment from a file
void	removePermission(java.lang.String fileId, java.lang.String permissionId) Removes a permission from a file
void	removeProperty(java.lang.String fileId, java.lang.String propertyKey) Deletes a property
void	removeReply(java.lang.String fileId, java.lang.String commentId, java.lang.String replyId) Removes a reply from a file comment
DriveFile	star(java.lang.String id) Stars a file
DriveFile	trash(java.lang.String id) Moves a file to trash
DriveFile	unhide(java.lang.String id) Unhides a file
DriveFile	unstar(java.lang.String id) Remove the star from a file
DriveFile	untrash(java.lang.String id) Restores a file from trash
FileComment	updateComment(java.lang.String fileId, java.lang.String commentId, FileComment comment) Updates a comment to a file
FileProperty	updateProperty(java.lang.String fileId, FileProperty property) Updates a property
CommentReply	updateReply(java.lang.String fileId, java.lang.String commentId, java.lang.String replyId, CommentReply reply) Updates a reply to a file comment
FileRevision	updateRevision(java.lang.String fileId, java.lang.String revisionId, FileRevision revision) Updates a file revision
UserPermission	updatesPermission(java.lang.String fileId, java.lang.String permissionId, UserPermission permission) Updates a permission to a file
DriveFile	upload(org.springframework.core.io.Resource resource, DriveFile metadata, UploadParameters parameters) Uploads a file using multipart

Method Detail

getAbout

DriveAbout getAbout()

Get general Google Drive details for the current user

Returns:

DriveAbout with details for the current user

getApps

java.util.List<DriveApp> getApps()

Returns the applications authorized by the user to access Google Drive API

Returns:

List of DriveApp for the current user

getApp

DriveApp getApp(java.lang.String id)

Returns an application by its ID

Parameters:

id - The ID of the application

Returns:

DriveApp matching the ID

getFile

DriveFile getFile(java.lang.String id)

Retrieves a file by its ID

Parameters:

id - the ID to retrieve by

Returns:

DriveFile matching the ID

driveFileQuery

DriveFileQueryBuilder driveFileQuery()

Creates a DriveFileQueryBuilder

Returns:

a new DriveFileQueryBuilder

getRootFiles

DriveFilesPage getRootFiles(java.lang.String pageToken)

Returns files and folders under the root folder

Parameters:

pageToken - Page token or null

Returns:

DriveFilesPage

getFiles

DriveFilesPage getFiles(java.lang.String parent,
                        java.lang.String pageToken)

Returns the files and folders under a specified folder

Parameters:

parent - folder ID or "root"

pageToken - Page token or null

Returns:

DriveFilesPage

getTrashedFiles

DriveFilesPage getTrashedFiles(java.lang.String pageToken)

Returns trashed files and folders

Parameters:

pageToken - Page token or null

Returns:

DriveFilesPage

trash

DriveFile trash(java.lang.String id)

Moves a file to trash

Parameters:

id - The ID of the file to trash

Returns:

The updated DriveFile

untrash

DriveFile untrash(java.lang.String id)

Restores a file from trash

Parameters:

id - The ID of the file to untrash return The updated DriveFile

Returns:

The trashed DriveFile

star

DriveFile star(java.lang.String id)

Stars a file

Parameters:

id - The ID of the file to star

Returns:

The updated DriveFile

unstar

DriveFile unstar(java.lang.String id)

Remove the star from a file

Parameters:

id - The ID of the file to unstar

Returns:

The updated DriveFile

hide

DriveFile hide(java.lang.String id)

Hides a file

Parameters:

id - The ID of the file to hide

Returns:

The updated DriveFile

unhide

DriveFile unhide(java.lang.String id)

Unhides a file

Parameters:

id - The ID of the file to unhide

Returns:

The updated DriveFile

delete

void delete(java.lang.String id)

Permanently deletes a file

Parameters:

id - The ID of the file to delete

copy

DriveFile copy(java.lang.String id)

Create a copy of a file

Parameters:

id - The ID of the source file

Returns:

The newly-created DriveFile copy

copy

DriveFile copy(java.lang.String id,
               java.lang.String[] parentIds)

Create a copy of a file

Parameters:

id - The ID of the source file

parentIds - Array of parent folder ID to place the file into, or "root"

Returns:

The newly-created DriveFile copy

copy

DriveFile copy(java.lang.String id,
               java.lang.String[] parentIds,
               java.lang.String title)

Create a copy of a file

Parameters:

id - The ID of the source file

parentIds - Array of parent folder ID to place the file into, or "root"

title - The title to apply to the new file

Returns:

The newly-created DriveFile copy

move

DriveFile move(java.lang.String id,
               java.lang.String parentId)

Move a file into a different folder

Parameters:

id - The ID of the file to move

parentId - The parent folder ID to move the file to, or "root"

Returns:

The updated DriveFile

upload

DriveFile upload(org.springframework.core.io.Resource resource,
                 DriveFile metadata,
                 UploadParameters parameters)

Uploads a file using multipart

Parameters:

resource - Reference to the file's content

metadata - The file's metadata

parameters - Parameters for uploading and processing the file

Returns:

The file resource that was created

createFileMetadata

DriveFile createFileMetadata(DriveFile metadata)

Creates an empty file with metadata

Parameters:

metadata - The file's properties

Returns:

DriveFile representing the created file

createFolder

DriveFile createFolder(java.lang.String parentId,
                       java.lang.String name)

Creates a folder

Parameters:

parentId - The parent folder ID or "root"

name - The name of the folder to create

Returns:

DriveFile representing the created folder

getPermissions

java.util.List<UserPermission> getPermissions(java.lang.String fileId)

Returns the permissions of a file

Parameters:

fileId - The ID of the file

Returns:

List of UserPermission for the file

addPermission

UserPermission addPermission(java.lang.String fileId,
                             UserPermission permission,
                             boolean sendNotificationEmails)

Adds a permission to a file

Parameters:

fileId - The file ID

permission - UserPermission with the permission settings

sendNotificationEmails - Whether to send notification e-mails

Returns:

The created UserPermission

updatesPermission

UserPermission updatesPermission(java.lang.String fileId,
                                 java.lang.String permissionId,
                                 UserPermission permission)

Updates a permission to a file

Parameters:

fileId - The file ID

permissionId - the ID of the permission

permission - UserPermission with new role and additionalRoles properties

Returns:

The updated UserPermission

removePermission

void removePermission(java.lang.String fileId,
                      java.lang.String permissionId)

Removes a permission from a file

Parameters:

fileId - The file ID

permissionId - The ID of the permission

getRevisions

java.util.List<FileRevision> getRevisions(java.lang.String fileId)

Returns the revisions of a file

Parameters:

fileId - The ID of the file

Returns:

List of FileRevision

updateRevision

FileRevision updateRevision(java.lang.String fileId,
                            java.lang.String revisionId,
                            FileRevision revision)

Updates a file revision

Parameters:

fileId - The ID of the file

revisionId - The ID of the revision

revision - FileRevision with new pinned, publishAuto, published and publishedOutsideDomain properties

Returns:

The updated FileRevision

fileCommentQueryBuilder

FileCommentQueryBuilder fileCommentQueryBuilder(java.lang.String fileId)

Returns a FileCommentQueryBuilder for listing the comments of a file

Parameters:

fileId - The ID of the file

Returns:

FileCommentQueryBuilder for the file

getComments

FileCommentsPage getComments(java.lang.String fileId,
                             java.lang.String pageToken)

Returns the first default page of comments on a file

Parameters:

fileId - The ID of the file

pageToken - Page token or null

Returns:

Page of comments

addComment

FileComment addComment(java.lang.String fileId,
                       FileComment comment)

Adds a comment to a file

Parameters:

fileId - The ID of the file

comment - The new comment

Returns:

The created FileComment

updateComment

FileComment updateComment(java.lang.String fileId,
                          java.lang.String commentId,
                          FileComment comment)

Updates a comment to a file

Parameters:

fileId - The ID of the file

commentId - The ID of the comment

comment - Comment with the new content

Returns:

The updated FileComment

removeComment

void removeComment(java.lang.String fileId,
                   java.lang.String commentId)

Removes a comment from a file

Parameters:

fileId - The ID of the file

commentId - The ID of the comment

addReply

CommentReply addReply(java.lang.String fileId,
                      java.lang.String commentId,
                      CommentReply reply)

Adds a reply to a file comment

Parameters:

fileId - The ID of the file

commentId - The ID of the comment

reply - The new reply

Returns:

The created CommentReply

updateReply

CommentReply updateReply(java.lang.String fileId,
                         java.lang.String commentId,
                         java.lang.String replyId,
                         CommentReply reply)

Updates a reply to a file comment

Parameters:

fileId - The ID of the file

commentId - The ID of the comment

replyId - The ID of the reply

reply - Reply with new content

Returns:

The updated CommentReply

removeReply

void removeReply(java.lang.String fileId,
                 java.lang.String commentId,
                 java.lang.String replyId)

Removes a reply from a file comment

Parameters:

fileId - The ID of the file

commentId - The ID of the comment

replyId - The ID of the reply

downloadFile

org.springframework.core.io.Resource downloadFile(java.lang.String id)

Downloads a file from Google Drive. This method first sends a request to get the download URL, and then another request to download the file.

Parameters:

id - The file ID

Returns:

Resource abstraction for the file

downloadFile

org.springframework.core.io.Resource downloadFile(DriveFile file)

Downloads a file from Google Drive. This method uses DriveFile.getDownloadUrl(), which may have expired since the file metadata was fetched.

Parameters:

file - The file metadata

Returns:

Resource abstraction for the file

getProperties

java.util.List<FileProperty> getProperties(java.lang.String fileId)

Get the custom properties applied to this file

Parameters:

fileId - The ID of the file

Returns:

The list of properties defined

getProperty

FileProperty getProperty(java.lang.String fileId,
                         java.lang.String propertyKey)

Get a specific custom property applied to this file

Parameters:

fileId - The ID of the file

propertyKey - The key of the property

Returns:

The the property information

addProperty

FileProperty addProperty(java.lang.String fileId,
                         FileProperty property)

Adds a new property to a file

Parameters:

fileId - The ID of the file

property - Property representation

Returns:

The new FileProperty

updateProperty

FileProperty updateProperty(java.lang.String fileId,
                            FileProperty property)

Updates a property

Parameters:

fileId - The ID of the file

property - Property representation

Returns:

The updated FileProperty

removeProperty

void removeProperty(java.lang.String fileId,
                    java.lang.String propertyKey)

Deletes a property

Parameters:

fileId - The ID of the file

propertyKey - The key of the property