Personal Cloud Storage SDK for PHP Version 1.6 Release Guide

Release date 02/14/2017

Contents

Introduction

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

The SDK PHP Kepler Cloud File Explorer
Authentication and authorization Authentication and authorization
Account information Account information
Contacts* Contacts*
Favorites Favorites
File and folder operations File and folder operations
File upload File upload
Playlists Playlists
Shares Shares
Tags Tags
Trash Trash
Virtual Folder Virtual Folder

* Contacts methods have been updated to allow you to create, update, and delete contacts.

Supported API calls

The following is a list of the API callsClass which are supported by te SDK and PHP Kepler Cloud File Explorer.

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

  • Authentication and Authorization

    • getAuthorize - helper function to create authorization URL.
    • getAuthorizeRedirection - redirects to the authorization URL.
    • getToken - retrieves new Access and Refresh tokens.
    • loggedIn - returns boolean value true if the user is logged on.
    • updateAccesToken - updates expired access token with new access token.

  • Account Information

    • getAccount - retrieves account information.

  • Contacts

    • createContacts - allows you to create a new contact.
    • deleteContact - allows you to delete a contact.
    • getContactInfo - retrieves contact information.
    • updateContact - allows you to update a contact.

  • Favorites

    • deleteFavorites - deletes favorites.
    • getFavorites - retrieves favorites.
    • setFavorites - adds to favorites.

  • File and Folder Operations

    • copy - creates a copy files or folders.
    • createFolder - creates a folder in the user’s Cloud Storage.
    • deleteData - deletes a file or a folder.
    • deltaView - retrieves a list of all files and folders changed after ETag.
    • getFileContent - retrieves file content.
    • getFullview - retrieves a list of all files and folders.
    • getMetadata - retrieves file or folder metadata.
    • getSearch - retrieves search results matching a query.
    • getThumbnail - retrieves thumbnail images of requested files.
    • move - moves files or folders.
    • rename - renames a file or a folder.
    • updateMetadata - updates metadata for a file or folder.

  • File Upload

    • commitUpload - commits file upload when chunk is set to true in fileUploadIntent function.
    • fileUploadIntent - initiates file upload.
    • uploadChunkData - completes file upload process if chunk is set to true.
    • uploadCompleteData - completes file upload process when chunk is set to false.

  • Playlists

    • addPlaylistItems - adds items to a playlist.
    • createPlaylist - creates a playlist.
    • deletePlaylist - deletes a playlist.
    • deletePlaylistItem - deletes an item from the playlist.
    • getPlaylistDefinition - retrieves definition and type of a playlist.
    • getPlaylistItemContent - retrieves information about an item in a play list.
    • getPlaylistItems - retrieves items in a playlist.
    • getPlaylists - retrieves a list of playlists.
    • updatePlaylist - sends a request to SDK and returns the result.
    • updatePlaylistDefinition - updates playlist definition.

  • Shares

    • createShare - creates a share.
    • deleteShare - deletes a share.
    • getShares - retrieves a list of shares.

  • Tags

    • deleteTags - deletes a tag.
    • getTags - retrieves a list of tags.
    • setTags - creates a tag.

  • Trash Can

    • purgeTrash - deletes items from trash.
    • restoreTrash - restores items from trash.
    • trash - deletes files and folders from user’s Cloud Storage Account.

  • Virtual Foldes

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

Classes

  • Middleware - sets the HTTP client handler
  • SDK - the main PHP SDK Personal Cloud Storage class

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