Package com.restfb.types

Class User

java.lang.Object
com.restfb.types.AbstractFacebookType
com.restfb.types.FacebookType
com.restfb.types.NamedFacebookType
com.restfb.types.User
All Implemented Interfaces:
HasCover, HasProfilePicture, Serializable
public class User extends NamedFacebookType implements HasProfilePicture, HasCover
Represents the User Graph API type.
Since:
1.5
Author:
Mark Allen, Patrick Alberts
See Also:
Serialized Form

  • Constructor Details

    • User

      public User()

  • Method Details

    • getBirthdayAsDate

      public Date getBirthdayAsDate()
      The user's birthday, typed to java.util.Date if possible.
      Returns:
      The user's birthday, or null if unavailable or only available in month/year format.

    • jsonMappingCompleted

      protected void jsonMappingCompleted​(JsonMapper jsonMapper)

    • getHometownName

      public String getHometownName()
      The user's hometown name.
      Returns:
      The user's hometown name.

    • getIdsForApps

      public List<UserIDForApp> getIdsForApps()
      Businesses can claim ownership of multiple apps using Business Manager. This method returns the list of IDs that this user has in any of those other apps
      Returns:
      list of ids a user has in other apps

    • addIdsForApps

      public boolean addIdsForApps​(UserIDForApp userId)

    • removeIdsForApps

      public boolean removeIdsForApps​(UserIDForApp userId)

    • getIdsForBusiness

      public List<UserIDForApp> getIdsForBusiness()
      Businesses can claim ownership of multiple apps using Business Manager. This edge returns the list of IDs that this user has in any of those other apps
      Returns:
      list of ids a user has in other apps

    • addIdsForBusiness

      public boolean addIdsForBusiness​(UserIDForApp userId)

    • removeIdsForBusiness

      public boolean removeIdsForBusiness​(UserIDForApp userId)

    • getIdsForPages

      public List<UserIDForPage> getIdsForPages()
      Businesses can claim ownership of apps and pages using Business Manager. This edge returns the list of IDs that this user has in any of the pages owned by this business.
      Returns:
      list of ids a user has in other pages

    • addIdsForPages

      public boolean addIdsForPages​(UserIDForPage userId)

    • removeIdsForPages

      public boolean removeIdsForPages​(UserIDForPage userId)

    • getInterestedIn

      @Deprecated public List<String> getInterestedIn()
      Deprecated.
      since breaking change on 4 April, 2018
      The genders the user is interested in.
      Returns:
      The genders the user is interested in.

    • addInterestedIn

      @Deprecated public boolean addInterestedIn​(String gender)
      Deprecated.
      since breaking change on 4 April, 2018
      Add a gender the user is interested in.
      Parameters:
      gender - the gender that should be added
      Returns:
      true if the gender could be added

    • removeInterestedIn

      @Deprecated public boolean removeInterestedIn​(String gender)
      Deprecated.
      since breaking change on 4 April, 2018
      Remove a gender the user is interested in.
      Parameters:
      gender - the gender that should be removed
      Returns:
      true if the gender could be removed

    • getMeetingFor

      public List<String> getMeetingFor()
      What genders the user is interested in meeting.
      Returns:
      What genders the user is interested in meeting.

    • addMeetingFor

      public boolean addMeetingFor​(String gender)

    • removeMeetingFor

      public boolean removeMeetingFor​(String gender)

    • getWork

      @Deprecated public List<WorkExperience> getWork()
      Deprecated.
      since breaking change on 4 April, 2018
      A list of the work history from the user's profile.
      Returns:
      A list of the work history from the user's profile.

    • addWork

      @Deprecated public boolean addWork​(WorkExperience workHistoryItem)
      Deprecated.
      since breaking change on 4 April, 2018
      Adds the WorkExperience from the work experience list
      Parameters:
      workHistoryItem - the WorkExperience that should be added
      Returns:
      true if the WorkExperience could be added

    • removeWork

      @Deprecated public boolean removeWork​(WorkExperience workHistoryItem)
      Deprecated.
      since breaking change on 4 April, 2018
      Removes the WorkExperience from the work experience list
      Parameters:
      workHistoryItem - the WorkExperience that should be removed
      Returns:
      true if the WorkExperience could be removed

    • getDevices

      public List<User.UserDevice> getDevices()
      The list of devices the person is using. This will return only iOS and Android devices
      Returns:
      The list of devices the person is using.

    • addDevice

      public boolean addDevice​(User.UserDevice device)

    • removeDevice

      public boolean removeDevice​(User.UserDevice device)

    • getEducation

      @Deprecated public List<User.Education> getEducation()
      Deprecated.
      since breaking change on 4 April, 2018
      A list of the education history from the user's profile.
      Returns:
      A list of the education history from the user's profile.

    • addEducation

      @Deprecated public boolean addEducation​(User.Education educationHistoryItem)
      Deprecated.
      since breaking change on 4 April, 2018
      Adds the User.Education from the education list
      Parameters:
      educationHistoryItem - the Education that should be added
      Returns:
      true if the User.Education could be added

    • removeEducation

      @Deprecated public boolean removeEducation​(User.Education educationHistoryItem)
      Deprecated.
      since breaking change on 4 April, 2018
      Removes the User.Education from the education list
      Parameters:
      educationHistoryItem - the Education that should be removed
      Returns:
      true if the User.Education could be removed

    • getSports

      public List<User.Sport> getSports()
      A list of the sports from the user's profile.
      Returns:
      A list of the sports from this user's profile.

    • addSport

      public boolean addSport​(User.Sport sportItem)

    • removeSport

      public boolean removeSport​(User.Sport sportItem)

    • getFavoriteTeams

      public List<User.Experience> getFavoriteTeams()
      A list of the favorite sports teams from the user's profile.
      Returns:
      A list of the favorite sports teams from the user's profile.

    • addFavoriteTeam

      public boolean addFavoriteTeam​(User.Experience team)

    • removeFavoriteTeam

      public boolean removeFavoriteTeam​(User.Experience team)

    • getFavoriteAthletes

      public List<User.Experience> getFavoriteAthletes()
      A list of the favorite athletes from the user's profile.
      Returns:
      A list of the favorite athletes from the user's profile.

    • addFavoriteAthlete

      public boolean addFavoriteAthlete​(User.Experience athlet)

    • removeFavoriteAthlete

      public boolean removeFavoriteAthlete​(User.Experience athlet)

    • getInspirationalPeople

      public List<User.Experience> getInspirationalPeople()
      The person's inspirational people.
      Returns:
      The person's inspirational people.

    • addInspirationalPeople

      public boolean addInspirationalPeople​(User.Experience person)

    • removeInspirationalPeople

      public boolean removeInspirationalPeople​(User.Experience person)

    • getLanguages

      public List<User.Experience> getLanguages()
      A list of the languages from the user's profile.
      Returns:
      A list of the languages from the user's profile.

    • addLanguage

      public boolean addLanguage​(User.Experience language)

    • removeLanguage

      public boolean removeLanguage​(User.Experience language)

    • getLabels

      @GraphAPI(since="2.6") public List<PageLabel> getLabels()
      Page labels of this user
      Returns:
      labels of this user

    • addLabel

      public boolean addLabel​(PageLabel label)

    • removeLabels

      public boolean removeLabels​(PageLabel label)

    • getInvitableFriends

      public List<UserInvitableFriend> getInvitableFriends()
      A list of friends that can be invited to install a Facebook Canvas app
      Returns:
      A list of friends that can be invited to install a Facebook Canvas app

    • addInvitableFriend

      public boolean addInvitableFriend​(UserInvitableFriend friend)

    • removeInvitableFriend

      public boolean removeInvitableFriend​(UserInvitableFriend friend)

    • getContext

      @Deprecated public FacebookType getContext()
      Deprecated.
      with Graph API 12 or December 13, 2021 for all versions
      Social context for this person
      Returns:
      Social context for this person

    • setContext

      @Deprecated public void setContext​(FacebookType context)
      Deprecated.
      with Graph API 12 or December 13, 2021 for all versions
      Social context for this person

    • getFirstName

      public String getFirstName()
      The user's first name.
      Returns:
      The user's first name.

    • setFirstName

      public void setFirstName​(String firstName)
      The user's first name.

    • getMiddleName

      public String getMiddleName()
      The user's middle name.
      Returns:
      The user's middle name.

    • setMiddleName

      public void setMiddleName​(String middleName)
      The user's middle name.

    • getNameFormat

      public String getNameFormat()
      The person's name formatted to correctly handle Chinese, Japanese, or Korean ordering.
      Returns:
      The person's name formatted to correctly handle Chinese, Japanese, or Korean ordering

    • setNameFormat

      public void setNameFormat​(String nameFormat)
      The person's name formatted to correctly handle Chinese, Japanese, or Korean ordering.

    • getPaymentPricepoints

      public User.PaymentPricepoints getPaymentPricepoints()
      The person's payment pricepoints
      Returns:
      The person's payment pricepoints

    • setPaymentPricepoints

      public void setPaymentPricepoints​(User.PaymentPricepoints paymentPricepoints)
      The person's payment pricepoints

    • getLastName

      public String getLastName()
      The user's last name.
      Returns:
      The user's last name.

    • setLastName

      public void setLastName​(String lastName)
      The user's last name.

    • getShortName

      @GraphAPI(since="2.9") public String getShortName()
      Shortened, locale-aware name for the person.
      Returns:
      Shortened, locale-aware name for the person

    • setShortName

      public void setShortName​(String shortName)
      Shortened, locale-aware name for the person.

    • getCover

      public CoverPhoto getCover()
      The person's cover photo
      Specified by:
      getCover in interface HasCover
      Returns:
      The person's cover photo

    • setCover

      public void setCover​(CoverPhoto cover)
      The person's cover photo

    • getLink

      public String getLink()
      A link to the user's profile.
      Returns:
      A link to the user's profile.

    • setLink

      public void setLink​(String link)
      A link to the user's profile.

    • getBio

      @GraphAPI(until="2.7") public String getBio()
      The user's biographical snippet.
      Returns:
      The user's biographical snippet.

    • setBio

      public void setBio​(String bio)
      The user's biographical snippet.

    • getQuotes

      public String getQuotes()
      The user's favorite quotes.
      Returns:
      The user's favorite quotes.

    • setQuotes

      public void setQuotes​(String quotes)
      The user's favorite quotes.

    • getAbout

      @Deprecated public String getAbout()
      Deprecated.
      since breaking change on 4 April, 2018
      The user's blurb that appears under their profile picture.
      Returns:
      The user's blurb that appears under their profile picture.

    • setAbout

      @Deprecated public void setAbout​(String about)
      Deprecated.
      since breaking change on 4 April, 2018
      The user's blurb that appears under their profile picture.

    • getRelationshipStatus

      @Deprecated public String getRelationshipStatus()
      Deprecated.
      since breaking change on 4 April, 2018
      The user's relationship status.
      Returns:
      The user's relationship status.

    • setRelationshipStatus

      @Deprecated public void setRelationshipStatus​(String relationshipStatus)
      Deprecated.
      since breaking change on 4 April, 2018
      The user's relationship status.

    • getReligion

      @Deprecated public String getReligion()
      Deprecated.
      since breaking change on 4 April, 2018
      The user's religion.
      Returns:
      The user's religion.

    • setReligion

      @Deprecated public void setReligion​(String religion)
      Deprecated.
      since breaking change on 4 April, 2018
      The user's religion.

    • getAgeRange

      public User.AgeRange getAgeRange()
      Unspecific age range that this person's age fits into.
      Returns:
      The user's age range

    • setAgeRange

      public void setAgeRange​(User.AgeRange ageRange)
      Unspecific age range that this person's age fits into.

    • getWebsite

      @Deprecated public String getWebsite()
      Deprecated.
      since breaking change on 4 April, 2018
      A link to the user's personal website.
      Returns:
      A link to the user's personal website.

    • setWebsite

      @Deprecated public void setWebsite​(String website)
      Deprecated.
      since breaking change on 4 April, 2018
      A link to the user's personal website.

    • getBirthday

      public String getBirthday()
      The user's birthday as a String.

      Will always succeed, even if the user has specified month/year format only. If you'd like to use a typed version of this accessor, call getBirthdayAsDate() instead.

      Returns:
      The user's birthday as a String.

    • setBirthday

      public void setBirthday​(String birthday)
      The user's birthday as a String.

      Will always succeed, even if the user has specified month/year format only. If you'd like to use a typed version of this accessor, call getBirthdayAsDate() instead.

    • getEmail

      public String getEmail()
      The proxied or contact email address granted by the user.
      Returns:
      The proxied or contact email address granted by the user.

    • setEmail

      public void setEmail​(String email)
      The proxied or contact email address granted by the user.

    • getTimezone

      public Double getTimezone()
      The user's timezone offset.
      Returns:
      The user's timezone offset.

    • setTimezone

      public void setTimezone​(Double timezone)
      The user's timezone offset.

    • getVerified

      public Boolean getVerified()
      Indicates whether the account has been verified. This is distinct from the is_verified field. Someone is considered verified if they take any of the following actions:
      • Register for mobile
      • Confirm their account via SMS
      • Enter a valid credit card
      Returns:
      User verification status.

    • setVerified

      public void setVerified​(Boolean verified)
      Indicates whether the account has been verified. This is distinct from the is_verified field. Someone is considered verified if they take any of the following actions:
      • Register for mobile
      • Confirm their account via SMS
      • Enter a valid credit card

    • getVideoUploadLimits

      public User.VideoUploadLimits getVideoUploadLimits()
      Video upload limits
      Returns:
      Video upload limits

    • setVideoUploadLimits

      public void setVideoUploadLimits​(User.VideoUploadLimits videoUploadLimits)
      Video upload limits

    • getViewerCanSendGift

      @Deprecated public Boolean getViewerCanSendGift()
      Deprecated.
      Will be deprecated in all versions on Nov, 2020.
      Can the viewer send a gift to this person?
      Returns:
      Can the viewer send a gift to this person?

    • setViewerCanSendGift

      @Deprecated public void setViewerCanSendGift​(Boolean viewerCanSendGift)
      Deprecated.
      Will be deprecated in all versions on Nov, 2020.
      Can the viewer send a gift to this person?

    • getGender

      public String getGender()
      The user's gender.
      Returns:
      The user's gender.

    • setGender

      public void setGender​(String gender)
      The user's gender.

    • getPolitical

      @Deprecated public String getPolitical()
      Deprecated.
      since breaking change on 4 April, 2018
      The user's political affiliation.
      Returns:
      The user's political affiliation.

    • setPolitical

      @Deprecated public void setPolitical​(String political)
      Deprecated.
      since breaking change on 4 April, 2018
      The user's political affiliation.

    • getLocale

      public String getLocale()
      The user's locale.
      Returns:
      The user's locale.

    • setLocale

      public void setLocale​(String locale)
      The user's locale.

    • getUsername

      @Deprecated public String getUsername()
      Deprecated.
      since graph api 2.0
      The user's Facebook username.
      Returns:
      The user's Facebook username.
      Since:
      1.6.5

    • setUsername

      @Deprecated public void setUsername​(String username)
      Deprecated.
      since graph api 2.0
      The user's Facebook username.
      Since:
      1.6.5

    • getPublicKey

      public String getPublicKey()
      The person's PGP public key
      Returns:
      The person's PGP public key

    • setPublicKey

      public void setPublicKey​(String publicKey)
      The person's PGP public key

    • getLikes

      public Likes getLikes()
      The user's Likes
      Returns:
      the user's Likes

    • setLikes

      public void setLikes​(Likes likes)
      The user's Likes

    • getPicture

      public ProfilePictureSource getPicture()
      The user's picture, if provided. To force Facebook to fill the picture field you have to fetch the user with the fields=picture parameter, otherwise the picture is null.
      Specified by:
      getPicture in interface HasProfilePicture
      Returns:
      the user's picture as ProfilePictureSource object
      Since:
      1.6.16

    • setPicture

      public void setPicture​(ProfilePictureSource picture)
      The user's picture, if provided. To force Facebook to fill the picture field you have to fetch the user with the fields=picture parameter, otherwise the picture is null.
      Since:
      1.6.16

    • getHometown

      public NamedFacebookType getHometown()
      Duplicate mapping for "hometown" since FB can return it differently in different situations. -- GETTER -- The user's hometown.

      Sometimes this can be null - check getHometownName() instead in that case.

      Returns:
      The user's hometown.

    • setHometown

      public void setHometown​(NamedFacebookType hometown)
      Duplicate mapping for "hometown" since FB can return it differently in different situations. -- GETTER -- The user's hometown.

      Sometimes this can be null - check getHometownName() instead in that case.

    • getLocation

      public NamedFacebookType getLocation()
      The user's current location.
      Returns:
      The user's current location.

    • setLocation

      public void setLocation​(NamedFacebookType location)
      The user's current location.

    • getSecuritySettings

      @Deprecated public User.SecuritySettings getSecuritySettings()
      Deprecated.
      Will be deprecated in all versions on Nov, 2020.
      Security settings
      Returns:
      Security settings

    • setSecuritySettings

      @Deprecated public void setSecuritySettings​(User.SecuritySettings securitySettings)
      Deprecated.
      Will be deprecated in all versions on Nov, 2020.
      Security settings

    • getSharedLoginUpgradeRequiredBy

      public Date getSharedLoginUpgradeRequiredBy()
      The time that the shared loginneeds to be upgraded to Business Manager by
      Returns:
      The time that the shared loginneeds to be upgraded to Business Manager by

    • setSharedLoginUpgradeRequiredBy

      public void setSharedLoginUpgradeRequiredBy​(Date sharedLoginUpgradeRequiredBy)
      The time that the shared loginneeds to be upgraded to Business Manager by

    • getSignificantOther

      public NamedFacebookType getSignificantOther()
      The user's significant other.
      Returns:
      The user's significant other.

    • setSignificantOther

      public void setSignificantOther​(NamedFacebookType significantOther)
      The user's significant other.

    • getTestGroup

      @Deprecated public Long getTestGroup()
      Deprecated.
      Will be deprecated in all versions on Nov, 2020.
      Platform test group
      Returns:
      Platform test group

    • setTestGroup

      @Deprecated public void setTestGroup​(Long testGroup)
      Deprecated.
      Will be deprecated in all versions on Nov, 2020.
      Platform test group

    • getUpdatedTime

      public Date getUpdatedTime()
      Date the user's profile was updated.
      Returns:
      Date the user's profile was updated.

    • setUpdatedTime

      public void setUpdatedTime​(Date updatedTime)
      Date the user's profile was updated.

    • getThirdPartyId

      public String getThirdPartyId()
      An anonymous, but unique identifier for the user.
      Returns:
      An anonymous, but unique identifier for the user.

    • setThirdPartyId

      public void setThirdPartyId​(String thirdPartyId)
      An anonymous, but unique identifier for the user.

    • getCurrency

      public User.Currency getCurrency()
      The user's currency preferences.

      Further documentation available on Facebook's Displaying prices in user's currency page.

      Returns:
      The user's currency preferences.
      Since:
      1.6.12

    • setCurrency

      public void setCurrency​(User.Currency currency)
      The user's currency preferences.

      Further documentation available on Facebook's Displaying prices in user's currency page.

      Since:
      1.6.12

    • getTokenForBusiness

      public String getTokenForBusiness()
      This returns a string which is the same for this person across all the apps managed by the same Business Manager.
      Returns:
      string which is the same for a person across all apps managed by one company
      Since:
      1.7.0

    • setTokenForBusiness

      public void setTokenForBusiness​(String tokenForBusiness)
      This returns a string which is the same for this person across all the apps managed by the same Business Manager.
      Since:
      1.7.0

    • getInstallType

      public String getInstallType()
      Install type.
      Returns:
      Install type.

    • setInstallType

      public void setInstallType​(String installType)
      Install type.

    • getInstalled

      public Boolean getInstalled()
      Is the app making the request installed?
      Returns:
      Is the app making the request installed?

    • setInstalled

      public void setInstalled​(Boolean installed)
      Is the app making the request installed?

    • getIsSharedLogin

      @Deprecated public Boolean getIsSharedLogin()
      Deprecated.
      Will be deprecated in all versions on Nov, 2020.
      Is this a shared login (e.g. a gray user)
      Returns:
      Is this a shared login (e.g. a gray user)

    • setIsSharedLogin

      @Deprecated public void setIsSharedLogin​(Boolean isSharedLogin)
      Deprecated.
      Will be deprecated in all versions on Nov, 2020.
      Is this a shared login (e.g. a gray user)

    • getIsVerified

      public Boolean getIsVerified()
      People with large numbers of followers can have the authenticity of their identity manually verified by Facebook. This field indicates whether the person's profile is verified in this way. This is distinct from the verified field
      Returns:
      Is the user verified

    • setIsVerified

      public void setIsVerified​(Boolean isVerified)
      People with large numbers of followers can have the authenticity of their identity manually verified by Facebook. This field indicates whether the person's profile is verified in this way. This is distinct from the verified field

    • getIsGuestUser

      public Boolean getIsGuestUser()
      if the current user is a guest user. should always return false.

    • setIsGuestUser

      public void setIsGuestUser​(Boolean isGuestUser)
      if the current user is a guest user. should always return false.