Favorites

Version 1.3 - Updated on 12/15/2016

Contents

favorite(requestObject)

Adds a file or folder to favorites.

  • Parameters:
    • requestObject — Callbacks and parameters.
    • requestObject.createVersion — If set to true, creates a new version of a file or folder. Default is false.
    • requestObject.uri — The URI value obtained from a call to GET /fullivew or GET /metadata.
    • requestObject.success — Callback function. Returns the response in the first argument.
    • requestObject.failure — Callback function. Returns the response in the first argument.
  • Returns: None — This function is asynchronoss. Clients should use callback functions.

getFavorites(requestObject)

Retrieves a list of favorites.

  • Parameters:
    • requestObject — Callbacks and parameters.
    • requestObject.virtualfolder — The virtual folder for which the favorites are to be retrieved.
    • requestObject.type — Used to restrict the search results. Possible values are:
      • file&folder (default)
      • file
      • folder
    • requestObject.filetype — The type of the favorite. Possible values are:
      • all (default)
      • documents1
      • image
      • music
      • video
    • requestObject.success — Callback function. Returns the response in the first argument.
    • requestObject.failure — Callback function. Returns the response in the first argument.
  • Returns: None — This function is asynchronoss. Clients should use callback functions.

unfavorite(requestObject)

Removes a file or folder from favorites.

  • Parameters:
    • requestObject — Callbacks and parameters.
    • requestObject.createVersion — If set to true, creates a new version of a file or folder. Default is false.
    • requestObject.uri — The URI value obtained from a call to GET /fullivew or GET /metadata.
    • requestObject.success — Callback function. Returns the response in the first argument.
    • requestObject.failure — Callback function. Returns the response in the first argument.
  • Returns: None — This function is asynchronoss. Clients should use callback functions.

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