Skip to content

A Twitter API client library for React Native. Currently not maintained as my main motivation of creating this library was to use the User Streams API.

License

Notifications You must be signed in to change notification settings

Piroro-hs/react-native-twitter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

react-native-twitter

A Twitter API client library for React Native

Installation

npm i react-native-twitter -S
react-native link

If you use 3-legged authorization, you need to add the deep link scheme for your callback URL. See React Native docs and example for more info.

Usage

import twitter, {auth} from 'react-native-twitter';

auth(tokens, callbackUrl[, options])

Get the client's authentication tokens via 3-legged authorization.

  • tokens

    • consumerKey Your consumer key
    • consumerSecret Your consumer secret
  • callbackUrl The URL a user is redirected to, you need to add the deep link scheme for this URL

  • options

  • Returns: Promise of {accessToken, accessTokenSecret, id, name}

    • accessToken Access token
    • accessTokenSecret Access token secret
    • id User id
    • name Screen name

auth(tokens, pinPromise[, options])

Get the client's authentication tokens via PIN-based authorization.

  • pinPromise Promise which resolves to PIN

  • Returns: Promise of {accessToken, accessTokenSecret, id, name}

const client = twitter(tokens)

Create a Twitter API client.

  • tokens
    • consumerKey Your consumer key
    • consumerSecret Your consumer secret
    • accessToken Access token
    • accessTokenSecret Access token secret
const {rest, stream} = twitter(tokens);

rest.get(path[, params])

Make GET requests.

  • path The endpoint path

  • params Parameters for the request

  • Returns: Promise

rest.post(path[, params])

Make POST requests.

  • path The endpoint path

  • params Parameters for the request

  • Returns: Promise

There is no File or Blob in React Native, but you can use Object with uri property as media files for media uploading endpoints such as account/update_profile_image. Below is an example of changing profile image to the latest photo from CameraRoll.

CameraRoll.getPhotos({first: 1})
  .then(({edges: [{node: {image}}]}) => rest.post('account/update_profile_image', {image}))
  .then(() => {console.log('done');})
  .catch(console.error);

stream(path, params) (Android only)

Connect to Streaming APIs.

  • path The endpoint path

  • params Parameters for the request

  • Returns: EventEmitter

    • 'data'
    • 'error'
    • close() Close the connection

About

A Twitter API client library for React Native. Currently not maintained as my main motivation of creating this library was to use the User Streams API.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published