ADYService Class Reference

Inherits from NSObject
Declared in ADYService.h

Overview

Provides a starting point for 3D-Secure 2.0 authentication. Used for initialization of the service and the creation of a transaction.

Note: This class corresponds to the Three3DS2Service interface in the specification.

  version

The current version of the SDK.

@property (class, nonatomic, copy, readonly) NSString *version

Discussion

The current version of the SDK.

Declared In

ADYService.h

  warnings

Array containing the warnings that were produced during initialization of the service.

@property (nonatomic, copy, readonly) NSArray<ADYWarning*> *warnings

Discussion

Array containing the warnings that were produced during initialization of the service.

Declared In

ADYService.h

+ serviceWithParameters:appearanceConfiguration:completionHandler:

Asynchronously creates a service and prepares it for creating a transaction.

+ (void)serviceWithParameters:(ADYServiceParameters *)parameters appearanceConfiguration:(nullable ADYAppearanceConfiguration *)appearanceConfiguration completionHandler:(void ( ^ ) ( ADYService *service ))completionHandler

Parameters

parameters

A collection of parameters to use during initialization of the service.

appearanceConfiguration

The configuration of the appearance of the challenge flow. When nil, a default appearance configuration is used.

completionHandler

The completion handler to invoke when the service has been initialized.

Discussion

Asynchronously creates a service and prepares it for creating a transaction.

Declared In

ADYService.h

– transactionWithMessageVersion:error:

Creates a new transaction.

- (nullable ADYTransaction *)transactionWithMessageVersion:(nullable NSString *)messageVersion error:(NSError *__nullable *__nullable)error

Parameters

messageVersion

The version of the protocol to be used during the transaction, or nil to use the latest supported version.

error

A pointer to an error object that is set to an @p NSError instance when an error occurs.

Return Value

An initialized transaction, or @p nil if a transaction could not be initialized.

Discussion

Creates a new transaction.

Declared In

ADYService.h

  )

A boolean value indicating whether the service is ready to create transactions.

@property (nonatomic, assign, readonly, getter=isReady) BOOL ready DEPRECATED_MSG_ATTRIBUTE ( "Use +serviceWithParameters:appearanceConfiguration:completionHandler: to create a service." )

Discussion

A boolean value indicating whether the service is ready to create transactions.

Declared In

ADYService.h

+ transactionWithParameters:appearanceConfiguration:completionHandler:

Asynchronously loads a service and creates a transaction. This method acts as a helper method that consolidates the two ADYService methods into one.

+ (void)transactionWithParameters:(ADYServiceParameters *)parameters appearanceConfiguration:(nullable ADYAppearanceConfiguration *)appearanceConfiguration completionHandler:(void ( ^ ) ( ADYTransaction *_Nullable transaction , NSArray<ADYWarning*> *_Nullable warnings , NSError *_Nullable error ))completionHandler

Parameters

parameters

The parameters to use when loading the service.

appearanceConfiguration

The configuration of the appearance of the challenge flow. When nil, a default appearance configuration is used.

completionHandler

The completion handler to invoke when the service has been loaded. When the transaction creation failed, the an error is given and the transaction and warnings parameters are nil.

Discussion

Asynchronously loads a service and creates a transaction. This method acts as a helper method that consolidates the two ADYService methods into one.

Declared In

ADYService.h

– loadWithParameters:appearanceConfiguration:completionHandler:

Asynchronously loads the service and prepares it for creating a transaction.

- (void)loadWithParameters:(nullable ADYServiceParameters *)parameters appearanceConfiguration:(nullable ADYAppearanceConfiguration *)appearanceConfiguration completionHandler:(void ( ^ ) ( void ))completionHandler

Parameters

parameters

A collection of parameters to use when loading the service.

appearanceConfiguration

The configuration of the appearance of the challenge flow. When nil, a default appearance configuration is used.

completionHandler

The completion handler to invoke when the service has been loaded.

Discussion

Asynchronously loads the service and prepares it for creating a transaction.

Declared In

ADYService.h

– transactionWithDirectoryServerIdentifier:messageVersion:error:

Creates a new transaction.

- (nullable ADYTransaction *)transactionWithDirectoryServerIdentifier:(nullable NSString *)directoryServerIdentifier messageVersion:(nullable NSString *)messageVersion error:(NSError *__nullable *__nullable)error

Parameters

directoryServerIdentifier

The identifier of the directory server for which to create the transaction. When nil, the directory server information is assumed to have been passed in the parameters during initialization of the service.

messageVersion

The version of the protocol to be used during the transaction, or nil to use the latest supported version.

error

A pointer to an error object that is set to an @p NSError instance when an error occurs.

Return Value

An initialized transaction, or @p nil if a transaction could not be initialized.

Discussion

Creates a new transaction.

Declared In

ADYService.h