1. class
  2. Alorel
  3. Dropbox
  4. Operation
  5. Files
  6. PermanentlyDelete

PermanentlyDelete

class PermanentlyDelete extends SingleArgumentRPCOperation

The permanently_delete operation

Constants

API_VERSION

Dropbox API version
HOST

The hostname for these requests

Methods

__construct( bool $async = null, string $accessToken = null)

Operation constructor.

from AbstractOperation
static 
setDefaultToken( string $token)

Sets the default token to use with the constructor

from AbstractOperation
boolean
isAsync()

Return whether we're operating in async mode

from AbstractOperation
AbstractOperation
setAsync( bool $async)

Sets the sync/async operation mode

from AbstractOperation
static 
setDefaultAsync( bool $async)

Sets the default $async value for the constructor

from AbstractOperation
PromiseInterface|ResponseInterface
raw( string $path)

Perform the operation, returning a promise or raw response object

from SingleArgumentRPCOperation

Details

in AbstractOperation at line line 82
__construct( bool $async = null, string $accessToken = null)

Operation constructor.

Parameters

bool $async Whether requests should be asynchronous
string $accessToken Our access token

Exceptions

NoTokenException If $accessToken is not provided and the {@link AbstractOperation::$defaultToken default token} hasn't been set via {@link AbstractOperation::setDefaultToken() setDefaultToken()}

in AbstractOperation at line line 102
final static setDefaultToken( string $token)

Sets the default token to use with the constructor

Parameters

string $token The token

in AbstractOperation at line line 122
boolean isAsync()

Return whether we're operating in async mode

Return Value

boolean

in AbstractOperation at line line 135
final AbstractOperation setAsync( bool $async)

Sets the sync/async operation mode

Parameters

bool $async true to perform operations in async mode, false to perform them in sync

Return Value

AbstractOperation

in AbstractOperation at line line 149
final static setDefaultAsync( bool $async)

Sets the default $async value for the constructor

Parameters

bool $async The default async value

in SingleArgumentRPCOperation at line line 50
PromiseInterface|ResponseInterface raw( string $path)

Perform the operation, returning a promise or raw response object

Parameters

string $path The path operate on

Return Value

PromiseInterface|ResponseInterface The promise interface if async is set to true and the request interface if it is set to false

Exceptions

ClientException