com.stripe.android

Class CustomerSession

java.lang.Object

com.stripe.android.CustomerSession

public class CustomerSession
extends java.lang.Object

Represents a logged-in session of a single Customer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CustomerSession.CustomerRetrievalListener
static interface	CustomerSession.SourceRetrievalListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_API_EXCEPTION
static java.lang.String	EVENT_SHIPPING_INFO_SAVED
static java.lang.String	EXTRA_EXCEPTION

Method Summary

Modifier and Type	Method and Description
void	addCustomerSource(android.content.Context context, java.lang.String sourceId, java.lang.String sourceType, CustomerSession.SourceRetrievalListener listener) Add the input source to the current customer object.
void	addProductUsageTokenIfValid(java.lang.String token)
void	deleteCustomerSource(android.content.Context context, java.lang.String sourceId, CustomerSession.SourceRetrievalListener listener) Delete the source from the current customer object.
static void	endCustomerSession() End the singleton instance of a CustomerSession.
Customer	getCachedCustomer() Gets a cached customer, or null if the current customer has expired.
static CustomerSession	getInstance() Gets the singleton instance of CustomerSession.
static void	initCustomerSession(EphemeralKeyProvider keyProvider) Create a CustomerSession with the provided EphemeralKeyProvider.
void	onKeyError(int errorCode, java.lang.String errorMessage)
void	onKeyUpdate(com.stripe.android.EphemeralKey ephemeralKey, java.lang.String actionString, java.util.Map<java.lang.String,java.lang.Object> arguments)
void	retrieveCurrentCustomer(CustomerSession.CustomerRetrievalListener listener) Retrieve the current Customer.
void	setCustomerDefaultSource(android.content.Context context, java.lang.String sourceId, java.lang.String sourceType, CustomerSession.CustomerRetrievalListener listener) Set the default source of the current customer object.
void	setCustomerShippingInformation(android.content.Context context, ShippingInformation shippingInformation) Set the shipping information on the current customer object.
void	updateCurrentCustomer(CustomerSession.CustomerRetrievalListener listener) Force an update of the current customer, regardless of how much time has passed.

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_API_EXCEPTION

public static final java.lang.String ACTION_API_EXCEPTION

See Also:

Constant Field Values

EXTRA_EXCEPTION

public static final java.lang.String EXTRA_EXCEPTION

See Also:

Constant Field Values

EVENT_SHIPPING_INFO_SAVED

public static final java.lang.String EVENT_SHIPPING_INFO_SAVED

See Also:

Constant Field Values

Method Detail

initCustomerSession

public static void initCustomerSession(EphemeralKeyProvider keyProvider)

Create a CustomerSession with the provided EphemeralKeyProvider.

Parameters:

keyProvider - an EphemeralKeyProvider used to get EphemeralKeys as needed

getInstance

public static CustomerSession getInstance()

Gets the singleton instance of CustomerSession. If the session has not been initialized, this will throw a RuntimeException.

Returns:

the singleton CustomerSession instance.

endCustomerSession

public static void endCustomerSession()

End the singleton instance of a CustomerSession. Calls to getInstance() will throw an IllegalStateException after this call, until the user calls initCustomerSession(EphemeralKeyProvider) again.

addProductUsageTokenIfValid

public void addProductUsageTokenIfValid(java.lang.String token)

retrieveCurrentCustomer

public void retrieveCurrentCustomer(CustomerSession.CustomerRetrievalListener listener)

Retrieve the current Customer. If the cached value at mCustomer is not stale, this returns immediately with the cache. If not, it fetches a new value and returns that to the listener.

Parameters:

listener - a CustomerSession.CustomerRetrievalListener to invoke with the result of getting the customer, either from the cache or from the server

updateCurrentCustomer

public void updateCurrentCustomer(CustomerSession.CustomerRetrievalListener listener)

Force an update of the current customer, regardless of how much time has passed.

Parameters:

listener - a CustomerSession.CustomerRetrievalListener to invoke with the result of getting the customer from the server

getCachedCustomer

public Customer getCachedCustomer()

Gets a cached customer, or null if the current customer has expired.

Returns:

the current value of mCustomer, or null if the customer object is expired.

addCustomerSource

public void addCustomerSource(android.content.Context context,
                              java.lang.String sourceId,
                              java.lang.String sourceType,
                              CustomerSession.SourceRetrievalListener listener)

Add the input source to the current customer object.

Parameters:

context - the Context to use for resources

sourceId - the ID of the source to be added

listener - a CustomerSession.SourceRetrievalListener to be notified when the api call is complete

deleteCustomerSource

public void deleteCustomerSource(android.content.Context context,
                                 java.lang.String sourceId,
                                 CustomerSession.SourceRetrievalListener listener)

Delete the source from the current customer object.

Parameters:

context - the Context to use for resources

sourceId - the ID of the source to be deleted

listener - a CustomerSession.SourceRetrievalListener to be notified when the api call is complete. The api call will return the removed source.

setCustomerShippingInformation

public void setCustomerShippingInformation(android.content.Context context,
                                           ShippingInformation shippingInformation)

Set the shipping information on the current customer object.

Parameters:

context - a Context to use for resources

shippingInformation - the data to be set

setCustomerDefaultSource

public void setCustomerDefaultSource(android.content.Context context,
                                     java.lang.String sourceId,
                                     java.lang.String sourceType,
                                     CustomerSession.CustomerRetrievalListener listener)

Set the default source of the current customer object.

Parameters:

context - a Context to use for resources

sourceId - the ID of the source to be set

listener - a CustomerSession.CustomerRetrievalListener to be notified about an update to the customer

onKeyUpdate

public void onKeyUpdate(com.stripe.android.EphemeralKey ephemeralKey,
                        java.lang.String actionString,
                        java.util.Map<java.lang.String,java.lang.Object> arguments)

onKeyError

public void onKeyError(int errorCode,
                       java.lang.String errorMessage)