com.facebook.ads.sdk

Class User

java.lang.Object

com.facebook.ads.sdk.APINode

com.facebook.ads.sdk.User

All Implemented Interfaces:

APIResponse

public class User
extends APINode

This class is auto-generated. For any issues or feature requests related to this class, please let us know on github and we'll fix in our codegen framework. We'll not be able to accept pull request for this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	User.APIRequestCreateAccount
static class	User.APIRequestCreateAdStudy
static class	User.APIRequestCreateApplication
static class	User.APIRequestCreateBusiness
static class	User.APIRequestCreateFeed
static class	User.APIRequestCreateGameItem
static class	User.APIRequestCreateGamesPlay
static class	User.APIRequestCreateGameTime
static class	User.APIRequestCreateLiveEncoder
static class	User.APIRequestCreateLiveVideo
static class	User.APIRequestCreateNotification
static class	User.APIRequestCreatePhoto
static class	User.APIRequestCreateStagingResource
static class	User.APIRequestCreateVideo
static class	User.APIRequestDelete
static class	User.APIRequestDeleteAccessTokens
static class	User.APIRequestDeleteBusinesses
static class	User.APIRequestDeletePermissions
static class	User.APIRequestGet
static class	User.APIRequestGetAccounts
static class	User.APIRequestGetAdAccounts
static class	User.APIRequestGetAdStudies
static class	User.APIRequestGetAlbums
static class	User.APIRequestGetAppRequestFormerRecipients
static class	User.APIRequestGetAppRequests
static class	User.APIRequestGetAssignedAdAccounts
static class	User.APIRequestGetAssignedBusinessAssetGroups
static class	User.APIRequestGetAssignedPages
static class	User.APIRequestGetAssignedProductCatalogs
static class	User.APIRequestGetBusinesses
static class	User.APIRequestGetBusinessUsers
static class	User.APIRequestGetConversations
static class	User.APIRequestGetCustomLabels
static class	User.APIRequestGetEvents
static class	User.APIRequestGetFeed
static class	User.APIRequestGetFriends
static class	User.APIRequestGetGroups
static class	User.APIRequestGetIdsForApps
static class	User.APIRequestGetIdsForBusiness
static class	User.APIRequestGetIdsForPages
static class	User.APIRequestGetLikes
static class	User.APIRequestGetLiveEncoders
static class	User.APIRequestGetLiveVideos
static class	User.APIRequestGetMusic
static class	User.APIRequestGetOwnedProductCatalogs
static class	User.APIRequestGetPermissions
static class	User.APIRequestGetPersonalAdAccounts
static class	User.APIRequestGetPhotos
static class	User.APIRequestGetPicture
static class	User.APIRequestGetRichMediaDocuments
static class	User.APIRequestGetVideos
static class	User.APIRequestUpdate
static class	User.EnumAction
static class	User.EnumFiltering
static class	User.EnumLocalNewsMegaphoneDismissStatus
static class	User.EnumLocalNewsSubscriptionStatus
static class	User.EnumType

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.google.gson.Gson	gson

Fields inherited from class com.facebook.ads.sdk.APINode

context, header, rawValue

Constructor Summary

Constructors

Constructor and Description
User(Long id, APIContext context)
User(String id, APIContext context)

Method Summary

Modifier and Type	Method and Description
User	copyFrom(User instance)
User.APIRequestCreateAccount	createAccount()
User.APIRequestCreateAdStudy	createAdStudy()
User.APIRequestCreateApplication	createApplication()
User.APIRequestCreateBusiness	createBusiness()
User.APIRequestCreateFeed	createFeed()
User.APIRequestCreateGameItem	createGameItem()
User.APIRequestCreateGamesPlay	createGamesPlay()
User.APIRequestCreateGameTime	createGameTime()
User.APIRequestCreateLiveEncoder	createLiveEncoder()
User.APIRequestCreateLiveVideo	createLiveVideo()
User.APIRequestCreateNotification	createNotification()
User.APIRequestCreatePhoto	createPhoto()
User.APIRequestCreateStagingResource	createStagingResource()
User.APIRequestCreateVideo	createVideo()
User.APIRequestDelete	delete()
User.APIRequestDeleteAccessTokens	deleteAccessTokens()
User.APIRequestDeleteBusinesses	deleteBusinesses()
User.APIRequestDeletePermissions	deletePermissions()
User	fetch()
static User	fetchById(Long id, APIContext context)
static User	fetchById(String id, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<User>	fetchByIdAsync(Long id, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<User>	fetchByIdAsync(String id, APIContext context)
static APINodeList<User>	fetchByIds(List<String> ids, List<String> fields, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<APINodeList<User>>	fetchByIdsAsync(List<String> ids, List<String> fields, APIContext context)
User.APIRequestGet	get()
User.APIRequestGetAccounts	getAccounts()
User.APIRequestGetAdAccounts	getAdAccounts()
User.APIRequestGetAdStudies	getAdStudies()
User.APIRequestGetAlbums	getAlbums()
User.APIRequestGetAppRequestFormerRecipients	getAppRequestFormerRecipients()
User.APIRequestGetAppRequests	getAppRequests()
User.APIRequestGetAssignedAdAccounts	getAssignedAdAccounts()
User.APIRequestGetAssignedBusinessAssetGroups	getAssignedBusinessAssetGroups()
User.APIRequestGetAssignedPages	getAssignedPages()
User.APIRequestGetAssignedProductCatalogs	getAssignedProductCatalogs()
User.APIRequestGetBusinesses	getBusinesses()
User.APIRequestGetBusinessUsers	getBusinessUsers()
APIContext	getContext()
User.APIRequestGetConversations	getConversations()
User.APIRequestGetCustomLabels	getCustomLabels()
User.APIRequestGetEvents	getEvents()
User.APIRequestGetFeed	getFeed()
String	getFieldAbout()
Location	getFieldAddress()
List<PageAdminNote>	getFieldAdminNotes()
AgeRange	getFieldAgeRange()
String	getFieldAuthMethod()
String	getFieldBirthday()
UserCoverPhoto	getFieldCover()
Currency	getFieldCurrency()
List<UserDevice>	getFieldDevices()
List<Object>	getFieldEducation()
String	getFieldEmail()
List<Experience>	getFieldFavoriteAthletes()
List<Experience>	getFieldFavoriteTeams()
String	getFieldFirstName()
String	getFieldGender()
Page	getFieldHometown()
String	getFieldId()
List<Experience>	getFieldInspirationalPeople()
Boolean	getFieldInstalled()
String	getFieldInstallType()
List<String>	getFieldInterestedIn()
Boolean	getFieldIsGuestUser()
Boolean	getFieldIsVerified()
List<Experience>	getFieldLanguages()
String	getFieldLastName()
String	getFieldLink()
String	getFieldLocale()
Boolean	getFieldLocalNewsMegaphoneDismissStatus()
Boolean	getFieldLocalNewsSubscriptionStatus()
Page	getFieldLocation()
List<String>	getFieldMeetingFor()
Boolean	getFieldMessengerJoinNotificationsEnabled()
String	getFieldMiddleName()
String	getFieldName()
String	getFieldNameFormat()
PaymentPricepoints	getFieldPaymentPricepoints()
String	getFieldPolitical()
String	getFieldProfilePic()
String	getFieldPublicKey()
Boolean	getFieldPublishedTimeline()
String	getFieldQuotes()
String	getFieldRelationshipStatus()
String	getFieldReligion()
String	getFieldSharedLoginUpgradeRequiredBy()
String	getFieldShortName()
User	getFieldSignificantOther()
List<Experience>	getFieldSports()
Boolean	getFieldSupportsDonateButtonInLiveVideo()
String	getFieldThirdPartyId()
Double	getFieldTimezone()
String	getFieldTokenForBusiness()
String	getFieldUpdatedTime()
String	getFieldUsername()
String	getFieldUserStorageKey()
Boolean	getFieldVerified()
VideoUploadLimits	getFieldVideoUploadLimits()
String	getFieldWebsite()
List<Object>	getFieldWork()
User.APIRequestGetFriends	getFriends()
User.APIRequestGetGroups	getGroups()
String	getId()
User.APIRequestGetIdsForApps	getIdsForApps()
User.APIRequestGetIdsForBusiness	getIdsForBusiness()
User.APIRequestGetIdsForPages	getIdsForPages()
User.APIRequestGetLikes	getLikes()
User.APIRequestGetLiveEncoders	getLiveEncoders()
User.APIRequestGetLiveVideos	getLiveVideos()
User.APIRequestGetMusic	getMusic()
User.APIRequestGetOwnedProductCatalogs	getOwnedProductCatalogs()
static APIRequest.ResponseParser<User>	getParser()
User.APIRequestGetPermissions	getPermissions()
User.APIRequestGetPersonalAdAccounts	getPersonalAdAccounts()
User.APIRequestGetPhotos	getPhotos()
User.APIRequestGetPicture	getPicture()
User.APIRequestGetRichMediaDocuments	getRichMediaDocuments()
User.APIRequestGetVideos	getVideos()
static User	loadJSON(String json, APIContext context, String header)
static APINodeList<User>	parseResponse(String json, APIContext context, APIRequest request, String header)
void	setContext(APIContext context)
String	toString()
User.APIRequestUpdate	update()

Methods inherited from class com.facebook.ads.sdk.APINode

getException, getHeader, getRawResponse, getRawResponseAsJsonObject, getRawValue, head, parseResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

gson

protected static com.google.gson.Gson gson

Constructor Detail

User

public User(Long id,
            APIContext context)

User

public User(String id,
            APIContext context)

Method Detail

fetch

public User fetch()
           throws APIException

Throws:

APIException

fetchById

public static User fetchById(Long id,
                             APIContext context)
                      throws APIException

Throws:

APIException

fetchByIdAsync

public static com.google.common.util.concurrent.ListenableFuture<User> fetchByIdAsync(Long id,
                                                                                      APIContext context)
                                                                               throws APIException

Throws:

APIException

fetchById

public static User fetchById(String id,
                             APIContext context)
                      throws APIException

Throws:

APIException

fetchByIdAsync

public static com.google.common.util.concurrent.ListenableFuture<User> fetchByIdAsync(String id,
                                                                                      APIContext context)
                                                                               throws APIException

Throws:

APIException

fetchByIds

public static APINodeList<User> fetchByIds(List<String> ids,
                                           List<String> fields,
                                           APIContext context)
                                    throws APIException

Throws:

APIException

fetchByIdsAsync

public static com.google.common.util.concurrent.ListenableFuture<APINodeList<User>> fetchByIdsAsync(List<String> ids,
                                                                                                    List<String> fields,
                                                                                                    APIContext context)
                                                                                             throws APIException

Throws:

APIException

getId

public String getId()

Overrides:

getId in class APINode

loadJSON

public static User loadJSON(String json,
                            APIContext context,
                            String header)

parseResponse

public static APINodeList<User> parseResponse(String json,
                                              APIContext context,
                                              APIRequest request,
                                              String header)
                                       throws APIException.MalformedResponseException

Throws:

APIException.MalformedResponseException

getContext

public APIContext getContext()

Overrides:

getContext in class APINode

setContext

public void setContext(APIContext context)

Overrides:

setContext in class APINode

toString

public String toString()

Overrides:

toString in class APINode

deleteAccessTokens

public User.APIRequestDeleteAccessTokens deleteAccessTokens()

getAccounts

public User.APIRequestGetAccounts getAccounts()

createAccount

public User.APIRequestCreateAccount createAccount()

getAdStudies

public User.APIRequestGetAdStudies getAdStudies()

createAdStudy

public User.APIRequestCreateAdStudy createAdStudy()

getAdAccounts

public User.APIRequestGetAdAccounts getAdAccounts()

getAlbums

public User.APIRequestGetAlbums getAlbums()

createApplication

public User.APIRequestCreateApplication createApplication()

getAppRequestFormerRecipients

public User.APIRequestGetAppRequestFormerRecipients getAppRequestFormerRecipients()

getAppRequests

public User.APIRequestGetAppRequests getAppRequests()

getAssignedAdAccounts

public User.APIRequestGetAssignedAdAccounts getAssignedAdAccounts()

getAssignedBusinessAssetGroups

public User.APIRequestGetAssignedBusinessAssetGroups getAssignedBusinessAssetGroups()

getAssignedPages

public User.APIRequestGetAssignedPages getAssignedPages()

getAssignedProductCatalogs

public User.APIRequestGetAssignedProductCatalogs getAssignedProductCatalogs()

getBusinessUsers

public User.APIRequestGetBusinessUsers getBusinessUsers()

deleteBusinesses

public User.APIRequestDeleteBusinesses deleteBusinesses()

getBusinesses

public User.APIRequestGetBusinesses getBusinesses()

createBusiness

public User.APIRequestCreateBusiness createBusiness()

getConversations

public User.APIRequestGetConversations getConversations()

getCustomLabels

public User.APIRequestGetCustomLabels getCustomLabels()

getEvents

public User.APIRequestGetEvents getEvents()

getFeed

public User.APIRequestGetFeed getFeed()

createFeed

public User.APIRequestCreateFeed createFeed()

getFriends

public User.APIRequestGetFriends getFriends()

createGameItem

public User.APIRequestCreateGameItem createGameItem()

createGameTime

public User.APIRequestCreateGameTime createGameTime()

createGamesPlay

public User.APIRequestCreateGamesPlay createGamesPlay()

getGroups

public User.APIRequestGetGroups getGroups()

getIdsForApps

public User.APIRequestGetIdsForApps getIdsForApps()

getIdsForBusiness

public User.APIRequestGetIdsForBusiness getIdsForBusiness()

getIdsForPages

public User.APIRequestGetIdsForPages getIdsForPages()

getLikes

public User.APIRequestGetLikes getLikes()

getLiveEncoders

public User.APIRequestGetLiveEncoders getLiveEncoders()

createLiveEncoder

public User.APIRequestCreateLiveEncoder createLiveEncoder()

getLiveVideos

public User.APIRequestGetLiveVideos getLiveVideos()

createLiveVideo

public User.APIRequestCreateLiveVideo createLiveVideo()

getMusic

public User.APIRequestGetMusic getMusic()

createNotification

public User.APIRequestCreateNotification createNotification()

getOwnedProductCatalogs

public User.APIRequestGetOwnedProductCatalogs getOwnedProductCatalogs()

deletePermissions

public User.APIRequestDeletePermissions deletePermissions()

getPermissions

public User.APIRequestGetPermissions getPermissions()

getPersonalAdAccounts

public User.APIRequestGetPersonalAdAccounts getPersonalAdAccounts()

getPhotos

public User.APIRequestGetPhotos getPhotos()

createPhoto

public User.APIRequestCreatePhoto createPhoto()

getPicture

public User.APIRequestGetPicture getPicture()

getRichMediaDocuments

public User.APIRequestGetRichMediaDocuments getRichMediaDocuments()

createStagingResource

public User.APIRequestCreateStagingResource createStagingResource()

getVideos

public User.APIRequestGetVideos getVideos()

createVideo

public User.APIRequestCreateVideo createVideo()

delete

public User.APIRequestDelete delete()

get

public User.APIRequestGet get()

update

public User.APIRequestUpdate update()

getFieldAbout

public String getFieldAbout()

getFieldAddress

public Location getFieldAddress()

getFieldAdminNotes

public List<PageAdminNote> getFieldAdminNotes()

getFieldAgeRange

public AgeRange getFieldAgeRange()

getFieldAuthMethod

public String getFieldAuthMethod()

getFieldBirthday

public String getFieldBirthday()

getFieldCover

public UserCoverPhoto getFieldCover()

getFieldCurrency

public Currency getFieldCurrency()

getFieldDevices

public List<UserDevice> getFieldDevices()

getFieldEducation

public List<Object> getFieldEducation()

getFieldEmail

public String getFieldEmail()

getFieldFavoriteAthletes

public List<Experience> getFieldFavoriteAthletes()

getFieldFavoriteTeams

public List<Experience> getFieldFavoriteTeams()

getFieldFirstName

public String getFieldFirstName()

getFieldGender

public String getFieldGender()

getFieldHometown

public Page getFieldHometown()

getFieldId

public String getFieldId()

getFieldInspirationalPeople

public List<Experience> getFieldInspirationalPeople()

getFieldInstallType

public String getFieldInstallType()

getFieldInstalled

public Boolean getFieldInstalled()

getFieldInterestedIn

public List<String> getFieldInterestedIn()

getFieldIsGuestUser

public Boolean getFieldIsGuestUser()

getFieldIsVerified

public Boolean getFieldIsVerified()

getFieldLanguages

public List<Experience> getFieldLanguages()

getFieldLastName

public String getFieldLastName()

getFieldLink

public String getFieldLink()

getFieldLocalNewsMegaphoneDismissStatus

public Boolean getFieldLocalNewsMegaphoneDismissStatus()

getFieldLocalNewsSubscriptionStatus

public Boolean getFieldLocalNewsSubscriptionStatus()

getFieldLocale

public String getFieldLocale()

getFieldLocation

public Page getFieldLocation()

getFieldMeetingFor

public List<String> getFieldMeetingFor()

getFieldMessengerJoinNotificationsEnabled

public Boolean getFieldMessengerJoinNotificationsEnabled()

getFieldMiddleName

public String getFieldMiddleName()

getFieldName

public String getFieldName()

getFieldNameFormat

public String getFieldNameFormat()

getFieldPaymentPricepoints

public PaymentPricepoints getFieldPaymentPricepoints()

getFieldPolitical

public String getFieldPolitical()

getFieldProfilePic

public String getFieldProfilePic()

getFieldPublicKey

public String getFieldPublicKey()

getFieldPublishedTimeline

public Boolean getFieldPublishedTimeline()

getFieldQuotes

public String getFieldQuotes()

getFieldRelationshipStatus

public String getFieldRelationshipStatus()

getFieldReligion

public String getFieldReligion()

getFieldSharedLoginUpgradeRequiredBy

public String getFieldSharedLoginUpgradeRequiredBy()

getFieldShortName

public String getFieldShortName()

getFieldSignificantOther

public User getFieldSignificantOther()

getFieldSports

public List<Experience> getFieldSports()

getFieldSupportsDonateButtonInLiveVideo

public Boolean getFieldSupportsDonateButtonInLiveVideo()

getFieldThirdPartyId

public String getFieldThirdPartyId()

getFieldTimezone

public Double getFieldTimezone()

getFieldTokenForBusiness

public String getFieldTokenForBusiness()

getFieldUpdatedTime

public String getFieldUpdatedTime()

getFieldUserStorageKey

public String getFieldUserStorageKey()

getFieldUsername

public String getFieldUsername()

getFieldVerified

public Boolean getFieldVerified()

getFieldVideoUploadLimits

public VideoUploadLimits getFieldVideoUploadLimits()

getFieldWebsite

public String getFieldWebsite()

getFieldWork

public List<Object> getFieldWork()

copyFrom

public User copyFrom(User instance)

getParser

public static APIRequest.ResponseParser<User> getParser()