class UploadSessionCursor extends AbstractParameter

Contains the upload session ID and the offset.

Methods

array
jsonSerialize()

Specify data which should be serialized to JSON

string
__toString()

A shorthand for JSON-encoding parameters

__construct( string $sessionID, int $offset)

UploadSessionCursor constructor.

setOffset( int $offset)

Sets the cursor offset

Details

in AbstractParameter at line line 64
array jsonSerialize()

Specify data which should be serialized to JSON

Return Value

array data which can be serialized by json_encode, which is a value of any type other than a resource.

See also

http://php.net/manual/en/jsonserializable.jsonserialize.php

in AbstractParameter at line line 75
string __toString()

A shorthand for JSON-encoding parameters

Return Value

string

at line line 27
__construct( string $sessionID, int $offset)

UploadSessionCursor constructor.

Parameters

string $sessionID The upload session ID (returned by upload_session/start).
int $offset The amount of data that has been uploaded so far. We use this to make sure upload data isn't lost or duplicated in the event of a network error.

at line line 43
UploadSessionCursor setOffset( int $offset)

Sets the cursor offset

Parameters

int $offset The offset

Return Value

UploadSessionCursor