Skip to content

Latest commit

 

History

History
215 lines (156 loc) · 6.64 KB

README.md

File metadata and controls

215 lines (156 loc) · 6.64 KB
Raw

npm npm npm

Cordova Pinterest Plugin

Cordova plugin for Pinterest

Platforms

This plugin supports Android and iOS

Installation

cordova plugin add cordova-plugin-pinterest --variable APP_ID=YOUR_APP_ID

// or 

cordova plugin add https://github.com/zyramedia/cordova-plugin-pinterest --variable APP_ID=YOUR_APP_ID

Usage

You can access the plugins functions via the global variable cordova.plugins.Pinterest.

Example

function onSuccess(response) {
    console.log('Success, the response is: ', reponse);
}

function onError(errorMessage) {
    console.error('Error, the error message is: ', errorMessage);
}

var scopes = [
    cordova.plugins.Pinterest.SCOPES.READ_PUBLIC,
    cordova.plugins.Pinterest.SCOPES.WRITE_PUBLIC,
    cordova.plugins.Pinterest.SCOPES.READ_RELATIONSHIPS,
    cordova.plugins.Pinterest.SCOPES.WRITE_RELATIONSHIPS
];

// lets login first
cordova.plugins.Pinterest.login(scopes, onSuccess, onError);

// after logging in, we can perform any other function
// for the sake of a clean example, this code is here, but you should wait for the login function to succeed first
cordova.plugins.Pinterest.getMyPins(onSuccess, onError);

Methods

login

login(scopes, onSuccess, onError)
  • scopes: List of permissions to request. You can use cordova.plugins.Pinterest.SCOPES constants for convenience. Available permissions are: read_public, write_public, read_relationships, write_relationships.

Logs the user in. The response object will contain the user's profile data, as well as the access token (if you need to use it elsewhere, example: send it to your server and perform actions on behalf of the user).

getMe

getMe(onSuccess, onError, fields)
  • fields: (optional) Fields to retrieve, separated by commas. Defaults to all available fields.

Gets the authenticated user's profile.

getMyPins

getMyPins(onSuccess, onError, fields, limit)
  • fields: (optional) Fields to retrieve, separated by commas. Defaults to all available fields.
  • limit: (optional) Limit the number of items returned. Capped to 100. Defaults to 100.

Gets the authenticated user's Pins.

getMyBoards

getMyBoards(onSuccess, onError, fields, limit)
  • fields: (optional) Fields to retrieve, separated by commas. Defaults to all available fields.
  • limit: (optional) Limit the number of items returned. Capped to 100. Defaults to 100.

Get the authenticated user's boards.

getMyLikes

getMyLikes(onSuccess, onError, fields, limit)
  • fields: (optional) Fields to retrieve, separated by commas. Defaults to all available fields.
  • limit: (optional) Limit the number of items returned. Capped to 100. Defaults to 100.

Get the authenticated user's likes.

getMyFollowers

getMyFollowers(onSucccess, onError, fields, limit)
  • fields: (optional) Fields to retrieve, separated by commas. Defaults to all available fields.
  • limit: (optional) Limit the number of items returned. Capped to 100. Defaults to 100.

Get the authenticated user's followers.

getMyFollowedBoards

getMyFollowedBoards(onSuccess, onError, fields, limit)
  • fields: (optional) Fields to retrieve, separated by commas. Defaults to all available fields.
  • limit: (optional) Limit the number of items returned. Capped to 100. Defaults to 100.

Get the authenticated user's followed boards.

getMyFollowedInterests

getMyFollowedInterests(onSuccess, onError, fields, limit)
  • fields: (optional) Fields to retrieve, separated by commas. Defaults to all available fields.
  • limit: (optional) Limit the number of items returned. Capped to 100. Defaults to 100.

Get the authenticated user's followed interests.

getUser

getUser(username, onSuccess, onError, fields)
  • username: Username of the user
  • fields: (optional) Fields to retrieve, separated by commas. Defaults to all available fields.

Get a user's profile.

getBoard

getBoard(boardId, onSuccess, onError, fields)
  • boardId: The ID of the board
  • fields: (optional) Fields to retrieve, separated by commas. Defaults to all available fields.

Get a board's data.

getBoardPins

getBoardPins(boardId, onSuccess, onError, fields, limit)
  • boardId: The ID of the board
  • fields: (optional) Fields to retrieve, separated by commas. Defaults to all available fields.
  • limit: (optional) Limit the number of items returned. Capped to 100. Defaults to 100.

Get Pins of a specific board.

deleteBoard

deleteBoard(boardId, onSuccess, onError)
  • boardId: The ID of the board

Delete a board.

createBoard

createBoard(name, desc, onSuccess, onError)
  • name: Name of the board
  • desc: (optional) Description of the board

Create a new board for the authenticated user.

getPin

getPin(pinId, onSuccess, onError, fields)
  • pinId: The ID of the Pin
  • fields: (optional) Fields to retrieve, separated by commas. Defaults to all available fields.

Get a Pin by ID.

deletePin

deletePin(pinId, onSuccess, onError)
  • pinId: The ID of the Pin

Delete a Pin.

createPin

createPin(note, boardId, imageUrl, link, onSuccess, onError)
  • note: Note/Description of the Pin
  • boardId: Board ID to put the Pin under
  • imageUrl: URL of the image to share
  • link: (optional) Link to share

Create a Pin for the authenticated user.

Quirks

  • This plugin does not provide any pagination features. You are limited only to the latest 100 entries and you cannot fetch the next pages. This can be fixed but it will make this API more complicated. It can be added if demanded by many users.



Contribution

  • Having an issue? or looking for support? Open an issue and we will get you the help you need.
  • Got a new feature or a bug fix? Fork the repo, make your changes, and submit a pull request.

Support this project

If you find this project useful, please star the repo to let people know that it's reliable. Also, share it with friends and colleagues that might find this useful as well. Thank you 😄