Userinfo (rest-api-sdk 1.14.0 API)

java.lang.Object
- com.paypal.base.rest.PayPalModel
- - com.paypal.base.rest.PayPalResource
  - - com.paypal.api.openidconnect.Userinfo

public class Userinfo
extends PayPalResource

Class Userinfo

Constructor Summary

Constructors
Constructor and Description

Userinfo()

Constructors
Constructor and Description
`Userinfo()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAccountType()` Account type.
`Address`	`getAddress()` End-User's preferred address.
`java.lang.String`	`getAgeRange()` Account holder age range.
`java.lang.String`	`getBirthdate()` Deprecated. PayPal API returns 'birthday', use that instead
`java.lang.String`	`getBirthday()` End-User's birthday, represented as an YYYY-MM-DD format.
`java.lang.String`	`getEmail()` End-User's preferred e-mail address.
`java.lang.Boolean`	`getEmailVerified()` True if the End-User's e-mail address has been verified; otherwise false.
`java.lang.String`	`getFamilyName()` Surname(s) or last name(s) of the End-User.
`java.lang.String`	`getGender()` End-User's gender.
`java.lang.String`	`getGivenName()` Given name(s) or first name(s) of the End-User
`java.lang.String`	`getLocale()` End-User's locale.
`java.lang.String`	`getMiddleName()` Middle name(s) of the End-User.
`java.lang.String`	`getName()` End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
`java.lang.String`	`getPayerId()` Account payer identifier.
`java.lang.String`	`getPhoneNumber()` End-User's preferred telephone number.
`java.lang.String`	`getPicture()` URL of the End-User's profile picture.
`java.lang.String`	`getSub()` Subject - Identifier for the End-User at the Issuer.
`java.lang.String`	`getUserId()` Subject - Identifier for the End-User at the Issuer.
`static Userinfo`	`getUserinfo(APIContext apiContext)` Returns user details
`static Userinfo`	`getUserinfo(java.lang.String accessToken)` Deprecated. Please use `getUserinfo(APIContext)` instead.
`java.lang.Boolean`	`getVerifiedAccount()` Verified account status.
`java.lang.String`	`getZoneinfo()` Time zone database representing the End-User's time zone
`void`	`setAccountType(java.lang.String accountType)` Account type.
`void`	`setAddress(Address address)` End-User's preferred address.
`void`	`setAgeRange(java.lang.String ageRange)` Account holder age range.
`void`	`setBirthdate(java.lang.String birthdate)` Deprecated. PayPal API returns 'birthday', use that instead
`void`	`setBirthday(java.lang.String birthday)` End-User's birthday, represented as an YYYY-MM-DD format.
`void`	`setEmail(java.lang.String email)` End-User's preferred e-mail address.
`void`	`setEmailVerified(java.lang.Boolean emailVerified)` True if the End-User's e-mail address has been verified; otherwise false.
`void`	`setFamilyName(java.lang.String familyName)` Surname(s) or last name(s) of the End-User.
`void`	`setGender(java.lang.String gender)` End-User's gender.
`void`	`setGivenName(java.lang.String givenName)` Given name(s) or first name(s) of the End-User
`void`	`setLocale(java.lang.String locale)` End-User's locale.
`void`	`setMiddleName(java.lang.String middleName)` Middle name(s) of the End-User.
`void`	`setName(java.lang.String name)` End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
`void`	`setPayerId(java.lang.String payerId)` Account payer identifier.
`void`	`setPhoneNumber(java.lang.String phoneNumber)` End-User's preferred telephone number.
`void`	`setPicture(java.lang.String picture)` URL of the End-User's profile picture.
`void`	`setSub(java.lang.String sub)` Subject - Identifier for the End-User at the Issuer.
`void`	`setUserId(java.lang.String userId)` Subject - Identifier for the End-User at the Issuer.
`void`	`setVerifiedAccount(java.lang.Boolean verifiedAccount)` Verified account status.
`void`	`setZoneinfo(java.lang.String zoneinfo)` Time zone database representing the End-User's time zone

Methods inherited from class com.paypal.base.rest.PayPalResource
configureAndExecute, configureAndExecute, configureAndExecute, configureAndExecute, createAPICallPreHandler, getClientCredential, getClientID, getClientSecret, getConfigurations, getCredential, getLastRequest, getLastResponse, getOAuthTokenCredential, initConfig, initConfig, initConfig, initializeToDefault

Methods inherited from class com.paypal.base.rest.PayPalModel
canEqual, equals, hashCode, toJSON, toString

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

- Constructor Detail
  - Userinfo
```
public Userinfo()
```
- Method Detail
  - getBirthdate
```
@Deprecated
public java.lang.String getBirthdate()
```
    Deprecated. PayPal API returns 'birthday', use that instead
    
    Returns:
    
    End-User's birthday, represented as an YYYY-MM-DD format
  - setBirthdate
```
@Deprecated
public void setBirthdate(java.lang.String birthdate)
```
    Deprecated. PayPal API returns 'birthday', use that instead
    
    Parameters:
    
    birthdate - End-User's birthday, represented as an YYYY-MM-DD format
  - getUserinfo
```
public static Userinfo getUserinfo(java.lang.String accessToken)
                            throws PayPalRESTException
```
    Deprecated. Please use getUserinfo(APIContext) instead.
    
    Returns user details
    
    Parameters:
    
    accessToken - access token
    
    Returns:
    
    Userinfo
    
    Throws:
    
    PayPalRESTException
  - getUserinfo
```
public static Userinfo getUserinfo(APIContext apiContext)
                            throws PayPalRESTException
```
    Returns user details
    
    Parameters:
    
    apiContext - APIContext to be used for the call.
    
    Returns:
    
    Userinfo
    
    Throws:
    
    PayPalRESTException
  - getUserId
```
public java.lang.String getUserId()
```
    Subject - Identifier for the End-User at the Issuer.
  - getSub
```
public java.lang.String getSub()
```
    Subject - Identifier for the End-User at the Issuer.
  - getName
```
public java.lang.String getName()
```
    End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
  - getGivenName
```
public java.lang.String getGivenName()
```
    Given name(s) or first name(s) of the End-User
  - getFamilyName
```
public java.lang.String getFamilyName()
```
    Surname(s) or last name(s) of the End-User.
  - getMiddleName
```
public java.lang.String getMiddleName()
```
    Middle name(s) of the End-User.
  - getPicture
```
public java.lang.String getPicture()
```
    URL of the End-User's profile picture.
  - getEmail
```
public java.lang.String getEmail()
```
    End-User's preferred e-mail address.
  - getEmailVerified
```
public java.lang.Boolean getEmailVerified()
```
    True if the End-User's e-mail address has been verified; otherwise false.
  - getGender
```
public java.lang.String getGender()
```
    End-User's gender.
  - getBirthday
```
public java.lang.String getBirthday()
```
    End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.
  - getZoneinfo
```
public java.lang.String getZoneinfo()
```
    Time zone database representing the End-User's time zone
  - getLocale
```
public java.lang.String getLocale()
```
    End-User's locale.
  - getPhoneNumber
```
public java.lang.String getPhoneNumber()
```
    End-User's preferred telephone number.
  - getAddress
```
public Address getAddress()
```
    End-User's preferred address.
  - getVerifiedAccount
```
public java.lang.Boolean getVerifiedAccount()
```
    Verified account status.
  - getAccountType
```
public java.lang.String getAccountType()
```
    Account type.
  - getAgeRange
```
public java.lang.String getAgeRange()
```
    Account holder age range.
  - getPayerId
```
public java.lang.String getPayerId()
```
    Account payer identifier.
  - setUserId
```
public void setUserId(java.lang.String userId)
```
    Subject - Identifier for the End-User at the Issuer.
  - setSub
```
public void setSub(java.lang.String sub)
```
    Subject - Identifier for the End-User at the Issuer.
  - setName
```
public void setName(java.lang.String name)
```
    End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
  - setGivenName
```
public void setGivenName(java.lang.String givenName)
```
    Given name(s) or first name(s) of the End-User
  - setFamilyName
```
public void setFamilyName(java.lang.String familyName)
```
    Surname(s) or last name(s) of the End-User.
  - setMiddleName
```
public void setMiddleName(java.lang.String middleName)
```
    Middle name(s) of the End-User.
  - setPicture
```
public void setPicture(java.lang.String picture)
```
    URL of the End-User's profile picture.
  - setEmail
```
public void setEmail(java.lang.String email)
```
    End-User's preferred e-mail address.
  - setEmailVerified
```
public void setEmailVerified(java.lang.Boolean emailVerified)
```
    True if the End-User's e-mail address has been verified; otherwise false.
  - setGender
```
public void setGender(java.lang.String gender)
```
    End-User's gender.
  - setBirthday
```
public void setBirthday(java.lang.String birthday)
```
    End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.
  - setZoneinfo
```
public void setZoneinfo(java.lang.String zoneinfo)
```
    Time zone database representing the End-User's time zone
  - setLocale
```
public void setLocale(java.lang.String locale)
```
    End-User's locale.
  - setPhoneNumber
```
public void setPhoneNumber(java.lang.String phoneNumber)
```
    End-User's preferred telephone number.
  - setAddress
```
public void setAddress(Address address)
```
    End-User's preferred address.
  - setVerifiedAccount
```
public void setVerifiedAccount(java.lang.Boolean verifiedAccount)
```
    Verified account status.
  - setAccountType
```
public void setAccountType(java.lang.String accountType)
```
    Account type.
  - setAgeRange
```
public void setAgeRange(java.lang.String ageRange)
```
    Account holder age range.
  - setPayerId
```
public void setPayerId(java.lang.String payerId)
```
    Account payer identifier.

Class Userinfo

Constructor Summary

Method Summary

Methods inherited from class com.paypal.base.rest.PayPalResource

Methods inherited from class com.paypal.base.rest.PayPalModel

Methods inherited from class java.lang.Object

Constructor Detail

Userinfo

Method Detail

getBirthdate

setBirthdate

getUserinfo

getUserinfo

getUserId

getSub

getName

getGivenName

getFamilyName

getMiddleName

getPicture

getEmail

getEmailVerified

getGender

getBirthday

getZoneinfo

getLocale

getPhoneNumber

getAddress

getVerifiedAccount

getAccountType

getAgeRange

getPayerId

setUserId

setSub

setName

setGivenName

setFamilyName

setMiddleName

setPicture

setEmail

setEmailVerified

setGender

setBirthday

setZoneinfo

setLocale

setPhoneNumber

setAddress

setVerifiedAccount

setAccountType

setAgeRange

setPayerId