Class: SharedItems

SharedItems(client) → {void}

Simple manager for interacting with all 'Shared Item' endpoints and actions.

Constructor

new SharedItems(client) → {void}

Parameters:
Name Type Description
client BoxClient The Box API Client that is responsible for making calls to the API
Source:
Returns:
Type
void

Methods

get(url, passwordopt, optionsopt, callbackopt) → {Promise.<Object>}

Requests a Box item associated with a shared link. API Endpoint: '/shared_items' Method: GET
Parameters:
Name Type Attributes Description
url string Shared Link URL
password string <optional>
 Shared Link Password (null if no password)
options Object <optional>
 Additional options for the request. Can be left null in most cases.
callback function <optional>
 passed the shared item if it was successfully acquired
Source:
Returns:
A promise resolving to the shared item object
Type
Promise.<Object>

get(url, passwordopt, optionsopt, callbackopt) → {Promise.<Object>}

Requests a Box item associated with a shared link. API Endpoint: '/shared_items' Method: GET
Parameters:
Name Type Attributes Description
url string Shared Link URL
password string <optional>
 Shared Link Password (null if no password)
options Object <optional>
 Additional options for the request. Can be left null in most cases.
callback function <optional>
 passed the shared item if it was successfully acquired
Source:
Returns:
A promise resolving to the shared item object
Type
Promise.<Object>