media.trashFile

Syntax

void media.trashFile ( mixed id, boolean recursive = true )

Argument Info

NameTypeRequiredDefault valueDescription
idmixedRequirednoneThis can be a single media ID or an array of valid media IDs.
recursivebooleanOptionaltrueThis 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.

NameTypeDescriptionDefault Values
resultINT1 will be returned upon a successful request and response.1

Return Values

FieldDescriptionPossible Values