Constructor
new Trash(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(optionsopt, callbackopt) → {Promise.<Object>}
Get items in the user's trash
API Endpoint: '/folders/trash/items'
Method: GET
Parameters:
| Name |
Type |
Attributes |
Description |
options |
Object
|
<optional>
|
Optional parameters, can be left null in most cases
Properties
| Name |
Type |
Attributes |
Description |
fields |
string
|
<optional>
|
Comma-delimited list of item fields to return |
|
callback |
function
|
<optional>
|
Passed the list of trashed items if successful, error otherwise |
- Source:
Returns:
A promise resolving to the collection of trashed items
-
Type
-
Promise.<Object>
get(optionsopt, callbackopt) → {Promise.<Object>}
Get items in the user's trash
API Endpoint: '/folders/trash/items'
Method: GET
Parameters:
| Name |
Type |
Attributes |
Description |
options |
Object
|
<optional>
|
Optional parameters, can be left null in most cases
Properties
| Name |
Type |
Attributes |
Description |
fields |
string
|
<optional>
|
Comma-delimited list of item fields to return |
|
callback |
function
|
<optional>
|
Passed the list of trashed items if successful, error otherwise |
- Source:
Returns:
A promise resolving to the collection of trashed items
-
Type
-
Promise.<Object>