|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface Person
see http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/opensocial-reference#opensocial.Person.Field for all field meanings. All fields are represented in the js api at this time except for lastUpdated. This field is currently only in the RESTful spec.
| Nested Class Summary | |
|---|---|
static class |
Person.Field
The fields that represent the person object in json form. |
static class |
Person.Gender
Enumeration of genders. |
| Field Summary | |
|---|---|
static java.lang.String |
PROFILE_URL_TYPE
The type of a profile url when represented as a list field. |
static java.lang.String |
THUMBNAIL_PHOTO_TYPE
The type of thumbnail photo types when represented as list fields. |
| Method Summary | |
|---|---|
java.lang.String |
getAboutMe()
Get a general statement about the person, specified as a string. |
java.util.List<Account> |
getAccounts()
Get the list of online accounts held by this person. |
java.util.List<java.lang.String> |
getActivities()
Get the person's favorite activities, specified as an List of strings. |
java.util.List<Address> |
getAddresses()
Get addresses associated with the person, specified as an List of Address objects. |
java.lang.Integer |
getAge()
Get the person's age, specified as a number. |
java.util.Map<java.lang.String,?> |
getAppData()
Get app data for the person. |
java.util.Date |
getBirthday()
Get the person's date of birth, specified as a Date object. |
BodyType |
getBodyType()
Get the person's body characteristics, specified as an BodyType. |
java.util.List<java.lang.String> |
getBooks()
Get the person's favorite books, specified as an List of strings. |
java.util.List<java.lang.String> |
getCars()
Get the person's favorite cars, specified as an List of strings. |
java.lang.String |
getChildren()
Get a description of the person's children, specified as a string. |
Address |
getCurrentLocation()
Get the person's current location, specified as an Address. |
java.lang.String |
getDisplayName()
The display name for the user. |
Enum<Drinker> |
getDrinker()
Get the person's drinking status, specified as an Enum with the enum's key referencing
Drinker. |
java.util.List<ListField> |
getEmails()
Get the person's Emails associated with the person. |
java.lang.String |
getEthnicity()
Get the person's ethnicity, specified as a string. |
java.lang.String |
getFashion()
Get the person's thoughts on fashion, specified as a string. |
java.util.List<java.lang.String> |
getFood()
Get the person's favorite food, specified as an List of strings. |
Person.Gender |
getGender()
Get a person's gender, specified as an Person.Gender. |
java.lang.String |
getHappiestWhen()
Get a description of when the person is happiest, specified as a string. |
java.lang.Boolean |
getHasApp()
Get if the person has used the current app. |
java.util.List<java.lang.String> |
getHeroes()
Get a person's favorite heroes, specified as an Array of strings. |
java.lang.String |
getHumor()
Get the person's thoughts on humor, specified as a string. |
java.lang.String |
getId()
Get A string ID that can be permanently associated with this person. |
java.util.List<ListField> |
getIms()
Get a list of Instant messaging address for this Person. |
java.util.List<java.lang.String> |
getInterests()
Get the person's interests, hobbies or passions, specified as an List of strings. |
boolean |
getIsOwner()
|
boolean |
getIsViewer()
Returns true if this person object represents the currently logged in user. |
java.lang.String |
getJobInterests()
Get the Person's favorite jobs, or job interests and skills, specified as a string. |
java.util.List<java.lang.String> |
getLanguagesSpoken()
Get a List of the languages that the person speaks as ISO 639-1 codes, specified as an List of strings. |
java.lang.String |
getLivingArrangement()
Get a description of the person's living arrangement, specified as a string. |
java.util.List<Enum<LookingFor>> |
getLookingFor()
Get a person's statement about who or what they are looking for, or what they are interested in meeting people for. |
java.util.List<java.lang.String> |
getMovies()
Get the Person's favorite movies, specified as an List of strings. |
java.util.List<java.lang.String> |
getMusic()
Get the Person's favorite music, specified as an List of strings Container support for this field is OPTIONAL. |
Name |
getName()
Get the person's name Container support for this field is REQUIRED. |
Enum<NetworkPresence> |
getNetworkPresence()
Get the person's current network status. |
java.lang.String |
getNickname()
Get the person's nickname. |
java.util.List<Organization> |
getOrganizations()
Get a list of current or past organizational affiliations of this Person. |
java.lang.String |
getPets()
Get a description of the person's pets Container support for this field is OPTIONAL. |
java.util.List<ListField> |
getPhoneNumbers()
Get the Phone numbers associated with the person. |
java.util.List<ListField> |
getPhotos()
URL of a photo of this person. |
java.lang.String |
getPoliticalViews()
Get the Person's political views, specified as a string. |
java.lang.String |
getPreferredUsername()
Get the Person's preferred username, specified as a string. |
Url |
getProfileSong()
Get the Person's profile song, specified as an Url. |
java.lang.String |
getProfileUrl()
Get the person's profile URL. |
Url |
getProfileVideo()
Get the Person's profile video. |
java.util.List<java.lang.String> |
getQuotes()
Get the person's favorite quotes Container support for this field is OPTIONAL. |
java.lang.String |
getRelationshipStatus()
Get the person's relationship status. |
java.lang.String |
getReligion()
Get the person's relgion or religious views. |
java.lang.String |
getRomance()
Get the person's comments about romance. |
java.lang.String |
getScaredOf()
Get what the person is scared of Container support for this field is OPTIONAL. |
java.lang.String |
getSexualOrientation()
Get the person's sexual orientation. |
Enum<Smoker> |
getSmoker()
Get the person's smoking status. |
java.util.List<java.lang.String> |
getSports()
Get the person's favorite sports. |
java.lang.String |
getStatus()
Get the person's status, headline or shoutout. |
java.util.List<java.lang.String> |
getTags()
Get arbitrary tags about the person. |
java.lang.String |
getThumbnailUrl()
Get the person's photo thumbnail URL, specified as a string. |
java.util.List<java.lang.String> |
getTurnOffs()
Get the person's turn offs. |
java.util.List<java.lang.String> |
getTurnOns()
Get the person's turn ons. |
java.util.List<java.lang.String> |
getTvShows()
Get the person's favorite TV shows. |
java.util.Date |
getUpdated()
The time this person was last updated. |
java.util.List<Url> |
getUrls()
Get the URLs related to the person, their webpages, or feeds Container support for this field is OPTIONAL. |
java.lang.Long |
getUtcOffset()
Get the Person's time zone, specified as the difference in minutes between Greenwich Mean Time (GMT) and the user's local time. |
void |
setAboutMe(java.lang.String aboutMe)
Set a general statement about the person, specified as a string. |
void |
setAccounts(java.util.List<Account> accounts)
Set the list of online accounts held by this person. |
void |
setActivities(java.util.List<java.lang.String> activities)
Set the person's favorite activities, specified as an List of strings. |
void |
setAddresses(java.util.List<Address> addresses)
Set addresses associated with the person, specified as an List of Address objects. |
void |
setAge(java.lang.Integer age)
Set the person's age, specified as a number. |
void |
setAppData(java.util.Map<java.lang.String,?> appData)
Sets app data for the person. |
void |
setBirthday(java.util.Date birthday)
Set the person's date of birth, specified as a Date object. |
void |
setBodyType(BodyType bodyType)
Set the person's body characteristics, specified as an BodyType. |
void |
setBooks(java.util.List<java.lang.String> books)
Set the person's favorite books, specified as an List of strings. |
void |
setCars(java.util.List<java.lang.String> cars)
Set the person's favorite cars, specified as an List of strings. |
void |
setChildren(java.lang.String children)
Set a description of the person's children, specified as a string. |
void |
setCurrentLocation(Address currentLocation)
Set the person's current location, specified as an Address. |
void |
setDisplayName(java.lang.String displayName)
Set the display name. |
void |
setDrinker(Enum<Drinker> newDrinker)
Get the person's drinking status, specified as an Enum with the enum's key referencing
Drinker. |
void |
setEmails(java.util.List<ListField> emails)
Set the person's Emails associated with the person. |
void |
setEthnicity(java.lang.String ethnicity)
Set the person's ethnicity, specified as a string. |
void |
setFashion(java.lang.String fashion)
Set the person's thoughts on fashion, specified as a string. |
void |
setFood(java.util.List<java.lang.String> food)
Set the person's favorite food, specified as an List of strings. |
void |
setGender(Person.Gender newGender)
Set a person's gender, specified as an Person.Gender. |
void |
setHappiestWhen(java.lang.String happiestWhen)
Set a description of when the person is happiest, specified as a string. |
void |
setHasApp(java.lang.Boolean hasApp)
Set if the person has used the current app. |
void |
setHeroes(java.util.List<java.lang.String> heroes)
Set a person's favorite heroes, specified as an Array of strings. |
void |
setHumor(java.lang.String humor)
Set the person's thoughts on humor, specified as a string. |
void |
setId(java.lang.String id)
Set A string ID that can be permanently associated with this person. |
void |
setIms(java.util.List<ListField> ims)
Set a list of Instant messaging address for this Person. |
void |
setInterests(java.util.List<java.lang.String> interests)
Set the person's interests, hobbies or passions, specified as an List of strings. |
void |
setIsOwner(boolean isOwner)
Set the owner flag. |
void |
setIsViewer(boolean isViewer)
Returns true if this person object represents the currently logged in user. |
void |
setJobInterests(java.lang.String jobInterests)
Set the Person's favorite jobs, or job interests and skills, specified as a string. |
void |
setLanguagesSpoken(java.util.List<java.lang.String> languagesSpoken)
Set a List of the languages that the person speaks as ISO 639-1 codes, specified as an List of strings. |
void |
setLivingArrangement(java.lang.String livingArrangement)
Set a description of the person's living arrangement, specified as a string. |
void |
setLookingFor(java.util.List<Enum<LookingFor>> lookingFor)
Get a person's statement about who or what they are looking for, or what they are interested in meeting people for. |
void |
setMovies(java.util.List<java.lang.String> movies)
Set the Person's favorite movies, specified as an List of strings. |
void |
setMusic(java.util.List<java.lang.String> music)
Set the Person's favorite music, specified as an List of strings Container support for this field is OPTIONAL. |
void |
setName(Name name)
Set the person's name Container support for this field is REQUIRED. |
void |
setNetworkPresence(Enum<NetworkPresence> networkPresence)
Set the person's current network status. |
void |
setNickname(java.lang.String nickname)
Set the the person's nickname. |
void |
setOrganizations(java.util.List<Organization> organizations)
Set a list of current or past organizational affiliations of this Person. |
void |
setPets(java.lang.String pets)
Set a description of the person's pets Container support for this field is OPTIONAL. |
void |
setPhoneNumbers(java.util.List<ListField> phoneNumbers)
Set the Phone numbers associated with the person. |
void |
setPhotos(java.util.List<ListField> photos)
Set a list of Photos for the person. |
void |
setPoliticalViews(java.lang.String politicalViews)
Set the Person's political views, specified as a string. |
void |
setPreferredUsername(java.lang.String preferredString)
Set the Person's preferred username, specified as a string. |
void |
setProfileSong(Url profileSong)
Set the Person's profile song, specified as an Url. |
void |
setProfileUrl(java.lang.String profileUrl)
Set the person's profile URL. |
void |
setProfileVideo(Url profileVideo)
Set the Person's profile video. |
void |
setQuotes(java.util.List<java.lang.String> quotes)
Set the person's favorite quotes. |
void |
setRelationshipStatus(java.lang.String relationshipStatus)
Set the person's relationship status. |
void |
setReligion(java.lang.String religion)
Set the person's relgion or religious views. |
void |
setRomance(java.lang.String romance)
Set a the person's comments about romance, Container support for this field is OPTIONAL. |
void |
setScaredOf(java.lang.String scaredOf)
Set what the person is scared of Container support for this field is OPTIONAL. |
void |
setSexualOrientation(java.lang.String sexualOrientation)
Set the person's sexual orientation Container support for this field is OPTIONAL. |
void |
setSmoker(Enum<Smoker> newSmoker)
Set the person's smoking status. |
void |
setSports(java.util.List<java.lang.String> sports)
Set the person's favorite sports. |
void |
setStatus(java.lang.String status)
Set the person's status, headline or shoutout. |
void |
setTags(java.util.List<java.lang.String> tags)
Set arbitrary tags about the person. |
void |
setThumbnailUrl(java.lang.String thumbnailUrl)
Set the person's photo thumbnail URL, specified as a string. |
void |
setTurnOffs(java.util.List<java.lang.String> turnOffs)
Set the person's turn offs. |
void |
setTurnOns(java.util.List<java.lang.String> turnOns)
Set the person's turn ons. |
void |
setTvShows(java.util.List<java.lang.String> tvShows)
Set the person's favorite TV shows. |
void |
setUpdated(java.util.Date updated)
Set the time this record was last updated. |
void |
setUrls(java.util.List<Url> urls)
Set the URLs related to the person, their webpages, or feeds Container support for this field is OPTIONAL. |
void |
setUtcOffset(java.lang.Long utcOffset)
Set the Person's time zone, specified as the difference in minutes between Greenwich Mean Time (GMT) and the user's local time. |
| Field Detail |
|---|
static final java.lang.String PROFILE_URL_TYPE
static final java.lang.String THUMBNAIL_PHOTO_TYPE
| Method Detail |
|---|
java.lang.String getDisplayName()
void setDisplayName(java.lang.String displayName)
displayName - the new display name.java.lang.String getAboutMe()
void setAboutMe(java.lang.String aboutMe)
aboutMe - the value of aboutMejava.util.List<Account> getAccounts()
void setAccounts(java.util.List<Account> accounts)
accounts - a list of Account objectsjava.util.List<java.lang.String> getActivities()
void setActivities(java.util.List<java.lang.String> activities)
activities - a list of activitiesjava.util.List<Address> getAddresses()
void setAddresses(java.util.List<Address> addresses)
addresses - a list of address objectsjava.lang.Integer getAge()
void setAge(java.lang.Integer age)
age - the persons agejava.util.Map<java.lang.String,?> getAppData()
void setAppData(java.util.Map<java.lang.String,?> appData)
appData - the app data, possibly a subsetjava.util.Date getBirthday()
Date object. Container support for this
field is OPTIONAL.
void setBirthday(java.util.Date birthday)
Date object. Container support for this
field is OPTIONAL.
birthday - the person's data of birthBodyType getBodyType()
void setBodyType(BodyType bodyType)
bodyType - the person's BodyTypejava.util.List<java.lang.String> getBooks()
void setBooks(java.util.List<java.lang.String> books)
books - a list of the person's booksjava.util.List<java.lang.String> getCars()
void setCars(java.util.List<java.lang.String> cars)
cars - a list of the persons favorite carsjava.lang.String getChildren()
void setChildren(java.lang.String children)
children - the persons childrenAddress getCurrentLocation()
Address. Container support for this
field is OPTIONAL.
void setCurrentLocation(Address currentLocation)
Address. Container support for this
field is OPTIONAL.
currentLocation - the persons current locationEnum<Drinker> getDrinker()
Enum with the enum's key referencing
Drinker. Container support for this field is OPTIONAL.
void setDrinker(Enum<Drinker> newDrinker)
Enum with the enum's key referencing
Drinker. Container support for this field is OPTIONAL.
newDrinker - the persons drinking statusjava.util.List<ListField> getEmails()
void setEmails(java.util.List<ListField> emails)
emails - a list of the person's emailsjava.lang.String getEthnicity()
void setEthnicity(java.lang.String ethnicity)
ethnicity - the person's ethnicityjava.lang.String getFashion()
void setFashion(java.lang.String fashion)
fashion - the person's thoughts on fashionjava.util.List<java.lang.String> getFood()
void setFood(java.util.List<java.lang.String> food)
food - the person's favorite foodPerson.Gender getGender()
Person.Gender.
void setGender(Person.Gender newGender)
Person.Gender.
newGender - the person's genderjava.lang.String getHappiestWhen()
void setHappiestWhen(java.lang.String happiestWhen)
happiestWhen - a description of when the person is happiestjava.lang.Boolean getHasApp()
void setHasApp(java.lang.Boolean hasApp)
hasApp - set true the current app has been usedjava.util.List<java.lang.String> getHeroes()
void setHeroes(java.util.List<java.lang.String> heroes)
heroes - a list of the person's favorite heroesjava.lang.String getHumor()
void setHumor(java.lang.String humor)
humor - the person's thoughts on humorjava.lang.String getId()
void setId(java.lang.String id)
id - the permanent ID of the personjava.util.List<ListField> getIms()
void setIms(java.util.List<ListField> ims)
ims - a list ListFields representing IM addresses.java.util.List<java.lang.String> getInterests()
void setInterests(java.util.List<java.lang.String> interests)
interests - the person's interests, hobbies or passionsjava.lang.String getJobInterests()
void setJobInterests(java.lang.String jobInterests)
jobInterests - the Person's favorite jobs, or job interests and skillsjava.util.List<java.lang.String> getLanguagesSpoken()
void setLanguagesSpoken(java.util.List<java.lang.String> languagesSpoken)
languagesSpoken - a List of the languages that the person speaksjava.util.Date getUpdated()
void setUpdated(java.util.Date updated)
updated - the last update timejava.lang.String getLivingArrangement()
void setLivingArrangement(java.lang.String livingArrangement)
livingArrangement - a description of the person's living arrangementjava.util.List<Enum<LookingFor>> getLookingFor()
Enum with the enum's key referencing
LookingFor Container support for this field is OPTIONAL.
void setLookingFor(java.util.List<Enum<LookingFor>> lookingFor)
Enum with the enum's key referencing
LookingFor Container support for this field is OPTIONAL.
lookingFor - person's statement about who or what they are looking forjava.util.List<java.lang.String> getMovies()
void setMovies(java.util.List<java.lang.String> movies)
movies - the Person's favorite moviesjava.util.List<java.lang.String> getMusic()
void setMusic(java.util.List<java.lang.String> music)
music - Person's favorite musicName getName()
void setName(Name name)
name - the person's nameEnum<NetworkPresence> getNetworkPresence()
Enum with the enum's key
referencing NetworkPresence. Container support for this field is OPTIONAL.
void setNetworkPresence(Enum<NetworkPresence> networkPresence)
Enum with the enum's key
referencing NetworkPresence. Container support for this field is OPTIONAL.
networkPresence - the person's current network statusjava.lang.String getNickname()
void setNickname(java.lang.String nickname)
nickname - the person's nickname.java.util.List<Organization> getOrganizations()
void setOrganizations(java.util.List<Organization> organizations)
organizations - a list of Organisation objectsjava.lang.String getPets()
void setPets(java.lang.String pets)
pets - a description of the person's petsjava.util.List<ListField> getPhoneNumbers()
void setPhoneNumbers(java.util.List<ListField> phoneNumbers)
phoneNumbers - the Phone numbers associated with the personjava.util.List<ListField> getPhotos()
void setPhotos(java.util.List<ListField> photos)
photos - a list of photos.getPhotos()java.lang.String getPoliticalViews()
void setPoliticalViews(java.lang.String politicalViews)
politicalViews - the Person's political viewsjava.lang.String getPreferredUsername()
void setPreferredUsername(java.lang.String preferredString)
preferredString - the Person's preferred usernameUrl getProfileSong()
Url. Container support for this field
is OPTIONAL.
void setProfileSong(Url profileSong)
Url. Container support for this field
is OPTIONAL.
profileSong - the Person's profile songUrl getProfileVideo()
void setProfileVideo(Url profileVideo)
profileVideo - the Person's profile videojava.util.List<java.lang.String> getQuotes()
void setQuotes(java.util.List<java.lang.String> quotes)
quotes - the person's favorite quotesjava.lang.String getRelationshipStatus()
void setRelationshipStatus(java.lang.String relationshipStatus)
relationshipStatus - the person's relationship statusjava.lang.String getReligion()
void setReligion(java.lang.String religion)
religion - the person's relgion or religious viewsjava.lang.String getRomance()
void setRomance(java.lang.String romance)
romance - the person's comments about romance,java.lang.String getScaredOf()
void setScaredOf(java.lang.String scaredOf)
scaredOf - what the person is scared ofjava.lang.String getSexualOrientation()
void setSexualOrientation(java.lang.String sexualOrientation)
sexualOrientation - the person's sexual orientationEnum<Smoker> getSmoker()
void setSmoker(Enum<Smoker> newSmoker)
newSmoker - the person's smoking statusjava.util.List<java.lang.String> getSports()
void setSports(java.util.List<java.lang.String> sports)
sports - the person's favorite sportsjava.lang.String getStatus()
void setStatus(java.lang.String status)
status - the person's status, headline or shoutoutjava.util.List<java.lang.String> getTags()
void setTags(java.util.List<java.lang.String> tags)
tags - arbitrary tags about the person.java.lang.Long getUtcOffset()
void setUtcOffset(java.lang.Long utcOffset)
utcOffset - the Person's time zonejava.util.List<java.lang.String> getTurnOffs()
void setTurnOffs(java.util.List<java.lang.String> turnOffs)
turnOffs - the person's turn offsjava.util.List<java.lang.String> getTurnOns()
void setTurnOns(java.util.List<java.lang.String> turnOns)
turnOns - the person's turn onsjava.util.List<java.lang.String> getTvShows()
void setTvShows(java.util.List<java.lang.String> tvShows)
tvShows - the person's favorite TV shows.java.util.List<Url> getUrls()
void setUrls(java.util.List<Url> urls)
urls - the URLs related to the person, their webpages, or feedsboolean getIsOwner()
void setIsOwner(boolean isOwner)
isOwner - the isOwnerflagboolean getIsViewer()
void setIsViewer(boolean isViewer)
isViewer - the isViewer Flagjava.lang.String getProfileUrl()
void setProfileUrl(java.lang.String profileUrl)
profileUrl - the person's profile URLjava.lang.String getThumbnailUrl()
void setThumbnailUrl(java.lang.String thumbnailUrl)
thumbnailUrl - the person's photo thumbnail URL
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||