1. class
  2. Alorel
  3. Dropbox
  4. Options
  5. Builder
  6. LongpollOptions

LongpollOptions

class LongpollOptions extends Options

Options for the Longpoll operation

Traits

TimeoutTrait
A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some network infrastructure does not support long timeouts. The default for this field is 30.

Constants

DATETIME_FORMAT

A Dropbox-friendly timestamp wrapper

Methods

__construct( array $defaults = array())

Options constructor.

from Options
boolean
offsetExists( string $offset)

Whether a offset exists

from Options
mixed
offsetGet( string $offset)

Offset to retrieve

from Options
offsetSet( string $offset, mixed $value)

Offset to set

from Options
offsetUnset( string $offset)

Offset to unset

from Options
static  Options
merge( array $options)

Create an Options object from a combination of configuration arrays and other option objects

from Options
array
toArray()

Return the generated options

from Options
TimeoutTrait
setTimeout( int $timeout)

A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some network infrastructure does not support long timeouts. The default for this field is 30.

from TimeoutTrait

Details

in Options at line line 41
__construct( array $defaults = array())

Options constructor.

Parameters

array $defaults Default options

in Options at line line 56
boolean offsetExists( string $offset)

Whether a offset exists

Parameters

string $offset An offset to check for.

Return Value

boolean true on success or false on failure. The return value will be casted to boolean if non-boolean was returned.

See also

http://php.net/manual/en/arrayaccess.offsetexists.php

in Options at line line 70
mixed offsetGet( string $offset)

Offset to retrieve

Parameters

string $offset The offset to retrieve.

Return Value

mixed Can return all value types.

See also

http://php.net/manual/en/arrayaccess.offsetget.php

in Options at line line 83
offsetSet( string $offset, mixed $value)

Offset to set

Parameters

string $offset The offset to assign the value to.
mixed $value The value to set.

See also

http://php.net/manual/en/arrayaccess.offsetset.php

in Options at line line 95
offsetUnset( string $offset)

Offset to unset

Parameters

string $offset The offset to unset.

See also

http://php.net/manual/en/arrayaccess.offsetunset.php

in Options at line line 108
static Options merge( array $options)

Create an Options object from a combination of configuration arrays and other option objects

Parameters

array $options The items to merge

Return Value

Options

in Options at line line 128
array toArray()

Return the generated options

Return Value

array

in TimeoutTrait at line line 38
TimeoutTrait setTimeout( int $timeout)

A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some network infrastructure does not support long timeouts. The default for this field is 30.

Parameters

int $timeout The timeout

Return Value

TimeoutTrait