Facebook\FileUpload\FacebookResumableUploader Class Reference

Public Member Functions
	__construct (FacebookApp $app, FacebookClient $client, $accessToken, $graphVersion)
	start ($endpoint, FacebookFile $file)
	transfer ($endpoint, FacebookTransferChunk $chunk, $allowToThrow=false)
	finish ($endpoint, $uploadSessionId, $metadata=[])

Protected Attributes
	$app
	$accessToken
	$client
	$graphVersion

Detailed Description

Definition at line 39 of file FacebookResumableUploader.php.

Constructor & Destructor Documentation

__construct()

Facebook\FileUpload\FacebookResumableUploader::__construct	(	FacebookApp	$app,
		FacebookClient	$client,
			$accessToken,
			$graphVersion
	)

Parameters

FacebookApp	$app
FacebookClient	$client
AccessToken | string | null	$accessToken
string	$graphVersion

Definition at line 67 of file FacebookResumableUploader.php.

Member Function Documentation

finish()

Facebook\FileUpload\FacebookResumableUploader::finish	(		$endpoint,
			$uploadSessionId,
			$metadata = []
	)

Upload by chunks - finish phase

Parameters

string	$endpoint
string	$uploadSessionId
array	$metadata	The metadata associated with the file.

Returns

boolean

Exceptions

FacebookSDKException

Definition at line 142 of file FacebookResumableUploader.php.

start()

Facebook\FileUpload\FacebookResumableUploader::start	(		$endpoint,
		FacebookFile	$file
	)

Upload by chunks - start phase

Parameters

string	$endpoint
FacebookFile	$file

Returns

FacebookTransferChunk

Exceptions

FacebookSDKException

Definition at line 85 of file FacebookResumableUploader.php.

transfer()

Facebook\FileUpload\FacebookResumableUploader::transfer	(		$endpoint,
		FacebookTransferChunk	$chunk,
			$allowToThrow = false
	)

Upload by chunks - transfer phase

Parameters

string	$endpoint
FacebookTransferChunk	$chunk
boolean	$allowToThrow

Returns

FacebookTransferChunk

Exceptions

FacebookResponseException

Definition at line 107 of file FacebookResumableUploader.php.

Member Data Documentation

$accessToken

Facebook\FileUpload\FacebookResumableUploader::$accessToken

protected

Definition at line 49 of file FacebookResumableUploader.php.

$app

Facebook\FileUpload\FacebookResumableUploader::$app

protected

Definition at line 44 of file FacebookResumableUploader.php.

$client

Facebook\FileUpload\FacebookResumableUploader::$client

protected

Definition at line 54 of file FacebookResumableUploader.php.

$graphVersion

Facebook\FileUpload\FacebookResumableUploader::$graphVersion

protected

Definition at line 59 of file FacebookResumableUploader.php.

---

The documentation for this class was generated from the following file:

• plugins/facebook-php-sdk/src/Facebook/FileUpload/FacebookResumableUploader.php