WPConfig Class Reference

#import <WPConfig.h>

Inheritance diagram for WPConfig:

Instance Methods
(instancetype)	- initWithClientId:environment:
(instancetype)	- initWithClientId:environment:useLocation:restartCardReaderAfterSuccess:restartCardReaderAfterGeneralError:restartCardReaderAfterOtherErrors:

Properties
NSString *	clientId
NSString *	environment
BOOL	useLocation
BOOL	restartCardReaderAfterSuccess
BOOL	restartCardReaderAfterGeneralError
BOOL	restartCardReaderAfterOtherErrors

Detailed Description

The configuration object used for initializing a WePay instance.

Method Documentation

- (instancetype) initWithClientId:		(NSString *)	clientId
environment:		(NSString *)	environment

A convenience initializer

Parameters

clientId	Your WePay clientId.
environment	The environment to be used, one of (kWPEnvironmentStage, kWPEnvironmentProduction).

Returns

A WPConfig instance which can be used to initialize a WePay instance.

- (instancetype) initWithClientId:		(NSString *)	clientId
environment:		(NSString *)	environment
useLocation:		(BOOL)	useLocation
restartCardReaderAfterSuccess:		(BOOL)	restartCardReaderAfterSuccess
restartCardReaderAfterGeneralError:		(BOOL)	restartCardReaderAfterGeneralError
restartCardReaderAfterOtherErrors:		(BOOL)	restartCardReaderAfterOtherErrors

The designated initializer

Parameters

clientId	Your WePay clientId.
environment	The environment to be used, one of (kWPEnvironmentStage, kWPEnvironmentProduction).
useLocation	Flag to determine if we should use location services.
restartCardReaderAfterSuccess	Flag to determine if the card reader should automatically restart after a successful read.
restartCardReaderAfterGeneralError	Flag to determine if the card reader should automatically restart after a general error (domain:kWPErrorCategoryCardReader, errorCode:WPErrorCardReaderGeneralError).
restartCardReaderAfterOtherErrors	Flag to determine if the card reader should automatically restart after an error other than general error.

Returns

A WPConfig instance which can be used to initialize a WePay instance.

Property Documentation

- (NSString*) clientId

readnonatomicstrong

Your WePay clientId for the specified environment

- (NSString*) environment

readnonatomicstrong

The environment to be used, one of (staging, production)

- (BOOL) restartCardReaderAfterGeneralError

readwritenonatomicassign

Determines if the card reader should automatically restart after a general error (domain:kWPErrorCategoryCardReader, errorCode:WPErrorCardReaderGeneralError). Defaults to YES.

- (BOOL) restartCardReaderAfterOtherErrors

readwritenonatomicassign

Determines if the card reader should automatically restart after an error other than general error. Defaults to NO.

- (BOOL) restartCardReaderAfterSuccess

readwritenonatomicassign

Determines if the card reader should automatically restart after a successful read. Defaults to NO.

- (BOOL) useLocation

readwritenonatomicassign

Determines if we should use location services. Defaults to NO.

---

The documentation for this class was generated from the following file:

• WPConfig.h