Release date 01/12/2017
The following features are included in this release. Refer to the sections below for detailed listing of supported APIs.
| The SDK | Hubble Media Browser | Kepler File Manager |
|---|---|---|
| Authentication and authorization | Authentication and authorization | Authentication and authorization |
| Account information | Account information | Account information |
| Contacts1 | Contacts1 | |
| Favorites2 | Favorites2 | |
| File and folder operations | File and folder operations | File and folder operations |
| File upload | File upload | |
| Logger | ||
| Media | Media | Media |
| Playlists | Playlists | |
| Shares | Shares | |
| Tags | Tags | |
| Trash can | Trash can | |
| Virtual Folder | Virtual Folder |
1 Updated in this release to enable search
2 New in this release
The gateway to access Personal Cloud Storage APIs is the PCAPISDK class. Included in this class are most main methods that you can use to make the API calls.
Authentication and Authorization
authenticateClient - this API is used to present OAuth 2.0 login screen. Based on the response from OAuth 2.0 login, the completion handler returns either the authorization code or an error message. You can exchange the authorization code for an access token and a refresh token. The access token will remain in the keychain until it expires or the user logs out.fetchAccessToken - retrieves access token.isUserLoggedIn - returns YES if the user has an access tokenlogout - logs the user out from the current session. Removes the access token that is stored in keychain. Returns YES if the token is successfully removed.refreshSession - refreshes current session. Once the session has been refreshed, the authentication credentials are returned with the completion block.Account Information
fetchAccountInfo - retrieves account information for a user’s account.Contacts
fetchContacts - retrieves contacts.Favorites
deleteFavorites - deletes favorite tag.getFavorites - retrieves favorite files and folders.setFavorites - sets a favorite tag for a file or folder.File and Folder Operations
copy - creates a copy of a file or folder.createFolder - creates a folder at a given path.deletePath - deletes a file or a folder at a specified path.doFullSync - calls GET /fullview API to get changes from the server, then merges the changes with the local databasedownloadFile | Downloads a file. The file is downloaded to a temporary directory and is removed once the api which downloaded the file is released. You should move the file to a different location in the completion callback.downloadThumbnail - downloads thumbnail image of any file.fetchMetadata - retrieves the metadata of a folder.move - moves a file or folder.rename - renames a file or a folder.search - searches for any resource in local database.uploadFile - uploads a file to a folder.Logger
PCAPILogger class contains methods that allow you to start, stop, add, and delete log levels:
addLogger - adds a log.removeAllLogger - removes all logs.removeLogger - removes specified log.sharedLogger - returns shared logger instance.startLogging - starts all managed logs.stopLogging - stops all managed logs.Media
getArtists - retrieves artists.getAudioAlbums - retrieves audio albums.getAudioPlaylists - retrieves audio playlists.getAudios - retrieves audio files.getDocuments - retrieves documents.getGenres - retrieves genres.getPhotoAlbums - retrieves photo albums.getPhotos - retrieves image files.getVideos - retrieves video files.Playlists
addPlaylistItems - adds items to a playlist.createPlaylist - creates a playlist.deletePlaylist - deletes a playlists.deletePlaylistItem - deletes an item in a playlist.editPlaylistsDefinition - allows you to edit playlist definition.editPlaylist - allows you to edit a playlist.getPlaylist - retrieves a list of user’s playlists.getPlaylistContent - retrieves content of a playlist.getPlaylistDefinitioin - retrieves playlist definition.getPlaylistItems - retrieves the information on all items for a given playlist.Shares
createShare - creates a share.deleteShare - deletes a share.fetchShare - lists user’s shares.Tags
deleteTags - deletes tags for a specified file or folder.getTags - lists tags for a specified file or folder.setTags - updates tags for a specified file or folder.Trash Can
deleteTrash - permanently deletes all files and folder that are in a deleted state.fetchTrash - retrieves a list of files and folders that have been deleted.restore - restores files and folders that are marked as deleted.Virtual Folder
createVirtualFolder - creates a virutal folder.deleteVirtualFolder - deletes a virtual folder.renameVirtualFolder - renames a virtual folder.Main Classes
PCAPI - base class for all HTTP queries.PCAPIParams - checks validity of the parameters of each API.PCAPIQueryResponse - all PCAPIQuery responses are embedded in this format.PCAPISDK - acts as the interface between iOS SDK and a third party applications. Includes all main methods that you can use to make the API calls.Authentication and Authorization Classes
PCAccessTokenAPIParams - stores parameters required to call the GET /token API.PCAuthenticationResponse - stores access token and related credentials.PCAuthorizationAPIParams - stores parameters required to authorize a client.PCClientCredentials - stores client credentials.PCOAuthLoginPageResponse - stores the response recieved from the OAuth 2.0 login page.PCTokenAPIParams - stores base parameters of all token related APIs.Account Information Classes
PCAccountInfo - stores user account information.PCAccountInfoAPIParams - stores the parameters required to retrieve the account information.Contacts Classes
PCAddressType - stores details of an address.PCContact - stores details of a contact.PCContactAPIParams.md - stores parameters required to retrieve contacts.PCContactType - base class for email and telephone contact type.PCEmailContactType - stores details of email contact type.PCInstantMessageType -stores details of instant message type.PCTelContactType - stores details of telephone contact type.Favorites Classes
PCDeleteFavoritesAPIParams - stores the parameters required to unmark file or folder as favorite.PCGetFavoritesAPIParams - stores the parameters required to retrieve the list of favorite files or folders.PCSetFavoritesAPIParams - stores parameters required to mark the list of files or folders as favorites.File and Folder Operations Classes
PCCreateFolderAPIParams - stores parameters required to create a folder.PCDeleteParams - stores parameters required to delete a file or a folder.PCFilesAPIParams - stores parameters required to download a file.PCFOPSAPIParams - stores base parameters for all file and folder operations such as copy, rename, and move.PCMetadata - stores metadata information of a folder and the files and folders it contains.PCMetaDataAPIParams - stores additional parameters required to retrieve metadata of any resource.PCResource - stores the metadata information of a file or a folder.PCResourceAPIParams - stores common parameters required to retrieve a resource from Personal Cloud Storage.PCSearchAPIParams - stores parameters required to search for files or folders and performs parameter validation.PCThumbnailAPIParams - stores parameters required to retrieve a thumbnail of a file.PCUploadAPIParams - stores parameters required to upload a file.Logger Classes
PCAPIConsoleLogger - used to create instances of user-selected types of logs.PCAPILogger - used to start, stop, add and delete logs.Media Classes
PCAlbum - stores the album information of an audio file and a photo album.PCArtist - stores the artist information of an audio file.PCAudio - stores the metadata information for audio files.PCGenre - stores the Genre information of an audio file.PCFile - stores the metadata information of a file.PCFile+FileOperation - includes methods that allow you to download a file and a thumbnail of a file.PCPhoto - stores the metadata information of a photo.PCResourceItem - stores the metadata information of a ResourceItem, such as a file or a folderPCResourceItem+FOPSOperation - includes methods that allow you to perform copy, delete, move, and rename operations for all media types.PCVideo - stores the metadata information for video files.Playlists Classes
PCAddPlaylistItemsAPIParams - stores parameters required to add items to a playlist.PCCreateplaylistAPIParams - stores parameters required to create a playlist.PCDeletePlaylistAPIParams - stores parameters required to delete a playlist.PCDeletePlaylistItemAPIParams - stores parameters that allow a client to remove a single item from a playlist.PCEditPlaylistAPIParams - stores parameters required to edit a playlist.PCEditPlaylistDefinitionAPIParams - stores parameters required to edit the definition of a playlist.PCGetPlaylistAPIParams - stores parameters required to retrieve a playlist.PCGetPlaylistContentAPIParams - stores parameters required to fetch content of a playlist at the specified path.PCGetPlaylistDefinitionAPIParams - stores parameters required to retrieve a playlist definition.PCGetPlaylistItemsAPIParams - stores parameters required to retrieve items in a playlist.PCPlaylist - stores information about a playlist.PCPlaylistAPIParams - stores the base parameters of all playlist APIs.PCPlaylistItemAPIParams - base parameter class for all operations on an item in a playlist.Shares Classes
PCCreateShareAPIParams - stores the parameters required to create a share.PCDeleteShareAPIParams - stores the parameters required to delete a share.PCGetShareAPIParams - stores the parameters required to retrieve a share.PCLink - stores the definition of a link.PCResourceShareAPIParams - stores the parameters required for a resource to create a share.PCShare - stores information about share responses.PCShareItem - stores the defination of a Share.PCShareResource - stores the definition of a share resource.PCUser - stores the definition of a share user.Tags Classes
PCDeleteTagsAPIParams - stores parameters required to delete tags.PCGetTagsAPIParams - stores parameters required to retrieve tags.PCSetTagsAPIParams - stores parameters required to update tags.PCTags - stores the definition of a tag.Trash Can Classes
PCDeleteTrashAPIParams - stores parameters required to delete the files and folders that are in a deleted state.PCGetTrashAPIParams - stores parameters required to retrieve a list of files and folders that have been deleted.PCRestoreAPIParams - restores files or folders that are marked as deleted.Virtual Folder Classes
PCCreateVFolderAPIParams - stores parameters required to create a virtual folder.PCDeleteVFolderAPIParams - stores parameters required to delete a virtual folder.PCRenameVFolderAPIParams - stores parameters required to rename a virtual folder.All methods listed below are included in the PCAPISDK class.
Authentication and Authorization
authenticateClient - this API is used to present OAuth 2.0 login screen. Based on the response from OAuth 2.0 login, the completion handler returns either the authorization code or an error message. You can exchange the authorization code for an access token and a refresh token. The access token will remain in the keychain until it expires or the user logs out.logout - logs the user out from the current session. Removes the access token that is stored in keychain. Returns YES if the token is successfully removed.refreshSession - refreshes current session. Once the session has been refreshed, the authentication credentials are returned with the completion block.Account Information
fetchAccountInfo - retrieves account information for a user’s account.Contacts
fetchContacts - retrieves contacts.File and Folder Operations
doFullSync - refreshes the local cache of files. This API first calls GET /fullview API to get the changes from the server, then merges the changes with the local database.downloadFile - downloads a file. The file is downloaded to a temporary directory and is removed once the api which downloaded the file is released. You should move the file to a different location in the completion callback.downloadThumbnail - downloads thumbnail image of any file.search - searches for any resource in local database.Media
getArtists - retrieves artists.getAudioAlbums - retrieves audio albums.getAudioPlaylists - retrieves audio playlists.getAudios - retrieves audio files.getGenres - retrieves genres.getPhotoAlbum - retrieves photo albums.getPhotos - retrieves image files.getVideos - retrieves video files.Playlists
addPlaylistItems - adds items to a playlist.createPlaylist - creates a playlist.deletePlaylist - deletes a playlists.deletePlaylistItem - deletes an item in a playlist.editPlaylist - allows you to edit a playlist.getPlaylist - retrieves a list of user’s playlists.getPlaylistItems - retrieves the information on all items for a given playlist.Shares
createShare - creates a share.deleteShare - deletes a share.fetchShare - lists user’s shares.Tags
deleteTags - deletes tags for a specified file or folder.getTags - lists tags for a specified file or folder.setTags - updates tags for a specified file or folder.All methods listed below are included in the PCAPISDK class.
Authentication and Authorization
authenticateClient - this API is used to present OAuth 2.0 login screen. Based on the response from OAuth 2.0 login, the completion handler returns either the authorization code or an error message. You can exchange the authorization code for an access token and a refresh token. The access token will remain in the keychain until it expires or the user logs out.fetchAccessToken - retrieves access token.isUserLoggedIn - verifies if the user is authorized.logout - logs the user out from the current session. Removes the access token that is stored in keychain. Returns YES if the token is successfully removed.Account Information
fetchAccountInfo - retrieves account information for a user’s account.Favorites
deleteFavorites - deletes favorite tag.getFavorites - retrieves favorite files and folders.setFavorites - sets a favorite tag for a file or folder.File and Folder Operations
copy - creates a copy of a file or folder.createFolder - creates a folder at a given path.delete - deletes a file or a folder at a specified path.downloadFile - downloads a file. The file is downloaded to a temporary directory and is removed once the api which downloaded the file is released. You should move the file to a different location in the completion callback.downloadThumbnail - downloads thumbnail image of any file.fetchMetadata - retrieves the metadata of a folder.move - moves a file or folder.rename - renames a file or a folder.search - searches for any resource in local database.uploadFile - uploads a file to a folder.Media
getAudios - retrieves audio files.getDocuments - retrieves documents.getPhotos - retrieves image files.getVideos - retrieves vide files.Trash Can
deleteTrash - permanently deletes all files and folder that are in a deleted state.fetchTrash - retrieves a list of files and folders that have been deleted.restore restores files and folders that are marked as deleted.Virtual Folder
createVirtualFolder - creates a virutal folder.deleteVirtualFolder - deletes a virtual folder.renameVirtualFolder - renames a virtual folder.Copyright © 2015-2017, Verizon and/or its Licensors. All rights reserved.