Shares

Version 1.4 - Updated on 12/15/2016

Contents

 

 

getShares(requestObject)

Retrieves shares.

  • Parameters:
    • requestObject — Callbacks and parameters
    • requestObject.count — Items to include in a paginated response for folder requests. Required, if start is specified.
    • requestObject.cursor — Cursor in the pagination of the response. Returned in the response body as a link to next or prev page.
    • requestObject.filter — Returned shares. Currently this value can only be outbound (shared by the user).
    • requestObject.since — date and time, expressed in the W3C date and time format, after which messages are to be returned.
    • requestObject.until — Date and time, expressed in the W3C date and time format, until which messages are to be returned.
    • 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.

share(requestObject)

Creates a share for a file or a folder.

  • Parameters:
    • requestObject — Callbacks and parameters
    • requestObject.success — Callback function. Returns the response in the first argument.
    • requestObject.failure — Callback function. Returns the response in the first argument.
    • requestObject.expiresIn — Expiration of the validity of the shared link in seconds since the time of its creation. The default value equates to one day if no value is specified. If 0 is specified the share link does not expire.
    • requestObject.name — Name of the share
    • requestObject.resources — Array of resource request objects.
  • Returns: None — this function is asynchronoss and clients should use the callback functions.

unshare(requestObject)

Deletes a share for a file or folder.

  • Parameters:
    • requestObject — Callbacks and parameters.
    • requestObject.success — Callback function. Returns the response in the first argument.
    • requestObject.failure — Callback function. Returns the response in the first argument.
    • requestObject.shareUid — ID that identifies a share.
  • Returns: None — This function is asynchronoss and clients should use the callback functions.

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