twitter4j
Interface User

All Superinterfaces:

java.lang.Comparable<User>, java.io.Serializable, TwitterResponse

All Known Implementing Classes:

UserJSONImpl

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

A data interface representing Basic user information element

Author:

Yusuke Yamamoto - yusuke at mac.com

See Also:

REST API Documentation - Basic user information element

Method Summary

java.util.Date	getCreatedAt()
java.lang.String	getDescription() Returns the description of the user
int	getFavouritesCount()
int	getFollowersCount() Returns the number of followers
int	getFriendsCount()
int	getId() Returns the id of the user
java.lang.String	getLang() Returns the preferred language of the user
java.lang.String	getLocation() Returns the location of the user
java.lang.String	getName() Returns the name of the user
java.lang.String	getProfileBackgroundColor()
java.lang.String	getProfileBackgroundImageUrl()
java.net.URL	getProfileImageURL() Returns the profile image url of the user
java.lang.String	getProfileLinkColor()
java.lang.String	getProfileSidebarBorderColor()
java.lang.String	getProfileSidebarFillColor()
java.lang.String	getProfileTextColor()
java.lang.String	getScreenName() Returns the screen name of the user
Status	getStatus() Returns the current status of the user This can be null if the instance if from Status.getUser().
java.util.Date	getStatusCreatedAt() Deprecated. Use getStatus().getCreatedAt()
int	getStatusesCount()
long	getStatusId() Deprecated. Use getStatus().getId()
java.lang.String	getStatusInReplyToScreenName() Deprecated. Use getStatus().getInReplyToScreenName()
long	getStatusInReplyToStatusId() Deprecated. Use getStatus().getInReplyToStatusId()
int	getStatusInReplyToUserId() Deprecated. Use getStatus().getInReplyToUserId()
java.lang.String	getStatusSource() Deprecated. Use getStatus().getSource()
java.lang.String	getStatusText() Deprecated. Use getStatus().getText()
java.lang.String	getTimeZone()
java.net.URL	getURL() Returns the url of the user
int	getUtcOffset()
boolean	isContributorsEnabled() Tests if the user is enabling contributors
boolean	isGeoEnabled()
boolean	isProfileBackgroundTiled()
boolean	isProtected() Test if the user status is protected
boolean	isStatusFavorited() Deprecated. Use getStatus().isFavorited()
boolean	isStatusTruncated() Deprecated. Use getStatus().isTruncated()
boolean	isVerified()

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface twitter4j.TwitterResponse

getRateLimitStatus

Method Detail

getId

int getId()

Returns the id of the user

Returns:

the id of the user

getName

java.lang.String getName()

Returns the name of the user

Returns:

the name of the user

getScreenName

java.lang.String getScreenName()

Returns the screen name of the user

Returns:

the screen name of the user

getLocation

java.lang.String getLocation()

Returns the location of the user

Returns:

the location of the user

getDescription

java.lang.String getDescription()

Returns the description of the user

Returns:

the description of the user

isContributorsEnabled

boolean isContributorsEnabled()

Tests if the user is enabling contributors

Returns:

if the user is enabling contributors

Since:

Twitter4J 2.1.2

getProfileImageURL

java.net.URL getProfileImageURL()

Returns the profile image url of the user

Returns:

the profile image url of the user

getURL

java.net.URL getURL()

Returns the url of the user

Returns:

the url of the user

isProtected

boolean isProtected()

Test if the user status is protected

Returns:

true if the user status is protected

getFollowersCount

int getFollowersCount()

Returns the number of followers

Returns:

the number of followers

Since:

Twitter4J 1.0.4

getStatus

Status getStatus()

Returns the current status of the user
This can be null if the instance if from Status.getUser().

Returns:

current status of the user

Since:

Twitter4J 2.1.1

getStatusCreatedAt

java.util.Date getStatusCreatedAt()

Deprecated. Use getStatus().getCreatedAt()

Returns:

created_at or null if the user is protected

Since:

Twitter4J 1.1.0

getStatusId

long getStatusId()

Deprecated. Use getStatus().getId()

Returns:

status id or -1 if the user is protected

getStatusText

java.lang.String getStatusText()

Deprecated. Use getStatus().getText()

Returns:

status text or null if the user is protected

getStatusSource

java.lang.String getStatusSource()

Deprecated. Use getStatus().getSource()

Returns:

source or null if the user is protected

Since:

1.1.4

isStatusTruncated

boolean isStatusTruncated()

Deprecated. Use getStatus().isTruncated()

Returns:

truncated or false if the user is protected

Since:

1.1.4

getStatusInReplyToStatusId

long getStatusInReplyToStatusId()

Deprecated. Use getStatus().getInReplyToStatusId()

Returns:

in_reply_to_status_id or -1 if the user is protected

Since:

1.1.4

getStatusInReplyToUserId

int getStatusInReplyToUserId()

Deprecated. Use getStatus().getInReplyToUserId()

Returns:

in_reply_to_user_id or -1 if the user is protected

Since:

1.1.4

isStatusFavorited

boolean isStatusFavorited()

Deprecated. Use getStatus().isFavorited()

Returns:

favorited or false if the user is protected

Since:

1.1.4

getStatusInReplyToScreenName

java.lang.String getStatusInReplyToScreenName()

Deprecated. Use getStatus().getInReplyToScreenName()

Returns:

in_reply_to_screen_name or null if the user is protected

Since:

1.1.4

getProfileBackgroundColor

java.lang.String getProfileBackgroundColor()

getProfileTextColor

java.lang.String getProfileTextColor()

getProfileLinkColor

java.lang.String getProfileLinkColor()

getProfileSidebarFillColor

java.lang.String getProfileSidebarFillColor()

getProfileSidebarBorderColor

java.lang.String getProfileSidebarBorderColor()

getFriendsCount

int getFriendsCount()

getCreatedAt

java.util.Date getCreatedAt()

getFavouritesCount

int getFavouritesCount()

getUtcOffset

int getUtcOffset()

getTimeZone

java.lang.String getTimeZone()

getProfileBackgroundImageUrl

java.lang.String getProfileBackgroundImageUrl()

isProfileBackgroundTiled

boolean isProfileBackgroundTiled()

getLang

java.lang.String getLang()

Returns the preferred language of the user

Returns:

the preferred language of the user

Since:

Twitter4J 2.1.2

getStatusesCount

int getStatusesCount()

isGeoEnabled

boolean isGeoEnabled()

Returns:

the user is enabling geo location

Since:

Twitter4J 2.0.10

isVerified

boolean isVerified()

Returns:

returns true if the user is a verified celebrity

Since:

Twitter4J 2.0.10