media.trashFile
Syntax
void media.trashFile (
mixed id,
boolean recursive = true )
Argument Info
Name | Type | Required | Default value | Description |
---|
id | mixed | Required | none | This can be a single media ID or an array of valid media IDs. |
recursive | boolean | Optional | true | This optional argument allows you to trash all recursive children of the specified media ID(s). For example this will trash the specified media ID along with all if its comments. Possible values are 0 => false and 1 => true. |
Response
The response returned upon success of the request.
Name | Type | Description | Default Values |
---|
result | INT | 1 will be returned upon a successful request and response. | 1 |
Return Values
Field | Description | Possible Values |
---|