Personal Cloud Storage SDK for Android Version 1.8 Release Guide

Release date 01/12/2017

Contents

• Personal Cloud Storage SDK for Android Version 1.8 Release Guide
  • Introduction
  • The SDK
    • Supported API Calls
    • Classes
    • Interfaces
    • Exceptions
    • Enums
  • Hubble Media Browser
    • Supported API Calls
  • Kepler File Manager
    • Supported API Calls

Introduction

The following features are included in this release. Refer to the sections below for detailed listing of supported APIs.

^* Updated in this release to enable contacts search.

The SDK

Supported API Calls

The gateway to access Personal Cloud Storage APIs is the CloudAPI class. Included in this class are all main methods that you can use to make the API calls.

• Authentication and Authorization
  • authorize - authenticates the user and authorizes the application to access user’s cloud content through Verizon Personal Cloud Storage APIs.
  • getAccessToken - allow you to retrieve the access token.
  • hasAuthorization - verifies if the user is authorized.
  • logout - logs the user out from the current session.
• Account Information
  • getAccountInfo - retrieves the information about user’s cloud account.
• Contacts
  • getContacts - retrieves the contacts information stored under user’s cloud storage account.
    
• Favorites
  • deleteFavorite - deletes favorites.
  • getFavorites - retrieves favorites.
  • setFavorites - adds to favorites.
• File and Folder Operations
  • DELETE /fops/delete - deletes a file or a folder at a specified path.
  • POST /fops/copy -creates a copy of a file or folder.
  • POST /fops/createfolder - creates a folder at a given path.
  • POST /fops/move - moves a file or folder.
  • POST /fops/rename - renames a file or a folder.
  • downloadFile - retrieves the binary content of a file.
  • getMetadata - obtains metadata for files and folders in a user’s folder.
  • getThumbnail - retrieves the thumbnail for a file stored under user’s cloud storage account.
  • search - searches for files of folders. The SDK supports both Lucene and SQL query syntax.
  • uploadFile - uploads a file to user’s Verizon Personal Cloud Storage account.

• Log

  • setLogLevel - sets log level.

• Playlists

  • addToPlaylist - adds items to an existing playlist.
  • createPlaylist - creates a playlist.
  • deletePlaylist - deletes an existing playlist.
  • deletePlaylistItem - deletes an item from a playlist.
  • updatePlaylist - updates a playlist’s name.
  • updatePlaylistDefinition - updates current playlist definition.

• Shares

  • createShare - creates a share.
  • deleteShare - deletes a share.
  • getShares - lists user’s shares.
    

• Tags

  • deleteTags - deletes tags.
  • getTags - retrieves tags.
  • setTags - updates tags.

• Trash Can

  • getTrash - retrieves a list of files and folders that have been deleted.
  • purgeTrash - purges all the files and folder that are in a deleted state.
  • restoreTrash - restores files and folders from trash to their original location.

• Virtual Folder

  • createVirtualFolder - creates a virtual folder.
  • renameVirtualFolder - renames a virtual folder.
  • deleteVirtualFolder - deletes a virtual folder.

Classes

• CloudAPI - gateway to access Personal Cloud Storage APIs. Included in this class are all main methods that you can use to make the API calls.
• ShareResource - stores details of a share resource.

Interfaces

• AccountInformation - class structure for account info response.
• Address - stores address information.
• Album - stores album information.
• Artist - stores artist information.
• Audio - stores information about audio files.
• Contact - stores contact information.
• Email - stores email information.
• File - stores information about a file.
• FullviewItem - stores fullview list item
• Genre - stores genre information.
• IM - stores IM information.
• ItemList - stores details about a list of Item objects.
• MetadataItem - stores metadataItem list item.
• Phone - stores phone numbers information.
• Photo - stores information about an image file.
• Playlist - stores playlist item
• PlaylistFileAttributes - stores playlist file attributes.
• PlaylistItem - stores playlist item.
• ResourceItem - resource item for common attributes.
• SearchCallback - stores search results.
• Share - stores information about a share.
• SystemAttributes - stores system attributes item.
• Video - stores information about a video file.
• ViewUid - stores view Uid item.
• VirtualFolder - stores information about Virtual Folder.
• WebPage - stores Email information.

Exceptions

• CloudAPIException - general exception class forwarded to the view layer informing the user of abnormal runtime behavior.
• SearchException - generic exception class for all exceptions thrown from inside Search aAPI call.

Enums

• LogLevel - log level
• PlaylistType - playlist type
• ResourceType - resource type
• SortType - sort types
• ThumbnailSize - thumbnail size

Hubble Media Browser

The gateway to access Personal Cloud Storage APIs is the CloudAPI class. Included in this class are all main methods that you can use to make the API calls.

Supported API Calls

• Authentication and Authorization
  • authorize - authenticates the user and authorizes the application to access user’s cloud content through Verizon Personal Cloud Storage APIs.
  • hasAuthorization - verifies if the user is authorized.
  • logout - logs the user out from the current session.
• Account Information
  • getAccountInfo - retrieves the information about user’s cloud account.
• Contacts
  • getContacts - retrieves the contacts information stored under user’s cloud storage account.
    
• Favorites
  • deleteFavorite - deletes favorites.
  • getFavorites - retrieves favorites.
  • setFavorites - adds to favorites.
• File and Folder Operations
  • downloadFile - retrieves the binary content of a file.
  • getThumbnail - retrieves the thumbnail for a file stored under user’s cloud storage account.
  • fullview - retrieves the information about all files and folders.
  • search - searches for files of folders. The SDK supports both Lucene and SQL query syntax.
  • uploadFile - uploads a file to user’s Verizon Personal Cloud Storage account.
• Log
  • setLogLevel - sets log level.
• Playlists
  • addToPlaylist - adds items to an existing playlist.
  • createPlaylist - creates a playlist.
  • deletePlaylist - deletes an existing playlist.
  • deletePlaylistItem - deletes an item from a playlist.
  • updatePlaylist - updates a playlist’s name.
  • updatePlaylistDefinition - updates current playlist definition.
• Shares
  • createShare - creates a share.
  • deleteShare - deletes a share.
  • getShares - lists user’s shares.
• Tags
  • deleteTags - deletes tags.
  • getTags - retrieves tags.
  • setTags - updates tags.

Kepler File Manager

Supported API Calls

The gateway to access Personal Cloud Storage APIs is the CloudAPI class. Included in this class are all main methods that you can use to make the API calls.

• Authentication and Authorization
  • authorize - authenticates the user and authorizes the application to access user’s cloud content through Verizon Personal Cloud Storage APIs.
  • hasAuthorization - verifies if the user is authorized.
  • logout - logs the user out from the current session.
• Account Information
  • getAccountInfo - retrieves the information about user’s cloud account.
• File and Folder Operations
  • DELETE /fops/delete - deletes a file or a folder at a specified path.
  • POST /fops/copy - creates a copy of a file or folder.
  • POST /fops/createfolder - creates a folder at a given path.
  • POST /fops/move - moves a file or folder.
  • POST /fops/rename - renames a file or a folder.
  • downloadFile - retrieves the binary content of a file.
  • getMetadata - obtains metadata for files and folders in a user’s folder.
  • getThumbnail - retrieves the thumbnail for a file stored under user’s cloud storage account.
  • search - searches for files of folders. The SDK supports both Lucene and SQL query syntax.
  • uploadFile - uploads a file to user’s Verizon Personal Cloud Storage account.
    
• Trash Can
  • getTrash - retrieves a list of files and folders that have been deleted.
  • purgeTrash - purges all the files and folder that are in a deleted state.
  • restoreTrash - restores files and folders from trash to their original location.
• Virtual Folder
  • createVirtualFolder - creates a virtual folder.
  • renameVirtualFolder - renames a virtual folder.
  • deleteVirtualFolder - deletes a virtual folder.

Copyright © 2015-2017, Verizon and/or its Licensors. All rights reserved.