Class RestClient
Defined in: RestClient.js.
Constructor Attributes | Constructor Name and Description |
---|---|
RestClient(consumerKey, consumerSecret, token, tokenSecret)
Creates an instance of RestClient.
|
Method Attributes | Method Name and Description |
---|---|
statusesDestroy(parameters, callback)
Destroys the status specified by the id parameter if it is owned by the authenticated user.
|
|
statusesHomeTimeline(parameters, callback)
Returns the 20 most recent tweets (including retweets), posted by the authenticated user and the user they follow.
|
|
statusesMentions(parameters, callback)
Retrieves the most recent mentions for the authenticated user.
|
|
statusesOEmbed(parameters, callback)
Retrieves information needed to embed a status on third party sites.
|
|
statusesPublicTimeline(parameters, callback)
Retrieves the most recent statuses, including retweets if they exist, from non-protected users.
|
|
statusesRetweet(parameters, callback)
Retweets the status associated with the specified id parameter.
|
|
statusesRetweetedBy(parameters, callback)
Retrieves the users who retweeted the status associated with the specified id parameter.
|
|
statusesRetweetedByIds(parameters, callback)
Retrieves the ids of the users who retweeted the status associated with the specified id parameter.
|
|
statusesRetweetedByMe(parameters, callback)
Retrieves the most recent statuses retweeted by the authenticated user.
|
|
statusesRetweetedByUser(parameters, callback)
Retrieves the most recent retweets posted by the specified user.
|
|
statusesRetweetedToMe(parameters, callback)
Retrieves the most recent retweets posted by users the authenticated user follows.
|
|
statusesRetweetedToUser(parameters, callback)
Retrieves the most recent retweets posted by users the specified user follows.
|
|
statusesRetweets(parameters, callback)
Retrieves the retweets of a given status.
|
|
statusesRetweetsOfMe(parameters, callback)
Returns recent tweets by the authenticated user that have been retweeted by others.
|
|
statusesShow(parameters, callback)
Retrieves the status associated with the specified id parameter.
|
|
statusesUpdate(parameters, callback)
Posts a new status for the authenticated user.
|
|
statusesUpdateWithMedia(parameters, callback)
Posts a new status for the authenticated user and attaches media for upload.
|
|
statusesUserTimeline(parameters, callback)
For information on acceptable parameters see the official Twitter documenation.
|
Class Detail
RestClient(consumerKey, consumerSecret, token, tokenSecret)
Creates an instance of RestClient.
- Parameters:
- {String} consumerKey
- OAuth consumer key.
- {String} consumerSecret
- OAuth consumer secret.
- {String} token
- OAuth token.
- {String} tokenSecret
- OAuth token secret.
Method Detail
statusesDestroy(parameters, callback)
Destroys the status specified by the id parameter if it is owned by the authenticated user.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesHomeTimeline(parameters, callback)
Returns the 20 most recent tweets (including retweets), posted by the authenticated user and the user they follow.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesMentions(parameters, callback)
Retrieves the most recent mentions for the authenticated user.
For information on acceptable parameters see the official Twitter documentation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesOEmbed(parameters, callback)
Retrieves information needed to embed a status on third party sites.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesPublicTimeline(parameters, callback)
Retrieves the most recent statuses, including retweets if they exist, from non-protected users.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesRetweet(parameters, callback)
Retweets the status associated with the specified id parameter.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesRetweetedBy(parameters, callback)
Retrieves the users who retweeted the status associated with the specified id parameter.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesRetweetedByIds(parameters, callback)
Retrieves the ids of the users who retweeted the status associated with the specified id parameter.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesRetweetedByMe(parameters, callback)
Retrieves the most recent statuses retweeted by the authenticated user.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesRetweetedByUser(parameters, callback)
Retrieves the most recent retweets posted by the specified user.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesRetweetedToMe(parameters, callback)
Retrieves the most recent retweets posted by users the authenticated user follows.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesRetweetedToUser(parameters, callback)
Retrieves the most recent retweets posted by users the specified user follows.
This method is identical to statusesRetweetedToMe except you can specify the user.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesRetweets(parameters, callback)
Retrieves the retweets of a given status.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesRetweetsOfMe(parameters, callback)
Returns recent tweets by the authenticated user that have been retweeted by others.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesShow(parameters, callback)
Retrieves the status associated with the specified id parameter.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesUpdate(parameters, callback)
Posts a new status for the authenticated user.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
- Returns:
- This method returns an integer.
statusesUpdateWithMedia(parameters, callback)
Posts a new status for the authenticated user and attaches media for upload.
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.
statusesUserTimeline(parameters, callback)
For information on acceptable parameters see the official Twitter documenation.
- Parameters:
- {Dictionary} parameters
- {Function} callback
- The callback function.