twitter4j.api
Interface StatusMethods

All Known Implementing Classes:

Twitter

public interface StatusMethods

Author:

Joern Huxhorn - jhuxhorn at googlemail.com

Method Summary

Status	destroyStatus(long statusId) Destroys the status specified by the required ID parameter. Usage note: The authenticating user must be the author of the specified status.
ResponseList<User>	getRetweetedBy(long statusId) Show user objects of up to 100 members who retweeted the status.
ResponseList<User>	getRetweetedBy(long statusId, Paging paging) Deprecated. use getRetweetedBy(long) instead.
IDs	getRetweetedByIDs(long statusId) Show user ids of up to 100 users who retweeted the status represented by id This method calls http://api.twitter.com/1/statuses/:id/retweeted_by/ids.format
IDs	getRetweetedByIDs(long statusId, Paging paging) Deprecated. use getRetweetedByIDs(long) instead.
ResponseList<Status>	getRetweets(long statusId) Returns up to 100 of the first retweets of a given tweet.
Status	retweetStatus(long statusId) Retweets a tweet.
Status	showStatus(long id) Returns a single status, specified by the id parameter below.
Status	updateStatus(StatusUpdate latestStatus) Updates the authenticating user's status.
Status	updateStatus(java.lang.String status) Updates the authenticating user's status.
Status	updateStatus(java.lang.String status, GeoLocation location) Deprecated. use updateStatus(StatusUpdate) instead.
Status	updateStatus(java.lang.String status, long inReplyToStatusId) Deprecated. use updateStatus(StatusUpdate) instead.
Status	updateStatus(java.lang.String status, long inReplyToStatusId, GeoLocation location) Deprecated. use updateStatus(StatusUpdate) instead.

Method Detail

showStatus

Status showStatus(long id)
                  throws TwitterException

Returns a single status, specified by the id parameter below. The status's author will be returned inline.
This method calls http://api.twitter.com/1/statuses/show

Parameters:

id - the numerical ID of the status you're trying to retrieve

Returns:

a single status

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.1

See Also:

GET statuses/show/:id | dev.twitter.com

updateStatus

Status updateStatus(java.lang.String status)
                    throws TwitterException

Updates the authenticating user's status. A status update with text identical to the authenticating user's text identical to the authenticating user's current status will be ignored to prevent duplicates.
This method calls http://api.twitter.com/1/statuses/update

Parameters:

status - the text of your status update

Returns:

the latest status

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.1

See Also:

POST statuses/update | dev.twitter.com

updateStatus

Status updateStatus(java.lang.String status,
                    GeoLocation location)
                    throws TwitterException

Deprecated. use updateStatus(StatusUpdate) instead.

Updates the authenticating user's status. A status update with text identical to the authenticating user's text identical to the authenticating user's current status will be ignored to prevent duplicates.
This method calls http://api.twitter.com/1/statuses/update

Parameters:

status - the text of your status update

location - The location that this tweet refers to.

Returns:

the latest status

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

POST statuses/update | dev.twitter.com

updateStatus

Status updateStatus(java.lang.String status,
                    long inReplyToStatusId)
                    throws TwitterException

Deprecated. use updateStatus(StatusUpdate) instead.

Updates the authenticating user's status. A status update with text identical to the authenticating user's text identical to the authenticating user's current status will be ignored to prevent duplicates.
This method calls http://api.twitter.com/1/statuses/update

Parameters:

status - the text of your status update

inReplyToStatusId - The ID of an existing status that the status to be posted is in reply to. This implicitly sets the in_reply_to_user_id attribute of the resulting status to the user ID of the message being replied to. Invalid/missing status IDs will be ignored.

Returns:

the latest status

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.1

See Also:

POST statuses/update | dev.twitter.com

updateStatus

Status updateStatus(java.lang.String status,
                    long inReplyToStatusId,
                    GeoLocation location)
                    throws TwitterException

Deprecated. use updateStatus(StatusUpdate) instead.

Updates the authenticating user's status. A status update with text identical to the authenticating user's text identical to the authenticating user's current status will be ignored to prevent duplicates.
This method calls http://api.twitter.com/1/statuses/update

Parameters:

status - the text of your status update

inReplyToStatusId - The ID of an existing status that the status to be posted is in reply to. This implicitly sets the in_reply_to_user_id attribute of the resulting status to the user ID of the message being replied to. Invalid/missing status IDs will be ignored.

location - The location that this tweet refers to.

Returns:

the latest status

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

POST statuses/update | dev.twitter.com

updateStatus

Status updateStatus(StatusUpdate latestStatus)
                    throws TwitterException

Updates the authenticating user's status. A status update with text identical to the authenticating user's text identical to the authenticating user's current status will be ignored to prevent duplicates.
This method calls http://api.twitter.com/1/statuses/update

Parameters:

latestStatus - the latest status to be updated.

Returns:

the latest status

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.1.1

See Also:

POST statuses/update | dev.twitter.com

destroyStatus

Status destroyStatus(long statusId)
                     throws TwitterException

Destroys the status specified by the required ID parameter.
Usage note: The authenticating user must be the author of the specified status.
This method calls http://api.twitter.com/1/statuses/destroy

Parameters:

statusId - The ID of the status to destroy.

Returns:

the deleted status

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

1.0.5

See Also:

POST statuses/destroy/:id | dev.twitter.com

retweetStatus

Status retweetStatus(long statusId)
                     throws TwitterException

Retweets a tweet. Returns the original tweet with retweet details embedded.
This method calls http://api.twitter.com/1/statuses/retweet

Parameters:

statusId - The ID of the status to retweet.

Returns:

the retweeted status

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

POST statuses/retweet/:id | dev.twitter.com

getRetweets

ResponseList<Status> getRetweets(long statusId)
                                 throws TwitterException

Returns up to 100 of the first retweets of a given tweet.
This method calls http://api.twitter.com/1/statuses/retweets

Parameters:

statusId - The numerical ID of the tweet you want the retweets of.

Returns:

the retweets of a given tweet

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.0.10

See Also:

Tweets Resources › statuses/retweets/:id

getRetweetedBy

ResponseList<User> getRetweetedBy(long statusId)
                                  throws TwitterException

Show user objects of up to 100 members who retweeted the status.
This method calls http://api.twitter.com/1/statuses/:id/retweeted_by

Parameters:

statusId - The ID of the status you want to get retweeters of

Returns:

the list of users who retweeted your status

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.1.3

See Also:

GET statuses/:id/retweeted_by | dev.twitter.com

getRetweetedBy

ResponseList<User> getRetweetedBy(long statusId,
                                  Paging paging)
                                  throws TwitterException

Deprecated. use getRetweetedBy(long) instead.

Show user objects of up to 100 members who retweeted the status.
This method calls http://api.twitter.com/1/statuses/:id/retweeted_by

Parameters:

statusId - The ID of the status you want to get retweeters of

paging - specify your paging requirements

Returns:

the list of users who retweeted your status

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.1.3

See Also:

GET statuses/:id/retweeted_by | dev.twitter.com

getRetweetedByIDs

IDs getRetweetedByIDs(long statusId)
                      throws TwitterException

Show user ids of up to 100 users who retweeted the status represented by id
This method calls http://api.twitter.com/1/statuses/:id/retweeted_by/ids.format

Parameters:

statusId - The ID of the status you want to get retweeters of

Returns:

IDs of users who retweeted the stats

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.1.3

See Also:

GET statuses/:id/retweeted_by/ids | dev.twitter.com

getRetweetedByIDs

IDs getRetweetedByIDs(long statusId,
                      Paging paging)
                      throws TwitterException

Deprecated. use getRetweetedByIDs(long) instead.

Show user ids of up to 100 users who retweeted the status.
This method calls http://api.twitter.com/1/statuses/:id/retweeted_by/ids.format

Parameters:

statusId - The ID of the status you want to get retweeters of

paging - specify your paging requirements

Returns:

IDs of users who retweeted the stats

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter4J 2.1.3

See Also:

GET statuses/:id/retweeted_by/ids | dev.twitter.com