STDSConfigParameters Class Reference
Inherits from | NSObject |
---|---|
Declared in | STDSConfigParameters.h |
Overview
STDSConfigParameters
represents additional configuration parameters
that can be passed to the Stripe3DS2 SDK during initialization.
There are currently no supported additional parameters and apps can
just pass [STDSConfigParameters alloc]
initWithStandardParameters
to the
STDSThreeDS2Service
instance.
– initWithStandardParameters
Convenience initializer to get an STDSConfigParameters
instance
with the default expected configuration parameters.
- (instancetype)initWithStandardParameters
Discussion
Convenience initializer to get an STDSConfigParameters
instance
with the default expected configuration parameters.
Declared In
STDSConfigParameters.h
– addParameterNamed:withValue:toGroup:
Adds the parameter to this instance.
- (void)addParameterNamed:(NSString *)paramName withValue:(NSString *)paramValue toGroup:(nullable NSString *)paramGroup
Parameters
paramName |
The name of the parameter to add |
---|---|
paramValue |
The value of the parameter to add |
paramGroup |
The group to which this parameter will be added. If |
Discussion
Adds the parameter to this instance.
Exceptions
STDSInvalidInputException |
Will throw an |
---|
Declared In
STDSConfigParameters.h
– addParameterNamed:withValue:
Adds the parameter to the default group in this instance.
- (void)addParameterNamed:(NSString *)paramName withValue:(NSString *)paramValue
Parameters
paramName |
The name of the parameter to add |
---|---|
paramValue |
The value of the parameter to add |
Discussion
Adds the parameter to the default group in this instance.
Exceptions
STDSInvalidInputException |
Will throw an |
---|
Declared In
STDSConfigParameters.h
– parameterValue:inGroup:
Returns the value for paramName
in paramGroup
or nil
if the parameter value is not set.
- (nullable NSString *)parameterValue:(NSString *)paramName inGroup:(nullable NSString *)paramGroup
Parameters
paramName |
The name of the parameter to return |
---|---|
paramGroup |
The group from which to fetch the parameter value. If |
Discussion
Returns the value for paramName
in paramGroup
or nil
if the parameter value is not set.
Exceptions
STDSInvalidInputException |
Will throw an |
---|
Declared In
STDSConfigParameters.h
– parameterValue:
Returns the value for paramName
in the default group or nil
if the parameter value is not set.
- (nullable NSString *)parameterValue:(NSString *)paramName
Parameters
paramName |
The name of the parameter to return |
---|
Discussion
Returns the value for paramName
in the default group or nil
if the parameter value is not set.
Exceptions
STDSInvalidInputException |
Will throw an |
---|
Declared In
STDSConfigParameters.h
– removeParameterNamed:fromGroup:
Removes the specified parameter from the group and returns the value or nil
if the parameter was not found.
- (nullable NSString *)removeParameterNamed:(NSString *)paramName fromGroup:(nullable NSString *)paramGroup
Parameters
paramName |
The name of the parameter to remove |
---|---|
paramGroup |
The group from which to remove this parameter. If |
Discussion
Removes the specified parameter from the group and returns the value or nil
if the parameter was not found.
Exceptions
STDSInvalidInputException |
Will throw an |
---|
Declared In
STDSConfigParameters.h
– removeParameterNamed:
Removes the specified parameter from the default group and returns the value or nil
if the parameter was not found.
- (nullable NSString *)removeParameterNamed:(NSString *)paramName
Parameters
paramName |
The name of the parameter to remove |
---|
Discussion
Removes the specified parameter from the default group and returns the value or nil
if the parameter was not found.
Exceptions
STDSInvalidInputException |
Will throw an |
---|
Declared In
STDSConfigParameters.h