Classes

The following classes are available globally.

  • There are multiple ways to authenticate users before accessing the encrypted user credentials (for example, generating an OTP), via the authentication module.

    The authentication module initiate the authentication service and the related authentication input represents the input value. The different authentication modes can be used independently of each other, for example if the biometric authentication mode is active on a token, then either the PIN (active by default) or biometric can be used to authenticate the user.

    Any activated authentication mode can authenticate a user. The service can only be used after it is enabled.

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMAuthModule : NSObject <EMModule>

    Swift

    class EMAuthModule : NSObject, EMModule

  • A factory for creating objects that produce or affect CAP (or its relatives) OTPs.

    See more

    Declaration

    Objective-C

    
@interface EMCapFactory : NSObject

    Swift

    class EMCapFactory : NSObject

  • This service is used to create OTPs based on the Mastercard’s Chip Authentication Program (CAP) specification. In this service, a CAP Token is equivalent to an EMV smartcard while a CAP device is an equivalent to a card reader.

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMCapService : NSObject

    Swift

    class EMCapService : NSObject

  • A class that constructs CasClient to communicate with CAS Server. This class helps to implement the E2EE password encryption, supports the creation of encrypted payload for the users when they perform operations such as setting or changing the user password, or authenticating with the user password.

    Since

    6.1.0
    See more

    Declaration

    Objective-C

    
@interface EMCasClient : NSObject

    Swift

    class EMCasClient : NSObject

  • EMCore is the entry-point of the SDK Core. EMCore takes the configurations needed for different modules and provides shared SDK functionalities.

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMCore : NSObject

    Swift

    class EMCore : NSObject

  • This class is used to create device fingerprint source settings.

    See more

    Declaration

    Objective-C

    
@interface EMDeviceFingerprintSource : NSObject

    Swift

    class EMDeviceFingerprintSource : NSObject

  • This class is used to create device fingerprint source settings that are applied to a token when it is built.

    See more

    Declaration

    Objective-C

    
@interface EMDeviceFingerprintTokenPolicy : NSObject

    Swift

    class EMDeviceFingerprintTokenPolicy : NSObject

  • Represents a DS mapping to standard CAP parameters such that verification may be done using Gemalto DSIP and any standard CAP authentication server.

    See more

    Declaration

    Objective-C

    
@interface EMDsCapParameters : NSObject

    Swift

    class EMDsCapParameters : NSObject

  • A factory for creating DS related entities.

    For information on how use custom templates and primitives, please read The Programmer’s Guide.

    See more

    Declaration

    Objective-C

    
@interface EMDsFormattingFactory : NSObject

    Swift

    class EMDsFormattingFactory : NSObject

  • DS Formatting Service

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMDsFormattingService : NSObject

    Swift

    class EMDsFormattingService : NSObject

  • DS Formatting Tools

    See more

    Declaration

    Objective-C

    
@interface EMDsFormattingTools : NSObject

    Swift

    class EMDsFormattingTools : NSObject

  • This class contains the information of the key that was provisioned.

    Since

    4.1
    See more

    Declaration

    Objective-C

    
@interface EMDskppKeyInformation : NSObject

    Swift

    class EMDskppKeyInformation : NSObject

  • The PIN policy object

    Since

    4.1
    See more

    Declaration

    Objective-C

    
@interface EMDskppPinPolicy : NSObject <EMPinPolicy>

    Swift

    class EMDskppPinPolicy : NSObject, EMPinPolicy

  • Provide an abstract class to return the features as defined by the server.

    Since

    4.1

    Declaration

    Objective-C

    
@interface EMDskppPolicy : NSObject <EMDskppPolicyProtocol>

    Swift

    class EMDskppPolicy : NSObject, EMDskppPolicyProtocol

  • Parses the token policy string.

    Since

    4.1
    See more

    Declaration

    Objective-C

    
@interface EMDskppPolicyParser : NSObject

    Swift

    class EMDskppPolicyParser : NSObject

  • Callback for 4-pass Dskpp provisioning.

    Since

    4.1
    See more

    Declaration

    Objective-C

    
@interface EMDskppProvisioningCallback : NSObject <NSObject>

    Swift

    class EMDskppProvisioningCallback : NSObject, NSObjectProtocol

  • A class representing a TLS configuration.

    Since

    4.1
    See more

    Declaration

    Objective-C

    
@interface EMDskppTlsConfiguration : NSObject

    Swift

    class EMDskppTlsConfiguration : NSObject
  • See more

    Declaration

    Objective-C

    
@interface EMEmvError : NSError

    Swift

    class EMEmvError : NSError

  • EMEmvMap.

    Since

    5.0
    See more

    Declaration

    Objective-C

    
@interface EMEmvMap<__covariant ObjectType>
    : NSMutableDictionary <NSNumber *, ObjectType>

    Swift

    class EMEmvMap<ObjectType> : NSMutableDictionary where ObjectType : AnyObject

  • Module class, which is used to instantiate a service by +[EMEmvService createServiceWithModule:] method.

    Since

    5.0
    See more

    Declaration

    Objective-C

    
@interface EMEmvModule : NSObject

    Swift

    class EMEmvModule : NSObject

  • EMEmvOptional.

    Since

    5.0
    See more

    Declaration

    Objective-C

    
@interface EMEmvOptional<__covariant ObjectType> : NSObject

    Swift

    class EMEmvOptional<ObjectType> : NSObject where ObjectType : AnyObject

  • Service class providing factory for creating decoder.

    Since

    5.0
    See more

    Declaration

    Objective-C

    
@interface EMEmvService : NSObject

    Swift

    class EMEmvService : NSObject

  • An interface representing a collection of enum type data.

    See more

    Declaration

    Objective-C

    
@interface EMEnumSet : NSObject

    Swift

    class EMEnumSet : NSObject

  • A class representing the Ezio Mobile exceptions.

    Declaration

    Objective-C

    
@interface EMException : NSException

    Swift

    class EMException : NSException

  • EMModuleConfiguration interface.

    Since

    4.0

    Declaration

    Objective-C

    
@interface EMModuleConfiguration : NSObject

    Swift

    class EMModuleConfiguration : NSObject

  • MSP Configuration

    Since

    4.5
    See more

    Declaration

    Objective-C

    
@interface EMMspConfiguration : EMModuleConfiguration

    Swift

    class EMMspConfiguration : EMModuleConfiguration

  • Msp Factory class

    See more

    Declaration

    Objective-C

    
@interface EMMspFactory : NSObject

    Swift

    class EMMspFactory : NSObject

  • Msp Field class

    The class represents the MSP field which describes the field information such as field completeness. This class also is a helper class to work with UI components for the partial input from end users.

    Since

    4.5
    See more

    Declaration

    Objective-C

    
@interface EMMspField : NSObject

    Swift

    class EMMspField : NSObject

  • Mobile Signing Protocol (MSP) Module

    Since

    4.5
    See more

    Declaration

    Objective-C

    
@interface EMMspModule : NSObject <EMModule>

    Swift

    class EMMspModule : NSObject, EMModule

  • Mobile Signing Protocol (MSP) Service

    Since

    4.5
    See more

    Declaration

    Objective-C

    
@interface EMMspService : NSObject

    Swift

    class EMMspService : NSObject

  • A factory for creating objects that produce or affect OATH (or its relatives) OTPs.

    Since

    2.2
    See more

    Declaration

    Objective-C

    
@interface EMOathFactory : NSObject

    Swift

    class EMOathFactory : NSObject

  • OathService is the entry-point for Oath features.

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMOathService : NSObject

    Swift

    class EMOathService : NSObject

  • Builder for building EMOobConfiguration object.

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMOobConfigurationBuilder : NSObject

    Swift

    class EMOobConfigurationBuilder : NSObject

  • OobConfiguration for OOB module. To be built by EMOobConfigurationBuilder

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMOobConfiguration : EMModuleConfiguration

    Swift

    class EMOobConfiguration : EMModuleConfiguration

  • Base class of custom incoming message implementation.

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMOobIncomingMessageBase : EMOobMessageBase <EMOobIncomingMessage>

    Swift

    class EMOobIncomingMessageBase : EMOobMessageBase, EMOobIncomingMessage

  • OOB Message Base

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMOobMessageBase : NSObject <EMOobMessage>

    Swift

    class EMOobMessageBase : NSObject, EMOobMessage

  • Registery of EMOobMessageHandler. Manages the registration/un-registration of EMOobMessageHandler. Incoming message and outgoing message will be parsed by registered message handlers identified by its MIME type.

    If no message handler is registered to handle a message, it will be handled internally by the SDK as a generic message.

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMOobMessageHandlerRegistry : NSObject

    Swift

    class EMOobMessageHandlerRegistry : NSObject

  • EMOobModule class which is the entry-point for OOB features.

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMOobModule : NSObject

    Swift

    class EMOobModule : NSObject

  • This object represent one notification end point. A notification end point is a mean by which a user can be notify by the Out of Band Server.

    Each notification profile contains a channel (SMS, Push, email, etc.) and an end point attached to that channel (for example an email address for the case of an email channel).

    Each channel are dependent on the deployment environment and are completely customizable by the application. Thus, no processing will be done on the channel and value strings; they will be used “as-is”.

    Since

    3.0
    See more

    Declaration

    Objective-C

    
@interface EMOobNotificationProfile : NSObject

    Swift

    class EMOobNotificationProfile : NSObject

  • Base class of custom outgoing message implementation.

    Since

    4.0

    Declaration

    Objective-C

    
@interface EMOobOutgoingMessageBase : EMOobMessageBase <EMOobOutgoingMessage>

    Swift

    class EMOobOutgoingMessageBase : EMOobMessageBase, EMOobOutgoingMessage

  • OOB registration request object.

    Since

    3.0
    See more

    Declaration

    Objective-C

    
@interface EMOobRegistrationRequest : NSObject

    Swift

    class EMOobRegistrationRequest : NSObject

  • Builder for building EMOobRequestParameter object.

    Since

    4.7
    See more

    Declaration

    Objective-C

    
@interface EMOobRequestParameterBuilder : NSObject

    Swift

    class EMOobRequestParameterBuilder : NSObject

  • EMOobRequestParameter class for configuration of additional parameters of OOB request. For 4.7, only customized HTTP headers can be added for each request. To be built by EMOobRequestParameterBuilder.

    Since

    4.7
    See more

    Declaration

    Objective-C

    
@interface EMOobRequestParameter : NSObject

    Swift

    class EMOobRequestParameter : NSObject

  • OTP Configuration

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMOtpConfiguration : EMModuleConfiguration

    Swift

    class EMOtpConfiguration : EMModuleConfiguration

  • OtpModule class which is the entry-point for OTP features.

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMOtpModule : NSObject

    Swift

    class EMOtpModule : NSObject

  • The EMOtpTools class for utility functions like OTP scrambling and formatting functions. It was originally called EMToolBox.

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMOtpTools : NSObject

    Swift

    class EMOtpTools : NSObject

  • Provides services for authentication with PIN.

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMPinAuthService : NSObject <EMAuthService>

    Swift

    class EMPinAuthService : NSObject, EMAuthService

  • A PIN rule that prevents using identical PINs.

    Since

    2.1

    Declaration

    Objective-C

    
@interface EMPinRuleIdentical : NSObject <EMPinRule>

    Swift

    class EMPinRuleIdentical : NSObject, EMPinRule

  • A PIN rule that requires a PIN’s length to be within a specific range.

    Since

    2.1
    See more

    Declaration

    Objective-C

    
@interface EMPinRuleLength : NSObject <EMPinRule>

    Swift

    class EMPinRuleLength : NSObject, EMPinRule

  • A PIN rule that prevents a PIN from being a palindrome, ex: 12321.

    Since

    2.1

    Declaration

    Objective-C

    
@interface EMPinRulePalindrome : NSObject <EMPinRule>

    Swift

    class EMPinRulePalindrome : NSObject, EMPinRule

  • A PIN rule that prevents a PIN from being a series, ex: 1234, 4321.

    Since

    2.1

    Declaration

    Objective-C

    
@interface EMPinRuleSeries : NSObject <EMPinRule>

    Swift

    class EMPinRuleSeries : NSObject, EMPinRule

  • A PIN rule that prevents a PIN from being uniform, ex: 11111.

    Since

    2.5

    Declaration

    Objective-C

    
@interface EMPinRuleUniform : NSObject <EMPinRule>

    Swift

    class EMPinRuleUniform : NSObject, EMPinRule

  • Holder class for a primitive with an associate value.

    See more

    Declaration

    Objective-C

    
@interface EMPrimitiveValue : NSObject

    Swift

    class EMPrimitiveValue : NSObject

  • EPS Configuration Builder

    See more

    Declaration

    Objective-C

    
@interface EMEpsConfigurationBuilder : NSObject

    Swift

    class EMEpsConfigurationBuilder : NSObject

  • DSKPP Configuration Builder

    See more

    Declaration

    Objective-C

    
@interface EMDskppConfigurationBuilder : NSObject

    Swift

    class EMDskppConfigurationBuilder : NSObject

  • Clear Text Secret Token Configuration Builder

    Since

    4.1
    See more

    Declaration

    Objective-C

    
@interface EMClearTextSecretTokenConfigurationBuilder : NSObject

    Swift

    class EMClearTextSecretTokenConfigurationBuilder : NSObject

  • The provisioning configuration

    See more

    Declaration

    Objective-C

    
@interface EMProvisioningConfiguration : NSObject

    Swift

    class EMProvisioningConfiguration : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface EMSecureInputEncryptionConfig : NSObject

@property (nonatomic, assign) EMSecureInputEncryptionMode encryptionMode;
@property (nonatomic, strong) NSData *publicKey;
@property (nonatomic, strong) NSData *userData;

#pragma mark Constructors

- (instancetype)init NS_UNAVAILABLE;

/**
 Constructor of Encryption configuration object. This is used to build the encrypted secure keypad
 
 @param encryptionMode Enum value for the mode of encryption
 @param publicKey      The RSA public key to be used for keys encryption.
 @param userData       A custom user data to be encrypted with public key. It can't be null and maximum size depends on key size. See Programmer's Guide for details about maximum size.
 
 @return New instance of a EMSecureInputEncryptionConfig.
 - Since: 6.2
 */
- (instancetype)initWith:(EMSecureInputEncryptionMode)encryptionMode publicKey:(NSData*)publicKey userData:(NSData*) userData NS_DESIGNATED_INITIALIZER;

@end

    Swift

    class EMSecureInputEncryptionConfig : NSObject

  • Secure Input Service

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMSecureInputService : NSObject

    Swift

    class EMSecureInputService : NSObject

  • SecureStorageModule class which is the entry-point for SecureStorage features.

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMSecureStorageModule : NSObject

    Swift

    class EMSecureStorageModule : NSObject

  • The Signature Key module.

    Since

    4.5
    See more

    Declaration

    Objective-C

    
@interface EMSignatureKey : NSObject

    Swift

    class EMSignatureKey : NSObject

  • Biometric Fingerprint Authentication Service

    Since

    4.6
    See more

    Declaration

    Objective-C

    
@interface EMSystemBioFingerprintAuthService : NSObject <EMAuthService>

    Swift

    class EMSystemBioFingerprintAuthService : NSObject, EMAuthService

  • The biometric fingerprint authentication container.

    Warning

    Do not subclass this interface.

    Since

    4.6
    See more

    Declaration

    Objective-C

    
@interface EMSystemBioFingerprintContainer : NSObject

    Swift

    class EMSystemBioFingerprintContainer : NSObject

  • The biometric Face ID authentication container.

    Warning

    Do not subclass this interface.

    Since

    4.6
    See more

    Declaration

    Objective-C

    
@interface EMSystemFaceAuthContainer : NSObject

    Swift

    class EMSystemFaceAuthContainer : NSObject

  • Native FaceID Authentication Service

    Since

    4.6
    See more

    Declaration

    Objective-C

    
@interface EMSystemFaceAuthService : NSObject <EMAuthService>

    Swift

    class EMSystemFaceAuthService : NSObject, EMAuthService

  • A class representing a Tag/Value.

    See more

    Declaration

    Objective-C

    
@interface EMTagValue : NSObject

    Swift

    class EMTagValue : NSObject

  • A class representing a TLS configuration.

    See more

    Declaration

    Objective-C

    
@interface EMTlsConfiguration : NSObject

    Swift

    class EMTlsConfiguration : NSObject

  • UI Module

    Since

    4.0
    See more

    Declaration

    Objective-C

    
@interface EMUIModule : NSObject <EMModule>

    Swift

    class EMUIModule : NSObject, EMModule

  • The class contains all parameters which is required to initialise SecureLog. Set all parameters value to this object and pass to SecureLogConfig initialise function

    See more

    Declaration

    Objective-C

    @interface SecureLogConfigComponents : NSObject

    Swift

    class SecureLogConfigComponents : NSObject

  • The class to provide initialisation function to initialise SecureLog config, it takes the parameters from SecureLogConfigComponents. All of parameters is read-only and can’t be changed after the initWithConfigComponentsBuilder function is called

    See more

    Declaration

    Objective-C

    @interface SecureLogConfig : NSObject

    Swift

    class SecureLogConfig : NSObject