Trash

Version 1.1 - Updated on 9/23/2016

Contents

• Trash
  • emptyTrash(requestObject)
  • getTrash(requestObject)
  • restore(requestObject)

emptyTrash(requestObject)

This function permanently deletes all paths marked as deleted.

• Parameters:
  • requestObject — Callbacks and parameters.
  • requestObject.success — Callback function. Returns the response in the first argument.
  • requestObject.virtualfolder — The virtual folder from which the deleted files and folders are to be permanently removed.
  • requestObject.failure — Callback function. Returns the response in the first argument.
• Returns: None — This function is asynchronoss. Clients should use callback functions.

getTrash(requestObject)

Retrieves a list of deleted files and folders.

• Parameters:
  • requestObject — Callbacks and parameters
  • requestObject.count — Number of items to include in a paginated response. Required, if start parameter is specified. Default is 20, maximum is 100.
  • requestObject.deep — If set to false, stops at the topmost deleted item. If set to true, lists all deleted content. Default is false.
  • requestObject.filter — If set to file, returns files in the response. If set to folder, returns folders in the response. If not set, returns both files and folders.
  • requestObject.sort — Sort order for a folder response. Syntax is: {field}+{asc or desc}. Valid values are:
    • name
    • type
    • versionCreated
    • size
    • extension
    • album
    • artist
    • captureDate
    • compilation
    • contentType
    • creationDate
    • favorite
    • genre
    • height
    • modificationDate
    • priority
    • source
    • tags
    • title
    • timelineDate
  • requestObject.start — Indicates which pages are to be returned in the response. Default is 1.
  • requestObject.virtualfolder — Name of the virtual folder for which the deleted files and folders are to be listed. Defaults to VZMOBILE.
  • 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.

restore(requestObject)

Restores deleted files and folders.

• Parameters:
  • requestObject — Callbacks and parameters
  • requestObject.path — Array of paths of deleted items that are to be restored.
  • 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.