com.twitter.sdk.android.core.models

Class User

Object

com.twitter.sdk.android.core.models.User

All Implemented Interfaces:

Identifiable, Serializable

public class User
extends Object
implements Serializable, Identifiable

Users can be anyone or anything. They tweet, follow, create lists, have a home_timeline, can be mentioned, and can be looked up in bulk.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	contributorsEnabled Indicates that the user has an account with "contributor mode" enabled, allowing for Tweets issued by the user to be co-authored by another account.
String	createdAt The UTC datetime that the user account was created on Twitter.
boolean	defaultProfile When true, indicates that the user has not altered the theme or background of their user profile.
boolean	defaultProfileImage When true, indicates that the user has not uploaded their own avatar and a default egg avatar is used instead.
String	description Nullable.
String	email Nullable.
UserEntities	entities Entities which have been parsed out of the url or description fields defined by the user.
int	favouritesCount The number of tweets this user has favorited in the account's lifetime.
int	followersCount The number of followers this account currently has.
boolean	followRequestSent Nullable.
int	friendsCount The number of users this account is following (AKA their "followings").
boolean	geoEnabled When true, indicates that the user has enabled the possibility of geotagging their Tweets.
long	id The integer representation of the unique identifier for this User.
String	idStr The string representation of the unique identifier for this User.
static long	INVALID_ID
boolean	isTranslator When true, indicates that the user is a participant in Twitter's translator community.
String	lang The BCP 47 code for the user's self-declared user interface language.
int	listedCount The number of public lists that this user is a member of.
String	location Nullable.
String	name The name of the user, as they've defined it.
String	profileBackgroundColor The hexadecimal color chosen by the user for their background.
String	profileBackgroundImageUrl A HTTP-based URL pointing to the background image the user has uploaded for their profile.
String	profileBackgroundImageUrlHttps A HTTPS-based URL pointing to the background image the user has uploaded for their profile.
boolean	profileBackgroundTile When true, indicates that the user's profile_background_image_url should be tiled when displayed.
String	profileBannerUrl The HTTPS-based URL pointing to the standard web representation of the user's uploaded profile banner.
String	profileImageUrl A HTTP-based URL pointing to the user's avatar image.
String	profileImageUrlHttps A HTTPS-based URL pointing to the user's avatar image.
String	profileLinkColor The hexadecimal color the user has chosen to display links with in their Twitter UI.
String	profileSidebarBorderColor The hexadecimal color the user has chosen to display sidebar borders with in their Twitter UI.
String	profileSidebarFillColor The hexadecimal color the user has chosen to display sidebar backgrounds with in their Twitter UI.
String	profileTextColor The hexadecimal color the user has chosen to display text with in their Twitter UI.
boolean	profileUseBackgroundImage When true, indicates the user wants their uploaded background image to be used.
boolean	protectedUser When true, indicates that this user has chosen to protect their Tweets.
String	screenName The screen name, handle, or alias that this user identifies themselves with.
boolean	showAllInlineMedia Indicates that the user would like to see media inline.
Tweet	status Nullable.
int	statusesCount The number of tweets (including retweets) issued by the user.
String	timeZone Nullable.
String	url Nullable.
int	utcOffset Nullable.
boolean	verified When true, indicates that the user has a verified account.
List<String>	withheldInCountries When present, indicates a textual representation of the two-letter country codes this user 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

User(boolean contributorsEnabled, String createdAt, boolean defaultProfile, boolean defaultProfileImage, String description, String emailAddress, UserEntities entities, int favouritesCount, boolean followRequestSent, int followersCount, int friendsCount, boolean geoEnabled, long id, String idStr, boolean isTranslator, String lang, int listedCount, String location, String name, String profileBackgroundColor, String profileBackgroundImageUrl, String profileBackgroundImageUrlHttps, boolean profileBackgroundTile, String profileBannerUrl, String profileImageUrl, String profileImageUrlHttps, String profileLinkColor, String profileSidebarBorderColor, String profileSidebarFillColor, String profileTextColor, boolean profileUseBackgroundImage, boolean protectedUser, String screenName, boolean showAllInlineMedia, Tweet status, int statusesCount, String timeZone, String url, int utcOffset, boolean verified, List<String> withheldInCountries, String withheldScope)

Method Summary

Modifier and Type	Method and Description
long	getId() Returns the id.

Methods inherited from class Object

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

Field Detail

INVALID_ID

public static final long INVALID_ID

See Also:

Constant Field Values

contributorsEnabled

public final boolean contributorsEnabled

Indicates that the user has an account with "contributor mode" enabled, allowing for Tweets issued by the user to be co-authored by another account. Rarely true.

createdAt

public final String createdAt

The UTC datetime that the user account was created on Twitter.

defaultProfile

public final boolean defaultProfile

When true, indicates that the user has not altered the theme or background of their user profile.

defaultProfileImage

public final boolean defaultProfileImage

When true, indicates that the user has not uploaded their own avatar and a default egg avatar is used instead.

description

public final String description

Nullable. The user-defined UTF-8 string describing their account.

email

public final String email

Nullable. The logged in user email address if available. Must have permission to access email address.

entities

public final UserEntities entities

Entities which have been parsed out of the url or description fields defined by the user. Read more about User Entities.

favouritesCount

public final int favouritesCount

The number of tweets this user has favorited in the account's lifetime. British spelling used in the field name for historical reasons.

followRequestSent

public final boolean followRequestSent

Nullable. Perspectival. When true, indicates that the authenticating user has issued a follow request to this protected user account.

followersCount

public final int followersCount

The number of followers this account currently has. Under certain conditions of duress, this field will temporarily indicate "0."

friendsCount

public final int friendsCount

The number of users this account is following (AKA their "followings"). Under certain conditions of duress, this field will temporarily indicate "0."

geoEnabled

public final boolean geoEnabled

When true, indicates that the user has enabled the possibility of geotagging their Tweets. This field must be true for the current user to attach geographic data when using POST statuses / update.

id

public final long id

The integer representation of the unique identifier for this User. 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 User. Implementations should use this rather than the large, possibly un-consumable integer in id

isTranslator

public final boolean isTranslator

When true, indicates that the user is a participant in Twitter's translator community.

lang

public final String lang

The BCP 47 code for the user's self-declared user interface language. May or may not have anything to do with the content of their Tweets.

listedCount

public final int listedCount

The number of public lists that this user is a member of.

location

public final String location

Nullable. The user-defined location for this account's profile. Not necessarily a location nor parseable. This field will occasionally be fuzzily interpreted by the Search service.

name

public final String name

The name of the user, as they've defined it. Not necessarily a person's name. Typically capped at 20 characters, but subject to change.

profileBackgroundColor

public final String profileBackgroundColor

The hexadecimal color chosen by the user for their background.

profileBackgroundImageUrl

public final String profileBackgroundImageUrl

A HTTP-based URL pointing to the background image the user has uploaded for their profile.

profileBackgroundImageUrlHttps

public final String profileBackgroundImageUrlHttps

A HTTPS-based URL pointing to the background image the user has uploaded for their profile.

profileBackgroundTile

public final boolean profileBackgroundTile

When true, indicates that the user's profile_background_image_url should be tiled when displayed.

profileBannerUrl

public final String profileBannerUrl

The HTTPS-based URL pointing to the standard web representation of the user's uploaded profile banner. By adding a final path element of the URL, you can obtain different image sizes optimized for specific displays. In the future, an API method will be provided to serve these URLs so that you need not modify the original URL. For size variations, please see User Profile Images and Banners.

profileImageUrl

public final String profileImageUrl

A HTTP-based URL pointing to the user's avatar image. See User Profile Images and Banners.

profileImageUrlHttps

public final String profileImageUrlHttps

A HTTPS-based URL pointing to the user's avatar image.

profileLinkColor

public final String profileLinkColor

The hexadecimal color the user has chosen to display links with in their Twitter UI.

profileSidebarBorderColor

public final String profileSidebarBorderColor

The hexadecimal color the user has chosen to display sidebar borders with in their Twitter UI.

profileSidebarFillColor

public final String profileSidebarFillColor

The hexadecimal color the user has chosen to display sidebar backgrounds with in their Twitter UI.

profileTextColor

public final String profileTextColor

The hexadecimal color the user has chosen to display text with in their Twitter UI.

profileUseBackgroundImage

public final boolean profileUseBackgroundImage

When true, indicates the user wants their uploaded background image to be used.

protectedUser

public final boolean protectedUser

When true, indicates that this user has chosen to protect their Tweets. See About Public and Protected Tweets.

screenName

public final String screenName

The screen name, handle, or alias that this user identifies themselves with. screen_names are unique but subject to change. Use id_str as a user identifier whenever possible. Typically a maximum of 15 characters long, but some historical accounts may exist with longer names.

showAllInlineMedia

public final boolean showAllInlineMedia

Indicates that the user would like to see media inline. Somewhat disused.

status

public final Tweet status

Nullable. If possible, the user's most recent tweet or retweet. In some circumstances, this data cannot be provided and this field will be omitted, null, or empty. Perspectival attributes within tweets embedded within users cannot always be relied upon. See Why are embedded objects stale or inaccurate?.

statusesCount

public final int statusesCount

The number of tweets (including retweets) issued by the user.

timeZone

public final String timeZone

Nullable. A string describing the Time Zone this user declares themselves within.

url

public final String url

Nullable. A URL provided by the user in association with their profile.

utcOffset

public final int utcOffset

Nullable. The offset from GMT/UTC in seconds.

verified

public final boolean verified

When true, indicates that the user has a verified account. See Verified Accounts.

withheldInCountries

public final List<String> withheldInCountries

When present, indicates a textual representation of the two-letter country codes this user is withheld from.

withheldScope

public final String withheldScope

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

Constructor Detail

User

public User(boolean contributorsEnabled,
            String createdAt,
            boolean defaultProfile,
            boolean defaultProfileImage,
            String description,
            String emailAddress,
            UserEntities entities,
            int favouritesCount,
            boolean followRequestSent,
            int followersCount,
            int friendsCount,
            boolean geoEnabled,
            long id,
            String idStr,
            boolean isTranslator,
            String lang,
            int listedCount,
            String location,
            String name,
            String profileBackgroundColor,
            String profileBackgroundImageUrl,
            String profileBackgroundImageUrlHttps,
            boolean profileBackgroundTile,
            String profileBannerUrl,
            String profileImageUrl,
            String profileImageUrlHttps,
            String profileLinkColor,
            String profileSidebarBorderColor,
            String profileSidebarFillColor,
            String profileTextColor,
            boolean profileUseBackgroundImage,
            boolean protectedUser,
            String screenName,
            boolean showAllInlineMedia,
            Tweet status,
            int statusesCount,
            String timeZone,
            String url,
            int utcOffset,
            boolean verified,
            List<String> withheldInCountries,
            String withheldScope)

Method Detail

getId

public long getId()

Description copied from interface: Identifiable

Returns the id.

Specified by:

getId in interface Identifiable

Returns:

The id.