com.paypal.sdk.models

Class VaultExperienceContext

java.lang.Object

com.paypal.sdk.models.VaultExperienceContext

public class VaultExperienceContext
extends Object

This is a model class for VaultExperienceContext type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VaultExperienceContext.Builder Class to build instances of VaultExperienceContext.

Constructor Summary

Constructors

Constructor and Description
VaultExperienceContext() Default constructor.
VaultExperienceContext(String brandName, String locale, String returnUrl, String cancelUrl, OrderApplicationContextShippingPreference shippingPreference, VaultInstructionAction vaultInstruction) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
String	getBrandName() Getter for BrandName.
String	getCancelUrl() Getter for CancelUrl.
String	getLocale() Getter for Locale.
String	getReturnUrl() Getter for ReturnUrl.
OrderApplicationContextShippingPreference	getShippingPreference() Getter for ShippingPreference.
VaultInstructionAction	getVaultInstruction() Getter for VaultInstruction.
void	setBrandName(String brandName) Setter for BrandName.
void	setCancelUrl(String cancelUrl) Setter for CancelUrl.
void	setLocale(String locale) Setter for Locale.
void	setReturnUrl(String returnUrl) Setter for ReturnUrl.
void	setShippingPreference(OrderApplicationContextShippingPreference shippingPreference) Setter for ShippingPreference.
void	setVaultInstruction(VaultInstructionAction vaultInstruction) Setter for VaultInstruction.
VaultExperienceContext.Builder	toBuilder() Builds a new VaultExperienceContext.Builder object.
String	toString() Converts this VaultExperienceContext into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

VaultExperienceContext

public VaultExperienceContext()

Default constructor.

VaultExperienceContext

public VaultExperienceContext(String brandName,
                              String locale,
                              String returnUrl,
                              String cancelUrl,
                              OrderApplicationContextShippingPreference shippingPreference,
                              VaultInstructionAction vaultInstruction)

Initialization constructor.

Parameters:

brandName - String value for brandName.

locale - String value for locale.

returnUrl - String value for returnUrl.

cancelUrl - String value for cancelUrl.

shippingPreference - OrderApplicationContextShippingPreference value for shippingPreference.

vaultInstruction - VaultInstructionAction value for vaultInstruction.

Method Detail

getBrandName

public String getBrandName()

Getter for BrandName. The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.

Returns:

Returns the String

setBrandName

public void setBrandName(String brandName)

Setter for BrandName. The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.

Parameters:

brandName - Value for String

getLocale

public String getLocale()

Getter for Locale. The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).

Returns:

Returns the String

setLocale

public void setLocale(String locale)

Setter for Locale. The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).

Parameters:

locale - Value for String

getReturnUrl

public String getReturnUrl()

Getter for ReturnUrl. The URL where the customer is redirected after customer approves leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS.

Returns:

Returns the String

setReturnUrl

public void setReturnUrl(String returnUrl)

Setter for ReturnUrl. The URL where the customer is redirected after customer approves leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS.

Parameters:

returnUrl - Value for String

getCancelUrl

public String getCancelUrl()

Getter for CancelUrl. The URL where the customer is redirected after customer cancels or leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS.

Returns:

Returns the String

setCancelUrl

public void setCancelUrl(String cancelUrl)

Setter for CancelUrl. The URL where the customer is redirected after customer cancels or leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS.

Parameters:

cancelUrl - Value for String

getShippingPreference

public OrderApplicationContextShippingPreference getShippingPreference()

Getter for ShippingPreference. The shipping preference. This only applies to PayPal payment source.

Returns:

Returns the OrderApplicationContextShippingPreference

setShippingPreference

public void setShippingPreference(OrderApplicationContextShippingPreference shippingPreference)

Setter for ShippingPreference. The shipping preference. This only applies to PayPal payment source.

Parameters:

shippingPreference - Value for OrderApplicationContextShippingPreference

getVaultInstruction

public VaultInstructionAction getVaultInstruction()

Getter for VaultInstruction. Vault Instruction on action to be performed after a successful payer approval.

Returns:

Returns the VaultInstructionAction

setVaultInstruction

public void setVaultInstruction(VaultInstructionAction vaultInstruction)

Setter for VaultInstruction. Vault Instruction on action to be performed after a successful payer approval.

Parameters:

vaultInstruction - Value for VaultInstructionAction

toString

public String toString()

Converts this VaultExperienceContext into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public VaultExperienceContext.Builder toBuilder()

Builds a new VaultExperienceContext.Builder object. Creates the instance with the state of the current model.

Returns:

a new VaultExperienceContext.Builder object