Classes

The following classes are available globally.

  • FRAuthenticator is an abstraction layer of FRAuthenticator SDK and is responsible to create, and manage Account, and Mechanism objects with StorageClient

    See more

    Declaration

    Swift

    public class FRAClient : NSObject

  • Account represents an account information of authentication methods

    See more

    Declaration

    Swift

    public class Account : NSObject, NSSecureCoding, Codable

  • Mechanism class represents generic auth type, and is base class of all Mechanism (authentication type) in FRAuthenticator SDK

    See more

    Declaration

    Swift

    public class Mechanism : NSObject, NSSecureCoding, Codable

  • HOTPMechanism represents HMAC-based OTP Auth and is responsible for its related operation

    See more

    Declaration

    Swift

    public class HOTPMechanism : OathMechanism
  • See more

    Declaration

    Swift

    public class OathMechanism : Mechanism

  • OathTokenCode represents OTP credentials as an object generated with HOTPMechnism, and/or TOTPMechanism

    See more

    Declaration

    Swift

    public class OathTokenCode : NSObject, Codable

  • TOTPMechanism represents Time-based OTP Auth and is responsible for its related operation

    See more

    Declaration

    Swift

    public class TOTPMechanism : OathMechanism

  • PushMechanism represents PushNotification-based OTP Auth and is responsible for its related operation

    See more

    Declaration

    Swift

    public class PushMechanism : Mechanism

  • Notification class represents Push Notification message delivered to SDK (application) for registered PushMechanism

    See more

    Declaration

    Swift

    public class PushNotification : NSObject, NSSecureCoding, Codable

  • The Biometric Available policy checks if the device has enabled Biometric capabilities.

    JSON Policy format: {“biometricAvailable”: { }}

    See more

    Declaration

    Swift

    public class BiometricAvailablePolicy : FRAPolicy

  • The Device Tampering policy checks the integrity of device’s software and hardware. It uses the FRJailbreakDectector available in the FRCore framework. The class analyzes the device by using multiple device tamper detectors and returns the highest score in the range between 0.0 to 1.0 from all the detectors, indicating how likely the device is Jailbroken: 0.0 - not likely, 0.5 - likely, 1.0 -very likely.

    The policy receives the score value as parameter to use as reference on determine if the device is tampered. If the parameter is not passed, the policy will use the defaultThresholdScore.

    JSON Policy format: {“deviceTampering”: {“score”: 0.8}}

    See more

    Declaration

    Swift

    public class DeviceTamperingPolicy : FRAPolicy

  • The Policy Evaluator is used by the SDK to enforce Policy rules, such as Device Tampering Policy. It consist of one or more FRAPolicy objects. Each Policy contain instructions that determine whether it comply to a particular condition at a particular time.

    See more

    Declaration

    Swift

    public class FRAPolicyEvaluator

  • FRAPushHandler is mainly responsible to handle PushNotification activities in application layer and handling incoming Device Token, and Notification from the application.

    See more

    Declaration

    Swift

    public class FRAPushHandler : NSObject