Version 1.7 - Updated on 05/04/2017
public class CloudClient
The main Java SDK Personal Cloud Storage interface class. For server-side applications, you will typically have one instance of this class for each end user, each constructed with a different instance of CloudClientContext
.
public void addListener(OAuthTokenListener listener)
Allows client code to persist newly-generated access tokens.
listener
public class CloudAuthClient
Encapsulates methods related to the OAuth 2.0 authorization flow. Use these methods to obtain an OAuth 2.0 access tokens to access an end-user's Personal Cloud Storage content.
To initiate the flow, call authorizeURI
(for SPC users) to obtain a URI. When you send end-users to the indicated URI, they are prompted to log in using their Verizon credentials and grant your app access to their Cloud Storage Content.
If access is granted, a callback is made to the indicated URI with an authorization code. To complete the authorization flow, pass the code in a call to getAccessToken
.
If access is denied, a callback is made to the indicated URI that includes the query parameter 'error'.
getAccessToken()
responses contain an OAuth 2.0 access token and a refresh token. The access token is used internally in all CloudClient
API calls involving the end-user's Cloud Storage Content. If the access token has expired, an attempt is automatically made to obtain a new access token using the refresh token. If that attempt fails, (perhaps due to an expired refresh token), a CloudAuthException
is thrown, and the third-party application needs to initiate the OAuth 2.0 authorization flow again.
The third party application is responsible for persisting access tokens, as needed. We suggest that third-party applications register a callback to receive a notification when access tokens are refreshed.
public URI authorizeURI(String state)
Obtains a URI used to start the OAuth 2.0 authorization flow. The URI will prompt the users to login and grant access to their Personal Cloud Storage content.
state
— Optional string of arbitrary data. If provided, this string is included in the callback.public OAuthToken getAccessToken(String authorizationCode) throws IOException, CloudHttpException
The second part of the standard OAuth 2.0 authorization flow. Uses an authorization code obtained through authorizeURI
to obtain an access token and refresh token, used for accessing an end-user's Cloud Storage content.
Exceptions listed below usually indicate that the OAuth 2.0 authorization flow will need to be re-run.
IOException
— HTTP request failureCloudAuthException
— Failure to obtain a new access tokenpublic OAuthToken refreshOauthToken(OAuthToken token) throws IOException, CloudHttpException
Called when an OAuth 2.0 access token expires. Attempts to obtain a new access token, using an end-user's refresh token will fail if the refresh token is expired.
In general, this method will only to be called internally, when an expired access token is detected.
IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic CloudAuthClient getAuthClient()
Used to make OAuth 2.0 authorization flow calls.
public Account getAccount() throws IOException, CloudHttpException
Obtains an end-user's account metadata.
IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic Contact createContact(Contact contact) throws IOException, CloudHttpException
Creates a new contact.
contact
— Contact to be createdID
and version
fields populatedIOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic void deleteContact(Contact contact) throws IOException, CloudHttpException
Deletes specified contact.
contact
— The contact to be deleted.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic void deleteContact(String id) throws IOException, CloudHttpException
Deletes specified contact.
id
— The id of the contact to be deleted.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic Contacts getContacts(String query, String sort, Integer page, Integer count) throws IOException, CloudHttpException
Retrieves contacts.
query
— Contains the value of a field that is stored in contacts which can be used to search for a specific contact or set of contacts. Supported fields are:address.home
address.home.street
sort
— Specifies the sort order for the response. Syntax is: {field}+{asc or desc}
. Valid values for field
are:page
— Page number to return, for paginated responses. Defaulted to 1count
— Maximum items to include in a paginated response. Default is 200.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responseNOTE: This SDK returns a maximum of 200 contacts in a successful response.
public Contact updateContact(Contact contact) throws IOException, CloudHttpException
Updates specified contact.
contact
— The contact being updated. The version and id fields must be set.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic void deleteFavorites(String uri) throws IOException, CloudHttpException
Removes the favorite flag from a file or folder.
uri
— URI of the file or folder obtained via a call to getFullview()
, getSearch()
, or getMetadata()
IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic Favorites getFavorites(String virtualFolder, FavoriteType type, FavoriteFileType fileType) throws IOException, CloudHttpException
Retrieves a list of files or folders for which the favorite flag is set to true.
virtualFolder
— Folder that represents various client types at the root level and contains their respective data.type
— Used to restrict the search results. Possible values are:fileType
— The type of the favorite. Possible values are:IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP response1 Documents list all file types other than image, music, or video. They are categorized by the mime-type, such as application/pdf, application/octet-stream.
public void setFavorites(List<String> uri) throws IOException, CloudHttpException
Sets the favorite flag for a set of files or folders.
uri
— URI of the file or folder obtained via a call to getFullview()
, getSearch()
, or getMetadata()
IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic FopsMetadata copy(String src, String target, Boolean safe, ConflictSolveType conflictSolve, OverrideType override) throws IOException, CloudHttpException
Copies a file or folder.
src
— Current file's or folder's path and nametarget
— New file's or folder's path and namesafe
— If false, overwrites any existing file or folder in the target location. If true, uses conflictSolve
param to resolve target conflicts. Default is false.conflictSolve
— If null, operation fails if the target file or folder already exists. If set to ConflictSolveType.copy, a non-conflicting target name is generated.override
— Specifies what happens when a folder of the same name already exists at the specified path:IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responseNOTE:
You cannot perform the copy
operation on a virutal folder.
public FolderMetadata createFolder(String name, String path, OverrideType override) throws IOException, CloudHttpException
Creates a new folder.
name
— Name of the new folderpath
— Parent folder of the new folderoverride
— Specifies what happens when a folder of the same name already exists at the specified path:IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responseNOTE:
You cannot perform the createFolder
operation on a virutal folder.
public void delete(String path, Boolean purge) throws IOException, CloudHttpException
Deletes a file or folder.
path
— Full path of the file or folder to be deletedpurge
— If true, permanently deletes the file or folder. Defaults to false.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responseNOTE:
You cannot perform the delete
operation on a virutal folder.
public HttpResponse getFile(String path) throws IOException, CloudHttpException
Retrieves a file or folder using its name.
path
— Full path to the desired fileIOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic Fullview getFullview(String etag) throws IOException, CloudHttpException
Obtains an end-user's fullview data. Includes metadata for an end-user's files and folders.
Return value contains a property 'etag', which can be supplied as an argument to subsequent getFullview()
calls, in which case only metadata changes (adds, updates, and deletes) since the previous call are returned.
etag
— The 'etag' value obtained from a previous call to getFullview(). If supplied, only subsequent adds, changes, and deletes are included in the response.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic FullviewStreaming getFullviewStreaming(String etag) throws IOException, CloudHttpException
Obtains the current user's fullview data. Streams the response to reduce memory consumption.
etag
—IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic Metadata getMetadata(String path, Boolean includeDeleted, SortTemplate sort, Integer page, Integer count, FilterType filter) throws IOException, CloudHttpException
Retrieves metadata for a single item, a file or a folder. For folders, the response includes the folder's children's metadata (files and/or subfolders).
path
— Fully-qualified path name of the required itemincludeDeleted
— For folders, if true, deleted children are included in the response.sort
— For folders, a SortTemplate
object indicating the sort order for the folder's childrenpage
— For folders, the page to return in a paginated response. Defaults to 1.count
— For folders, the maximum items to return. Defaults to 20, maximum value is 100.filter
— For folders, indicates if only file or folder children will be included in the response. Valid values are folder and file.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic Metadata getMetadata(String path, Boolean includeDeleted, String sort, Integer page, Integer count, FilterType filter) throws IOException, CloudHttpException
Retrieves metadata for a single item, such as a file or a folder. For folders, the response includes the folder's children's metadata (files and/or subfolders).
path
— Fully-qualified path name of the required itemincludeDeleted
— For folders, if true, deleted children are included in the response.sort
— Sort order for folder response. Syntax is: {field}+{asc or desc}
. Valid values are: name, type, versionCreated, size, extension, album, artist, captureDate, compilation, contentType, creationDate, favorite, genre, height, modificationDate, priority, source, tags, title, timelineDate.page
— For folders, the page to return in a paginated response. Defaults to 1.count
— For folders, the maximum items to return. Defaults to 20, maximum value is 100.filter
— For folders, indicates if only file or folder children will be included in the response. Valid values are folder and file.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic Search getSearch(SearchTemplate query, SortTemplate sort, Integer page, Integer count) throws IOException, CloudHttpException
Finds the set of the current user's files and folders that match the search criteria.
query
— SearchTemplate
object representing the query criteriasort
— SortTemplate
object representing the sort order to usepage
— The page to return in a paginated response. Defaults to 1.count
— The maximum items to return. Defaults to 20, maximum value is 100.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic Search getSearch(String query, String sort, Integer page, Integer count) throws IOException, CloudHttpException
Finds the set of the current user's files and folders that match a search criteria.
query
— Lucene-compatible query stringsort
— Sort order for folder response. Syntax is: {field}+{asc or desc}
. Valid values are: name, type, versionCreated, size, extension, album, artist, captureDate, compilation, contentType, creationDate, favorite, genre, height, modificationDate, priority, source, tags, title, timelineDate.page
— The page to return in a paginated response. Defaults to 1.count
— The maximum items to return. Defaults to 20, maximum value is 100.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic InputStream getThumbnail(String contentToken, ThumbnailSize size, Integer th, Integer tw) throws IOException, CloudHttpException
Retrieves a thumbnail, in jpg format, for one of the current user's image files.
contentToken
— Content token for the desired imagesize
— Size of the requested thumbnail. We recommend to specify size rather than th and tw.th
— Requested thumbnail height. If size isn't specified, th and tw are required.tw
— Requested thumbnail width. If size isn't specified, th and tw are required.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic FopsMetadata move(String src, String target, Boolean safe, ConflictSolveType conflictSolve) throws IOException, CloudHttpException
Moves a file or folder.
src
— Current file's or folder's path and nametarget
— New file's or folder's path and namesafe
— If false, overwrites any existing file or folder in the target location. If true, uses conflictSolve to resolve target conflicts. Default is false.conflictSolve
— If null, operation will fail if the target file or folder already exists. If set to ConflictSolveType.copy, a non-conflicting target name will be generated.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responseNOTE:
You cannot perform the move
operation on a virutal folder.
public FopsMetadata rename(String src, String target, Boolean safe, ConflictSolveType conflictSolve) throws IOException, CloudHttpException
Renames a file or folder.
src
— Current file's or folder's path and nametarget
— New file's or folder's path and namesafe
— If false, overwrites any existing file or folder in the target location. If true, uses conflictSolve to resolve target conflicts. Default is false.conflictSolve
— If null, operation will fail if the target file or folder already exists. If set to ConflictSolveType.copy, a non-conflicting target name will be generated.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responseNOTE:
You cannot perform the rename
operation on a virutal folder.
NOTE:
You cannot perform the file upload operation on a virutal folder.
public FileUploadIntent getFileuploadIntent(String path, String name, Integer size, String checksum, boolean chunk) throws IOException, CloudHttpException
First step to uploading a file. Includes support for both chunked and unchunked uploads.
Response includes the URLs to use for uploading file content, and in the case of chunked uploads, committing the upload once the content is sent.
path
— Path (folder) where the new file is to be uploadedname
— Name of the new filesize
— File sizechecksum
— SHA-256 checksum for the file's binary content.chunk
— true indicates chunked upload.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic HttpResponse postCommit(String commitUrl) throws IOException, CloudHttpException
Parameters: commitUrl
— The URL to use for commits. Obtained via a call to CloudClient.getFileuploadIntent.
IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic void postFileChunk(String uploadUrl, InputStream content, int chunk, long chunkSize) throws IOException, CloudHttpException
Uploads one chunk of a file's binary content.
uploadUrl
— The URL to upload to.content
— Binary content to be uploaded.chunkSize
— The size of the chunk to be uploaded.chunk
— Number of chunks to be uploaded, 1-based.chunkSize
— The size of the chunk being uploaded.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic HttpResponse postFileUpload(String uploadUrl, InputStream content, String contentType, long contentLength, String checksum) throws IOException, CloudHttpException
Upload a file's binary content.
uploadUrl
— The URL to upload to. Obtained via a call to CloudClient.getFileuploadIntent(String, String, Integer, String, boolean)content
— Binary content to be uploaded.contentType
— The file's media type, to be sent as Content-Type header during upload.contentLength
— The length of the file being uploaded.checksum
— SHA-256 checksum value of the file's binary contentIOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic HttpResponse deletePlaylist(String playlistUid) throws IOException, CloudHttpException
Deletes a playlist.
playlistUid
— UID pf the playlist to be deletedIOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic HttpResponse deletePlaylistItem(String playlistUid, String itemUid) throws IOException, CloudHttpException
Removes an item from a playlist.
playlistUid
— UID of the playlistitemUid
— UID of the item to be removedIOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic PlaylistDefinition getPlaylist(String uid) throws IOException, CloudHttpException
Retrieves a specific playlist.
uid
— UID of the playlist to be retrievedIOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic PlaylistDefinitions getPlaylists(String type, Integer page, Integer count, String sort) throws IOException, CloudHttpException
Retrieves all playlists for the current user.
type
— Playlist type. Valid values are music, image, video, and image-video. Set to Null for all types.page
— The page to return in a paginated response. Defaults to 1.count
— The maximum items to return. Defaults to 20, maximum value is 100.sort
— Sort order for folder response. Syntax is: {field}+{asc or desc}
. Valid values are: name, type, versionCreated, size, extension, album, artist, captureDate, compilation, contentType, creationDate, favorite, genre, height, modificationDate, priority, source, tags, title, timelineDate.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic HttpResponse getPlaylistItem(String playlistUid, String itemUid) throws IOException, CloudHttpException
Retrieves the binary content of a specific item from a playlist.
playlistUid
— UID of the playlistitemUid
— UID of the item in the playlist ot retrieveIOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic PlaylistItems getPlaylistItems(String playlistUid, Integer page, Integer count, String sort) throws IOException, CloudHttpException
Retrieves detailed metadata for all the items in a playlist such as: name, versionCreated, size, extension, album, artist, captureDate, contentType, creationDate, genre, height, priority, title, timelineDate.
playlistUid
— UID of the playlist to retrievepage
— The page to return in a paginated response. Defaults to 1.count
— The maximum items to return. Defaults to 20, maximum value is 100.sort
— Sort order for folder response. Syntax is: {field}+{asc or desc}
. Valid values are: name, type, versionCreated, size, extension, album, artist, captureDate, compilation, contentType, creationDate, favorite, genre, height, modificationDate, priority, source, tags, title, timelineDate.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic HttpResponse postPlaylist(String name, List<String> paths, PlaylistTypeType type) throws IOException, CloudHttpException
Creates a playlist. Playlist items are optional and may be added later.
name
— Readable name for the playlist. Does not need to be unique.paths
— List of paths to items to include in the playlisttype
— Playlist type. Valid values are music, image, video, and image-video.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic HttpResponse postPlaylist(String name, List<String> paths, String type) throws IOException, CloudHttpException
Creates a playlist. Playlist items are optional and may be added later.
name
— Readable name for the playlist. Does not need to be unique.paths
— List of paths to items to include in the playlist.type
— Playlist type. Valid values are music, image, video, and image-video.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic List<PlaylistDefinitionPath> postPlaylistItems(String playlistUid, List<String> paths) throws IOException, CloudHttpException
Adds items to a playlist.
playlistUid
— UID of the playlistpaths
— List of paths to items to be addedIOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic PlaylistDefinitionResponse putPlaylist(String playlistUid, String name, PlaylistTypeType type) throws IOException, CloudHttpException
Updates a playlist's name, without affecting its content.
playlistUid
— UID of the playlist (required)name
— New playlist's name (required)type
— Playlist type. Valid values are music, image, video, and image-video. Required value. (Required)IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic PlaylistDefinitionResponse putPlaylist(String playlistUid, String name, String type) throws IOException, CloudHttpException
Updates a playlist's name, without affecting its content.
playlistUid
— UID of the playlist (required)name
— New playlist's name (required)type
— Playlist type. Valid values are music, image, video, and image-video. Must reflect the playlist's current type. (Required)IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic PlaylistDefinitionResponse putPlaylistItems(String playlistUid, String name, List<String> paths, PlaylistTypeType type) throws IOException, CloudHttpException
Updates (replaces) the list of items in a playlist. If desired, this API can also be used to update playlist name and/or type.
playlistUid
— UID of the playlist (required)name
— Required. You can use it to update the name of the playlist.paths
— A list of paths for the items in the playlist. Replaces the playlist's current list of items. If null, all items will be removed from the playlist.type
— Playlist type. Valid values are music, image, video, and image-video. (Required)IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic PlaylistDefinitionResponse putPlaylistItems(String playlistUid, String name, List<String> paths, String type) throws IOException, CloudHttpException
Updates (replaces) the list of items in a playlist. If desired, this API can also be used to update playlist name or type.
playlistUid
— UID of the playlist (required)name
— Required. You can use it to update the name of the playlist.paths
— A list of paths for the items in the playlist. Replaces the playlist's current list of items. If null, all items will be removed from the playlist.type
— Playlist type. Valid values are music, image, video, and image-video. (Required)IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic void deleteShare(String shareUid) throws IOException, CloudHttpException
Deletes a share.
shareUid
— The UID of the share to delete.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic Shares getShares(String cursor, Date since, Date until, Integer count) throws IOException, CloudHttpException
Retrieves a list of shares for the current user.
Parameters:
cursor
— Optional. Used for pagination. When paginating, a prev and next cursor is included in the list of links in the response.since
— Optional. Only shares created after this date are returned.until
— Optional. Only shares created before this date are returned.count
— Optional. Max number of shares to include in the response. If more shares remain, a prev and next links are included in the response.Exceptions:
IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic Shares getShares(String cursor, String since, String until, Integer count) throws IOException, CloudHttpException
Retrieves a list of shares for the current user.
Parameters:
cursor
— Optional. Used for pagination. When paginating, a prev and next cursor is included in the list of links in the response.since
— Optional. Only shares created after this date are returned. Expected format is W3C: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
until
— Optional. Only shares created before this date are returned. Expected format is W3C: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
count
— Optional. Max number of shares to include in the response. If more shares remain, a prev and next links are included in the response.Exceptions:
IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic Share postShare(String name, List<ShareResource> resources, Long expiresIn) throws IOException, CloudHttpException
Creates a new share.
name
— The new share's name.resources
— A list of resources to include in the new share.expiresIn
— Length of time in seconds before the share expires.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic void deleteTags(String uri) throws IOException, CloudHttpException
Removes the tags from a file or folder.
uri
— URI of the file or folder obtained via a call to getFullview()
, getSearch()
, or getMetadata()
.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic String getTags(String path) throws IOException, CloudHttpException
Retreives the tag for a particular file or folder.
path
— Path of the file or folder.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic String setTags(String uri, String tag) throws IOException, CloudHttpException
Sets the tag for a file or folder. The tag is added to the file or folder's systemAttributes
, under the key tags, which allows to search for files or folders by tag using the getSearch()
method.
uri
— URI of the file or folder obtained via a call to getFullview()
, getSearch()
, or getMetadata()
.tag
— The tag to assign to the file or folder. Any previously assigned tag is removed.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic void deleteTrash(String virtualFolder) throws IOException, CloudHttpException
Permanently deletes all (virtually-deleted) files and folders that still reside in the trash can.
virtualFolder
— The virutal folder to clear the trash can for, such as VZMOBILE
.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic TrashCan getTrash(String virtualFolder, String sort, Integer page, Integer count, TrashFilterType filter, Boolean deep) throws IOException, CloudHttpException
Retrieves the contents of the user's trash can, containing any deleted files and folders.
virtualFolder
— The virutal folder to retrieve the trash can for, such as VZMOBILE
.sort
— Sort order for folder response. Syntax is: {field}+{asc or desc}
. Valid values are: name and creationDate.page
— Page number to return, for paginated responses. Default is 1.count
— Maximum number of items to return. Required if start is specified.filter
— Set to file or folder to limit the response to one of those types. Use the default (null) for both types.deep
— If true, response includes the deleted contents of deleted folders.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic void restore(List<String> paths) throws IOException, CloudHttpException
Restores deleted files and folders.
paths
— A list of paths (relative to the virutal folder) of files or folders to restore.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic VirtualFolderMetadata createVirtualFolder(String name) throws IOException, CloudHttpException
Creates a virtual folder.
name
— The name of the virtual folder to create.IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic void deleteVirtualFolder(String name, Boolean force) throws IOException, CloudHttpException
Removes a virtual folder.
NOTE: This method fails if the virtual folder contains files or folders. It also fails if the virtual folder contains deleted files or folders, unless the force parameter is set to true.
name
— URI of the file or folder. Obtained via a call to getFullview(), getSearch(), or getMetadata().force
— If set to:IOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responsepublic VirtualFolderMetadata renameVirtualFolder(String oldName, String newName) throws IOException, CloudHttpException
Renames a virtual folder.
oldName
— Current name of the virtual foldernewName
— New name to assign to the virtual folderIOException
— HTTP request failureCloudHttpException
— Unsuccessful HTTP responseCopyright © 2015-2017, Verizon and/or its Licensors. All rights reserved.