FacebookProfile (pac4j 1.8.8 API)

java.lang.Object
- org.pac4j.core.profile.UserProfile
- - org.pac4j.core.profile.CommonProfile
  - - org.pac4j.oauth.profile.OAuth20Profile
    - - org.pac4j.oauth.profile.facebook.FacebookProfile

All Implemented Interfaces:: Externalizable, Serializable, Clearable

public class FacebookProfile
extends OAuth20Profile

This class is the user profile for Facebook with appropriate getters.

It is returned by the FacebookClient.

Method :	From the JSON profile response :
The attributes of the `CommonProfile`
String getEmail()	the email attribute
String getFirstName()	the first_name attribute
String getFamilyName()	the last_name attribute
String getDisplayName()	the name attribute
String getUsername()	the username attribute
Gender getGender()	the gender attribute
Locale getLocale()	the locale attribute
String getPictureUrl()	the url sub-attribute of the picture attribute
String getProfileUrl()	the link attribute
String getLocation()	the name sub-attribute of the location attribute
More specific attributes
String getMiddleName()	the middle_name attribute
List<FacebookObject> getLanguages()	the languages attribute
String getThirdPartyId()	the third_party_id attribute
Integer getTimezone()	the timezone attribute
Date getUpdateTime()	the updated_time attribute
Boolean getVerified()	the verified attribute
String getBio()	the bio attribute
Date getBirthday()	the birthday attribute
List<FacebookEducation> getEducation()	the education attribute
FacebookObject getHometown()	the hometown attribute
List<String> getInterestedIn()	the interested_in attribute
FacebookObject getLocationObject()	the locatiion attribute
String getPolitical()	the political attribute
List<FacebookObject> getFavoriteAthletes()	the favorite_athletes attribute
List<FacebookObject> getFavoriteTeams()	the favorite_teams attribute
String getQuotes()	the quotes attribute
FacebookRelationshipStatus getRelationshipStatus()	the relationship_status attribute
String getReligion()	the religion attribute
FacebookObject getSignificantOther()	the significant_other attribute
String getWebsite()	the website attribute
List<FacebookWork> getWork()	the work attribute
List<FacebookObject> getFriends()	the friends attribute
List<FacebookInfo> getMovies()	the movies attribute
List<FacebookInfo> getMusic()	the music attribute
List<FacebookInfo> getBooks()	the books attribute
List<FacebookInfo> getLikes()	the likes attribute
List<FacebookPhoto> getAlbums()	the albums attribute
List<FacebookEvent> getEvents()	the events attribute
List<FacebookGroup> getGroups()	the groups attribute
List<FacebookMusicListen> getMusicListens()	the music.listens attribute
FacebookPicture getPicture()	the picture attribute

Since:: 1.1.0
Author:: Jerome Leleu
See Also:: FacebookClient, Serialized Form

Field Summary
- Fields inherited from class org.pac4j.core.profile.CommonProfile
  USERNAME
- Fields inherited from class org.pac4j.core.profile.UserProfile
  logger, SEPARATOR

Constructor Summary

Constructors
Constructor and Description

FacebookProfile()

Constructors
Constructor and Description
`FacebookProfile()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`List<FacebookPhoto>`	`getAlbums()`
`protected AttributesDefinition`	`getAttributesDefinition()` Return the attributes definition for this user profile.
`String`	`getBio()`
`Date`	`getBirthday()`
`List<FacebookInfo>`	`getBooks()`
`String`	`getDisplayName()` Return the displayed name of the user.
`List<FacebookEducation>`	`getEducation()`
`List<FacebookEvent>`	`getEvents()`
`String`	`getFamilyName()` Return the family name of the user.
`List<FacebookObject>`	`getFavoriteAthletes()`
`List<FacebookObject>`	`getFavoriteTeams()`
`List<FacebookObject>`	`getFriends()`
`List<FacebookGroup>`	`getGroups()`
`FacebookObject`	`getHometown()`
`List<String>`	`getInterestedIn()`
`List<FacebookObject>`	`getLanguages()`
`List<FacebookInfo>`	`getLikes()`
`String`	`getLocation()` Return the location of the user.
`FacebookObject`	`getLocationObject()`
`String`	`getMiddleName()`
`List<FacebookInfo>`	`getMovies()`
`List<FacebookInfo>`	`getMusic()`
`List<FacebookMusicListen>`	`getMusicListens()`
`FacebookPicture`	`getPicture()`
`String`	`getPictureUrl()` Return the url of the picture of the user.
`String`	`getPolitical()`
`String`	`getProfileUrl()` Return the url of the profile of the user.
`String`	`getQuotes()`
`FacebookRelationshipStatus`	`getRelationshipStatus()`
`String`	`getReligion()`
`FacebookObject`	`getSignificantOther()`
`String`	`getThirdPartyId()`
`Integer`	`getTimezone()`
`Date`	`getUpdateTime()`
`String`	`getUsername()` Deprecated.
`Boolean`	`getVerified()`
`String`	`getWebsite()`
`List<FacebookWork>`	`getWork()`

Methods inherited from class org.pac4j.oauth.profile.OAuth20Profile
clear, getAccessToken, setAccessToken

Methods inherited from class org.pac4j.core.profile.CommonProfile
getEmail, getFirstName, getGender, getLocale

Methods inherited from class org.pac4j.core.profile.UserProfile
addAttribute, addAttributes, addPermission, addPermissions, addRole, addRoles, build, getAttribute, getAttribute, getAttributes, getId, getPermissions, getRoles, getTypedId, isRemembered, readExternal, setId, setRemembered, toString, writeExternal

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FacebookProfile
```
public FacebookProfile()
```
- Method Detail
  - getAttributesDefinition
```
protected AttributesDefinition getAttributesDefinition()
```
    Description copied from class: UserProfile
    
    Return the attributes definition for this user profile. Null for this (generic) user profile.
    
    Overrides:
    
    getAttributesDefinition in class UserProfile
    
    Returns:
    
    the attributes definition
  - getFamilyName
```
public String getFamilyName()
```
    Description copied from class: CommonProfile
    
    Return the family name of the user.
    
    Overrides:
    
    getFamilyName in class CommonProfile
    
    Returns:
    
    the family name of the user
  - getDisplayName
```
public String getDisplayName()
```
    Description copied from class: CommonProfile
    
    Return the displayed name of the user. It can be the username or the first and last names (separated by a space).
    
    Overrides:
    
    getDisplayName in class CommonProfile
    
    Returns:
    
    the displayed name of the user
  - getUsername
```
@Deprecated
public String getUsername()
```
    Deprecated.
    
    For new OAuth Facebook applications, the username field is no more supported and generates an error: {"error":{"message":"(#12) username is deprecated for versions v2.0 and higher","type":"OAuthException","code":12}}
    
    Overrides:
    
    getUsername in class CommonProfile
    
    Returns:
    
    the username of the user
  - getPictureUrl
```
public String getPictureUrl()
```
    Description copied from class: CommonProfile
    
    Return the url of the picture of the user.
    
    Overrides:
    
    getPictureUrl in class CommonProfile
    
    Returns:
    
    the url of the picture of the user.
  - getProfileUrl
```
public String getProfileUrl()
```
    Description copied from class: CommonProfile
    
    Return the url of the profile of the user.
    
    Overrides:
    
    getProfileUrl in class CommonProfile
    
    Returns:
    
    the url of the profile of the user.
  - getLocation
```
public String getLocation()
```
    Description copied from class: CommonProfile
    
    Return the location of the user.
    
    Overrides:
    
    getLocation in class CommonProfile
    
    Returns:
    
    the locationle of the user
  - getMiddleName
```
public String getMiddleName()
```
  - getLanguages
```
public List<FacebookObject> getLanguages()
```
  - getThirdPartyId
```
public String getThirdPartyId()
```
  - getTimezone
```
public Integer getTimezone()
```
  - getUpdateTime
```
public Date getUpdateTime()
```
  - getVerified
```
public Boolean getVerified()
```
  - getBio
```
public String getBio()
```
  - getBirthday
```
public Date getBirthday()
```
  - getEducation
```
public List<FacebookEducation> getEducation()
```
  - getHometown
```
public FacebookObject getHometown()
```
  - getInterestedIn
```
public List<String> getInterestedIn()
```
  - getLocationObject
```
public FacebookObject getLocationObject()
```
  - getPolitical
```
public String getPolitical()
```
  - getFavoriteAthletes
```
public List<FacebookObject> getFavoriteAthletes()
```
  - getFavoriteTeams
```
public List<FacebookObject> getFavoriteTeams()
```
  - getQuotes
```
public String getQuotes()
```
  - getRelationshipStatus
```
public FacebookRelationshipStatus getRelationshipStatus()
```
  - getReligion
```
public String getReligion()
```
  - getSignificantOther
```
public FacebookObject getSignificantOther()
```
  - getWebsite
```
public String getWebsite()
```
  - getWork
```
public List<FacebookWork> getWork()
```
  - getFriends
```
public List<FacebookObject> getFriends()
```
  - getMovies
```
public List<FacebookInfo> getMovies()
```
  - getMusic
```
public List<FacebookInfo> getMusic()
```
  - getBooks
```
public List<FacebookInfo> getBooks()
```
  - getLikes
```
public List<FacebookInfo> getLikes()
```
  - getAlbums
```
public List<FacebookPhoto> getAlbums()
```
  - getEvents
```
public List<FacebookEvent> getEvents()
```
  - getGroups
```
public List<FacebookGroup> getGroups()
```
  - getMusicListens
```
public List<FacebookMusicListen> getMusicListens()
```
  - getPicture
```
public FacebookPicture getPicture()
```

Class FacebookProfile

Field Summary

Fields inherited from class org.pac4j.core.profile.CommonProfile

Fields inherited from class org.pac4j.core.profile.UserProfile

Constructor Summary

Method Summary

Methods inherited from class org.pac4j.oauth.profile.OAuth20Profile

Methods inherited from class org.pac4j.core.profile.CommonProfile

Methods inherited from class org.pac4j.core.profile.UserProfile

Methods inherited from class java.lang.Object

Constructor Detail

FacebookProfile

Method Detail

getAttributesDefinition

getFamilyName

getDisplayName

getUsername

getPictureUrl

getProfileUrl

getLocation

getMiddleName

getLanguages

getThirdPartyId

getTimezone

getUpdateTime

getVerified

getBio

getBirthday

getEducation

getHometown

getInterestedIn

getLocationObject

getPolitical

getFavoriteAthletes

getFavoriteTeams

getQuotes

getRelationshipStatus

getReligion

getSignificantOther

getWebsite

getWork

getFriends

getMovies

getMusic

getBooks

getLikes

getAlbums

getEvents

getGroups

getMusicListens

getPicture