Personal Cloud Storage SDK for JavaScript Version 1.2 Release Guide

Release date 9/23/2016

Contents

Introduction

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

The SDK JavaScript Kepler File Explorer
Authentication and authorization Authentication and authorization
Account information Account information
Contacts Contacts
File and folder operations File and folder operations
File upload File upload
Playlists Playlists
Shares* Shares*
Tags*
Trash* Trash*

* New in this release

Supported API Calls

The SDK

  • Authentication and Authorization

    • authorize - authenticates the user and authorizes the application to access user’s content through Verizon Personal Cloud Storage APIs.
    • getAuthorizeUrl - returns an authorization URL.
    • init - initializes the API with the Key, Secret, and callback URL that you specified in Key Management when you registered your app.
    • isAuthenticated - returns true when the user has completed OAuth 2.0 authentication process. Once this value is set, you may begin making API calls.
    • isInitted - helper method that a client can use to check if the SDK has been successfully initialized.
    • ready - ready handler you can use to execute code after init.
    • token - exchanges an authorization code obtained from a successful authorize call for access and refresh tokens.
  • Account Information

    • account - retrieves information about a user’s account usage.
  • Contacts

    • contacts - retrieves user’s contacts stroed in the cloud.
  • File and Folder Operations

    • createFolder - creates a folder.
    • copyFile - copies a file or a folder.
    • deleteFile - deletes a file or a folder.
    • download - downloads a file.
    • fullview - retrieves the information about all files and folders.
    • getDownloadUrl - retrieves a URL that can be used to download a file.
    • getThumbnailUrl - retrieves the URL of a thumbnail representing a file.
    • metadata - obtains metadata for files and folders in a user’s folder.
    • move - moves a file or a folder.
    • rename - renames a file or a folder.
    • search - search method used to find files or folders matching a query.
  • File Upload

    • commitChunkedUpload - used to finalize a chunked file upload.
    • fileuploadIntent - starts the upload process.
  • Playlists

    • addToPlaylist - adds one or more items to a playlist.
    • createPlaylist - creates a playlist.
    • deleteFromPlaylist - deletes an item from a playlist.
    • deletePlaylist - deletes a playlist.
    • getPlaylistContent - downloads a file stored inside a playlist.
    • playlist - retrieves a playlist.
    • playlistItems - retrieves playlist’s contents.
    • playlists - retrieves user’s playlists.
    • updatePlaylist - updates a playlist’s metadata.
    • updatePlaylistDefinition - updates playlist definition and content.
  • Shares

    • getShares - retrieves shares.
    • share - creates a share.
    • unshare - deletes a share.
  • Tags

    • getTags - retrieves tags.
    • deleteTags - deletes tags.
    • updateTags - updates tags.
  • Trash

    • emptyTrash - permanently deletes paths marked as deleted.
    • getTrash - retrieves a list of deleted files and folders.
    • restore - restores deleted files and folders.

JavaScript Kepler File Explorer

  • Authentication and Authorization

    • authorize - authenticates the user and authorizes the application to access user’s content through Verizon Personal Cloud Storage APIs.
    • init - initializes the API with the Key, Secret, and callback URL that you specified in Key Management when you registered your app.
    • isAuthenticated - returns true when the user has completed OAuth 2.0 authentication process. Once this value is set, you may begin making API calls.
    • isInitted - helper method that a client can use to check if the SDK has been successfully initialized.
    • ready - ready handler you can use to execute code after init.
    • token - exchanges an authorization code obtained from a successful authorize call for access and refresh tokens.
  • Account Information

    • account - retrieves information about a user’s account usage.
  • Contacts

    • contacts - retrieves user’s contacts stroed in the cloud.
  • File and Folder Operations

    • download - downloads a file.
    • fullview - retrieves the information about all files and folders.
    • getDownloadUrl - retrieves a URL that can be used to download a file.
    • metadata - obtains metadata for files and folders in a user’s folder.
  • File Upload

    • commitChunkedUpload - used to finalize a chunked file upload.
    • fileuploadIntent - starts the upload process.
  • Playlists

    • getPlaylistContent - downloads a file stored inside a playlist.
    • playlist - retrieves a playlist.
    • playlistItems - retrieves playlist’s contents.
    • playlists - retrieves user’s playlists.
  • Shares

    • getShares - retrieves shares.
    • share - creates a share.
    • unshare - deletes a share.
  • Trash

    • emptyTrash - permanently deletes paths marked as deleted.
    • getTrash - retrieves a list of deleted files and folders.
    • restore - restores deleted files and folders.

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