com.twitter.sdk.android.core.models

Class Tweet

Object

com.twitter.sdk.android.core.models.Tweet

All Implemented Interfaces:

Identifiable

public class Tweet
extends Object
implements Identifiable

A Tweet is the basic atomic building block of all things Twitter. Tweets, also known more generically as "status updates." Tweets can be embedded, replied to, favorited, unfavorited and deleted.

Field Summary

Fields

Modifier and Type	Field and Description
Card	card Nullable.
Coordinates	coordinates Nullable.
String	createdAt UTC time when this Tweet was created.
Object	currentUserRetweet Perspectival.
List<Integer>	displayTextRange An array of two unicode code point indices, identifying the inclusive start and exclusive end of the displayable content of the Tweet.
TweetEntities	entities Entities which have been parsed out of the text of the Tweet.
TweetEntities	extendedEntities Additional entities such as multi photos, animated gifs and video.
Integer	favoriteCount Nullable.
boolean	favorited Nullable.
String	filterLevel Indicates the maximum value of the filter_level parameter which may be used and still stream this Tweet.
long	id The integer representation of the unique identifier for this Tweet.
String	idStr The string representation of the unique identifier for this Tweet.
String	inReplyToScreenName Nullable.
long	inReplyToStatusId Nullable.
String	inReplyToStatusIdStr Nullable.
long	inReplyToUserId Nullable.
String	inReplyToUserIdStr Nullable.
static long	INVALID_ID
String	lang Nullable.
Place	place Nullable.
boolean	possiblySensitive Nullable.
Tweet	quotedStatus This field only surfaces when the Tweet is a quote Tweet.
long	quotedStatusId This field only surfaces when the Tweet is a quote Tweet.
String	quotedStatusIdStr This field only surfaces when the Tweet is a quote Tweet.
int	retweetCount Number of times this Tweet has been retweeted.
boolean	retweeted Perspectival.
Tweet	retweetedStatus Users can amplify the broadcast of tweets authored by other users by retweeting.
Object	scopes A set of key-value pairs indicating the intended contextual delivery of the containing Tweet.
String	source Utility used to post the Tweet, as an HTML-formatted string.
String	text The actual UTF-8 text of the status update.
boolean	truncated Indicates whether the value of the text parameter was truncated, for example, as a result of a retweet exceeding the 140 character Tweet length.
User	user The user who posted this Tweet.
boolean	withheldCopyright When present and set to "true", it indicates that this piece of content has been withheld due to a DMCA complaint.
List<String>	withheldInCountries When present, indicates a list of uppercase two-letter country codes this content is withheld from.
String	withheldScope When present, indicates whether the content being withheld is the "status" or a "user."

Constructor Summary

Constructors

Constructor and Description

Tweet(Coordinates coordinates, String createdAt, Object currentUserRetweet, TweetEntities entities, TweetEntities extendedEntities, Integer favoriteCount, boolean favorited, String filterLevel, long id, String idStr, String inReplyToScreenName, long inReplyToStatusId, String inReplyToStatusIdStr, long inReplyToUserId, String inReplyToUserIdStr, String lang, Place place, boolean possiblySensitive, Object scopes, long quotedStatusId, String quotedStatusIdStr, Tweet quotedStatus, int retweetCount, boolean retweeted, Tweet retweetedStatus, String source, String text, List<Integer> displayTextRange, boolean truncated, User user, boolean withheldCopyright, List<String> withheldInCountries, String withheldScope, Card card)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
long	getId() Returns the id.
int	hashCode()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

INVALID_ID

public static final long INVALID_ID

See Also:

Constant Field Values

coordinates

public final Coordinates coordinates

Nullable. Represents the geographic location of this Tweet as reported by the user or client application. The inner coordinates array is formatted as geoJSON (longitude first, then latitude).

createdAt

public final String createdAt

UTC time when this Tweet was created.

currentUserRetweet

public final Object currentUserRetweet

Perspectival. Only surfaces on methods supporting the include_my_retweet parameter, when set to true. Details the Tweet ID of the user's own retweet (if existent) of this Tweet.

entities

public final TweetEntities entities

Entities which have been parsed out of the text of the Tweet.

extendedEntities

public final TweetEntities extendedEntities

Additional entities such as multi photos, animated gifs and video.

favoriteCount

public final Integer favoriteCount

Nullable. Indicates approximately how many times this Tweet has been "favorited" by Twitter users.

favorited

public final boolean favorited

Nullable. Perspectival. Indicates whether this Tweet has been favorited by the authenticating user.

filterLevel

public final String filterLevel

Indicates the maximum value of the filter_level parameter which may be used and still stream this Tweet. So a value of medium will be streamed on none, low, and medium streams.

id

public final long id

The integer representation of the unique identifier for this Tweet. This number is greater than 53 bits and some programming languages may have difficulty/silent defects in interpreting it. Using a signed 64 bit integer for storing this identifier is safe. Use id_str for fetching the identifier to stay on the safe side. See Twitter IDs, JSON and Snowflake.

idStr

public final String idStr

The string representation of the unique identifier for this Tweet. Implementations should use this rather than the large integer in id

inReplyToScreenName

public final String inReplyToScreenName

Nullable. If the represented Tweet is a reply, this field will contain the screen name of the original Tweet's author.

inReplyToStatusId

public final long inReplyToStatusId

Nullable. If the represented Tweet is a reply, this field will contain the integer representation of the original Tweet's ID.

inReplyToStatusIdStr

public final String inReplyToStatusIdStr

Nullable. If the represented Tweet is a reply, this field will contain the string representation of the original Tweet's ID.

inReplyToUserId

public final long inReplyToUserId

Nullable. If the represented Tweet is a reply, this field will contain the integer representation of the original Tweet's author ID. This will not necessarily always be the user directly mentioned in the Tweet.

inReplyToUserIdStr

public final String inReplyToUserIdStr

Nullable. If the represented Tweet is a reply, this field will contain the string representation of the original Tweet's author ID. This will not necessarily always be the user directly mentioned in the Tweet.

lang

public final String lang

Nullable. When present, indicates a BCP 47 language identifier corresponding to the machine-detected language of the Tweet text, or "und" if no language could be detected.

place

public final Place place

Nullable. When present, indicates that the tweet is associated (but not necessarily originating from) a Place.

possiblySensitive

public final boolean possiblySensitive

Nullable. This field only surfaces when a tweet contains a link. The meaning of the field doesn't pertain to the tweet content itself, but instead it is an indicator that the URL contained in the tweet may contain content or media identified as sensitive content.

scopes

public final Object scopes

A set of key-value pairs indicating the intended contextual delivery of the containing Tweet. Currently used by Twitter's Promoted Products.

quotedStatusId

public final long quotedStatusId

This field only surfaces when the Tweet is a quote Tweet. This field contains the integer value Tweet ID of the quoted Tweet.

quotedStatusIdStr

public final String quotedStatusIdStr

This field only surfaces when the Tweet is a quote Tweet. This is the string representation Tweet ID of the quoted Tweet.

quotedStatus

public final Tweet quotedStatus

This field only surfaces when the Tweet is a quote Tweet. This attribute contains the Tweet object of the original Tweet that was quoted.

retweetCount

public final int retweetCount

Number of times this Tweet has been retweeted. This field is no longer capped at 99 and will not turn into a String for "100+"

retweeted

public final boolean retweeted

Perspectival. Indicates whether this Tweet has been retweeted by the authenticating user.

retweetedStatus

public final Tweet retweetedStatus

Users can amplify the broadcast of tweets authored by other users by retweeting. Retweets can be distinguished from typical Tweets by the existence of a retweeted_status attribute. This attribute contains a representation of the original Tweet that was retweeted. Note that retweets of retweets do not show representations of the intermediary retweet, but only the original tweet. (Users can also unretweet a retweet they created by deleting their retweet.)

source

public final String source

Utility used to post the Tweet, as an HTML-formatted string. Tweets from the Twitter website have a source value of web.

text

public final String text

The actual UTF-8 text of the status update. See twitter-text for details on what is currently considered valid characters.

displayTextRange

public final List<Integer> displayTextRange

An array of two unicode code point indices, identifying the inclusive start and exclusive end of the displayable content of the Tweet.

truncated

public final boolean truncated

Indicates whether the value of the text parameter was truncated, for example, as a result of a retweet exceeding the 140 character Tweet length. Truncated text will end in ellipsis, like this ... Since Twitter now rejects long Tweets vs truncating them, the large majority of Tweets will have this set to false. Note that while native retweets may have their toplevel text property shortened, the original text will be available under the retweeted_status object and the truncated parameter will be set to the value of the original status (in most cases, false).

user

public final User user

The user who posted this Tweet. Perspectival attributes embedded within this object are unreliable. See Why are embedded objects stale or inaccurate?.

withheldCopyright

public final boolean withheldCopyright

When present and set to "true", it indicates that this piece of content has been withheld due to a DMCA complaint.

withheldInCountries

public final List<String> withheldInCountries

When present, indicates a list of uppercase two-letter country codes this content is withheld from. Twitter supports the following non-country values for this field: "XX" - Content is withheld in all countries "XY" - Content is withheld due to a DMCA request.

withheldScope

public final String withheldScope

When present, indicates whether the content being withheld is the "status" or a "user."

card

public final Card card

Nullable. Card data used to attach rich photos, videos and media experience to Tweets.

Constructor Detail

Tweet

public Tweet(Coordinates coordinates,
             String createdAt,
             Object currentUserRetweet,
             TweetEntities entities,
             TweetEntities extendedEntities,
             Integer favoriteCount,
             boolean favorited,
             String filterLevel,
             long id,
             String idStr,
             String inReplyToScreenName,
             long inReplyToStatusId,
             String inReplyToStatusIdStr,
             long inReplyToUserId,
             String inReplyToUserIdStr,
             String lang,
             Place place,
             boolean possiblySensitive,
             Object scopes,
             long quotedStatusId,
             String quotedStatusIdStr,
             Tweet quotedStatus,
             int retweetCount,
             boolean retweeted,
             Tweet retweetedStatus,
             String source,
             String text,
             List<Integer> displayTextRange,
             boolean truncated,
             User user,
             boolean withheldCopyright,
             List<String> withheldInCountries,
             String withheldScope,
             Card card)

Method Detail

getId

public long getId()

Description copied from interface: Identifiable

Returns the id.

Specified by:

getId in interface Identifiable

Returns:

The id.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object