PHP Class Hybrid_Providers_Pinterest

Inheritance: extends Hybrid_Provider_Model_OAuth2

Public Properties

Property	Type	Description
$scope

Method	Description
createUserBoard ( string $title, string $description = NULL ) : mixed	Creates a board for the authenticated user.
createUserPin ( string $username, string $board_name, string $note, string $img_type, string $image, string $link = NULL ) : mixed	Creates a pin for the authenticated user.
deleteUserBoard ( string $username, string $board_name ) : mixed	Deletes the specified board.
getUserBoard ( string $username, string $board_name ) : mixed	Returns specified board for the authenticated user.
getUserBoardPins ( string $username, string $board_name ) : mixed	Returns a list of pins on the board.
getUserBoards ( ) : mixed	Returns a list of the authenticated user's public boards.
getUserProfile ( )
initialize ( )
loginBegin ( )
loginFinish ( )

Creates a board for the authenticated user.

public createUserBoard ( string $title, string $description = NULL ) : mixed
$title	string	Board title
$description	string	Board description
return	mixed	Success: array with fields ID, url and name Query error: array with fields message, error code Other error: Null

Creates a pin for the authenticated user.

public createUserPin ( string $username, string $board_name, string $note, string $img_type, string $image, string $link = NULL ) : mixed
$username	string	User's display name.
$board_name	string	Board machine name.
$note	string	Pin's description.
$img_type	string	image: upload the image you want to pin using multipart form data. image_url: the link to the image that you want to pin. image_base64: the link of a base64 encoded image.
$image	string	Pin's image.
$link	string	URL the pin will link to when you click through.
return	mixed	Success: array with pin fields ID, note, url, link. Query error: array with fields message, error code. Other error: Null.

Deletes the specified board.

public deleteUserBoard ( string $username, string $board_name ) : mixed
$username	string	User's display name.
$board_name	string	Board machine name.
return	mixed	Success: array with succes field. Query error: array with fields message, error code. Other error: Null.

Returns specified board for the authenticated user.

public getUserBoard ( string $username, string $board_name ) : mixed
$username	string	User's display name.
$board_name	string	Board machine name.
return	mixed	Success: array with fields ID, url and name. Query error: array with fields message, error code. Other error: Null.

Returns a list of pins on the board.

public getUserBoardPins ( string $username, string $board_name ) : mixed
$username	string	User's display name.
$board_name	string	Board machine name.
return	mixed	Success: list with arrays including pin fields ID, url, link and description. Query error: array with fields message, error code. Other error: Null.

Returns a list of the authenticated user's public boards.

public getUserBoards ( ) : mixed
return	mixed	Success: list arrays with fields ID, url and name. Query error: array with fields message, error code. Other error: Null.

public getUserProfile ( )

public initialize ( )

public loginBegin ( )

public loginFinish ( )

public $scope