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()
           
 long getId()
          Returns the id of the user
 java.lang.String getLang()
          Returns the preferred language of the user
 int getListedCount()
          Returns the number of public lists the user is listed on, or -1 if the count is unavailable.
 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().
 int getStatusesCount()
           
 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 isFollowRequestSent()
          Returns true if the authenticating user has requested to follow this user, otherwise false.
 boolean isGeoEnabled()
           
 boolean isProfileBackgroundTiled()
           
 boolean isProfileUseBackgroundImage()
           
 boolean isProtected()
          Test if the user status is protected
 boolean isShowAllInlineMedia()
           
 boolean isTranslator()
           
 boolean isVerified()
           
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface twitter4j.TwitterResponse
getRateLimitStatus
 

Method Detail

getId

long 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

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()

isProfileUseBackgroundImage

boolean isProfileUseBackgroundImage()

isShowAllInlineMedia

boolean isShowAllInlineMedia()

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

isTranslator

boolean isTranslator()
Returns:
returns true if the user is a translator
Since:
Twitter4J 2.1.9

getListedCount

int getListedCount()
Returns the number of public lists the user is listed on, or -1 if the count is unavailable.

Returns:
the number of public lists the user is listed on.
Since:
Twitter4J 2.1.4

isFollowRequestSent

boolean isFollowRequestSent()
Returns true if the authenticating user has requested to follow this user, otherwise false.

Returns:
true if the authenticating user has requested to follow this user.
Since:
Twitter4J 2.1.4