twitter4j
Interface Status

All Superinterfaces:
java.lang.Comparable<Status>, java.io.Serializable, TwitterResponse
All Known Implementing Classes:
StatusJSONImpl

public interface Status
extends java.lang.Comparable<Status>, TwitterResponse, java.io.Serializable

A data interface representing one single status of a user.

Author:
Yusuke Yamamoto - yusuke at mac.com

Method Summary
 Annotations getAnnotations()
          Returns the annotations, or null if no annotations are associated with this status.
 java.lang.String[] getContributors()
          Returns an array of contributors, or null if no contributor is associated with this status.
 java.util.Date getCreatedAt()
          Return the created_at
 GeoLocation getGeoLocation()
          Returns The location that this tweet refers to if available.
 HashtagEntity[] getHashtagEntities()
          Returns an array if hashtag mentioned in the tweet, or null if no hashtag were mentioned.
 long getId()
          Returns the id of the status
 java.lang.String getInReplyToScreenName()
          Returns the in_reply_to_screen_name
 long getInReplyToStatusId()
          Returns the in_reply_tostatus_id
 long getInReplyToUserId()
          Returns the in_reply_user_id
 Place getPlace()
          Returns the place attached to this status
 long getRetweetCount()
          Returns the number of times this tweet has been retweeted, or -1 when the tweet was created before this feature was enabled.
 Status getRetweetedStatus()
           
 java.lang.String getSource()
          Returns the source
 java.lang.String getText()
          Returns the text of the status
 URLEntity[] getURLEntities()
          Returns an array if URLEntity mentioned in the tweet, or null if no URLs were mentioned.
 User getUser()
          Return the user associated with the status.
This can be null if the instance if from User.getStatus().
 UserMentionEntity[] getUserMentionEntities()
          Returns an array of user mentions in the tweet, or null if no users were mentioned.
 boolean isFavorited()
          Test if the status is favorited
 boolean isRetweet()
           
 boolean isRetweetedByMe()
          Returns true if the authenticating user has retweeted this tweet, or false when the tweet was created before this feature was enabled.
 boolean isTruncated()
          Test if the status is truncated
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface twitter4j.TwitterResponse
getRateLimitStatus
 

Method Detail

getCreatedAt

java.util.Date getCreatedAt()
Return the created_at

Returns:
created_at
Since:
Twitter4J 1.1.0

getId

long getId()
Returns the id of the status

Returns:
the id

getText

java.lang.String getText()
Returns the text of the status

Returns:
the text

getSource

java.lang.String getSource()
Returns the source

Returns:
the source
Since:
Twitter4J 1.0.4

isTruncated

boolean isTruncated()
Test if the status is truncated

Returns:
true if truncated
Since:
Twitter4J 1.0.4

getInReplyToStatusId

long getInReplyToStatusId()
Returns the in_reply_tostatus_id

Returns:
the in_reply_tostatus_id
Since:
Twitter4J 1.0.4

getInReplyToUserId

long getInReplyToUserId()
Returns the in_reply_user_id

Returns:
the in_reply_tostatus_id
Since:
Twitter4J 1.0.4

getInReplyToScreenName

java.lang.String getInReplyToScreenName()
Returns the in_reply_to_screen_name

Returns:
the in_in_reply_to_screen_name
Since:
Twitter4J 2.0.4

getGeoLocation

GeoLocation getGeoLocation()
Returns The location that this tweet refers to if available.

Returns:
returns The location that this tweet refers to if available (can be null)
Since:
Twitter4J 2.1.0

getPlace

Place getPlace()
Returns the place attached to this status

Returns:
The place attached to this status
Since:
Twitter4J 2.1.1

isFavorited

boolean isFavorited()
Test if the status is favorited

Returns:
true if favorited
Since:
Twitter4J 1.0.4

getUser

User getUser()
Return the user associated with the status.
This can be null if the instance if from User.getStatus().

Returns:
the user

isRetweet

boolean isRetweet()
Since:
Twitter4J 2.0.10

getRetweetedStatus

Status getRetweetedStatus()
Since:
Twitter4J 2.1.0

getContributors

java.lang.String[] getContributors()
Returns an array of contributors, or null if no contributor is associated with this status.

Since:
Twitter4J 2.1.2

getRetweetCount

long getRetweetCount()
Returns the number of times this tweet has been retweeted, or -1 when the tweet was created before this feature was enabled.

Returns:
the retweet count.

isRetweetedByMe

boolean isRetweetedByMe()
Returns true if the authenticating user has retweeted this tweet, or false when the tweet was created before this feature was enabled.

Returns:
whether the authenticating user has retweeted this tweet.
Since:
Twitter4J 2.1.4

getUserMentionEntities

UserMentionEntity[] getUserMentionEntities()
Returns an array of user mentions in the tweet, or null if no users were mentioned.

Returns:
An array of user mention entities in the tweet.
Since:
Twitter4J 2.1.9

getURLEntities

URLEntity[] getURLEntities()
Returns an array if URLEntity mentioned in the tweet, or null if no URLs were mentioned.

Returns:
An array of URLEntity mentioned in the tweet.
Since:
Twitter4J 2.1.9

getHashtagEntities

HashtagEntity[] getHashtagEntities()
Returns an array if hashtag mentioned in the tweet, or null if no hashtag were mentioned.

Returns:
An array of Hashtag mentioned in the tweet.
Since:
Twitter4J 2.1.9

getAnnotations

Annotations getAnnotations()
Returns the annotations, or null if no annotations are associated with this status.

Since:
Twitter4J 2.1.4