EMTransactionSigningRequest

@interface EMTransactionSigningRequest : EMIncomingMessage <EMMessageMeta>

Interface of a transaction signing request from the OOB server.

Since

5.3

  • Gets the locale the message is designed for.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic) NSString *_Nonnull locale;

    Swift

    var locale: String { get }

    Return Value

    The locale.

  • Gets message subject

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic) NSString *_Nonnull subject;

    Swift

    var subject: String { get }

    Return Value

    The subject.

  • Gets the OTP type

    Declaration

    Objective-C

    @property (readonly, nonatomic) EMTransactionSigningOtpMode otpMode;

    Swift

    var otpMode: EMTransactionSigningOtpMode { get }

    Return Value

    OTP type of the transaction signing request.

  • Returns the User Token Identifier (UTI).

    The UTI is an unsigned value ranging from 0x00 to 0xFF (i.e. 0 to 255). It is generated by the provisioning server and is part of the credential pushed during provisioning. It is guaranteed that two tokens for the same end-user (on authentication server) and from the same EPS domain will never have the same UTI. See the Enrollment and Provisioning Server documentation for domains configuration description.

    The UTI is defined only if the token has been created with Provisioning Protocol V3 or V5. When the token has been created with Provisioning Protocol V1 or V2 the method returns -1.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSInteger userTokenIdForSigning;

    Swift

    var userTokenIdForSigning: Int { get }

    Return Value

    The user token id, -1 if none.

  • Gets the CAP OTP challenge The challenge is used for CAP Mode1 and Mode3.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, nullable) NSString *capChallenge;

    Swift

    var capChallenge: String? { get }

    Return Value

    challenge of the transaction signing request.

  • Gets the CAP OTP amount The challenge is used for CAP Mode1.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, nullable) NSString *capAmount;

    Swift

    var capAmount: String? { get }

    Return Value

    amount of the transaction signing request.

  • Gets the CAP OTP currency The challenge is used for CAP Mode1.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, nullable) NSString *capCurrency;

    Swift

    var capCurrency: String? { get }

    Return Value

    currency of the transaction signing request.

  • Gets the CAP OTP signing data for CAP Mode2_TDS. Data should only contain digits, maximum 10 digit per data and maximum 10.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, nullable) NSMutableArray *capData;

    Swift

    @NSCopying var capData: NSMutableArray? { get }

    Return Value

    signing data of the transaction signing request.

  • Gets the OCRA OTP server challenge This value is available only if the Otp Mode is OCRA.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, nullable) NSData *ocraServerChallenge;

    Swift

    var ocraServerChallenge: Data? { get }

    Return Value

    OCRA server challenge of the transaction signing request.

  • Gets the OCRA OTP client challenge This value is available only if the Otp Mode is OCRA.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, nullable) NSString *ocraClientChallenge;

    Swift

    var ocraClientChallenge: String? { get }

    Return Value

    OCRA client challenge of the transaction signing request.

  • Gets the OCRA OTP password hash This value is available only if the Otp Mode is OCRA. It depends on the the OCRA suite if password hash is used.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, nullable) NSData *ocraPasswordHash;

    Swift

    var ocraPasswordHash: Data? { get }

    Return Value

    OCRA password hash of the transaction signing request.

  • Gets the OCRA OTP session data This value is available only if the Otp Mode is OCRA.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, nullable) NSString *ocraSession;

    Swift

    var ocraSession: String? { get }

    Return Value

    OCRA session data of the transaction signing request.

  • Creates an outgoing response for this transaction signing request message.

    Declaration

    Objective-C

    - (nonnull EMOutgoingMessage *)
    createWithResponse:(EMTransactionSigningResponseValue)aResponse
                   otp:(nullable NSString *)otp
                  meta:(nullable NSDictionary *)aMeta;

    Swift

    func create(response aResponse: EMTransactionSigningResponseValue, otp: String?, meta aMeta: [AnyHashable : Any]?) -> EMOutgoingMessage

    Parameters

    aResponse

    The response to provide to the transaction. See enum EMTransactionSigningResponseValue.
    otp

    The OTP to send over to OOB server. Can be nilonly if user denied the transaction.
    aMeta

    The metadata for the message.

    Return Value

    The outgoing message ready to be sent.