Enumerations

The following enumerations are available globally.

  • Physical position of camera’s hardware on the system.

    See more

    Declaration

    Objective-C

    enum RFSCameraPosition : NSInteger {}

    Swift

    @frozen enum CameraPosition : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, RFSCameraToolbarViewState) {
        RFSCameraToolbarViewStateFront,
        RFSCameraToolbarViewStateRear,
    }

    Swift

    enum CameraToolbarViewState : Int, @unchecked Sendable
  • Tags can be used to override SDK’s camera view controller buttons. Hide overroden button via RGLFunctionality.

    See more

    Declaration

    Objective-C

    enum RFSCustomButtonTag : NSInteger {}
  • Error codes for the RFSDetectFacesResponse errors.

    See more

    Declaration

    Objective-C

    enum RFSDetectFacesErrorCode : NSInteger {}

    Swift

    typealias DetectFacesError.Code._ErrorType = DetectFacesError
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, RFSFaceCaptureContentViewState) {
        RFSFaceCaptureContentViewStateFront,
        RFSFaceCaptureContentViewStateRear,
    }

    Swift

    enum FaceCaptureContentViewState : Int, @unchecked Sendable
  • Error codes for the RFSFaceCaptureResponse errors.

    See more

    Declaration

    Objective-C

    enum RFSFaceCaptureErrorCode : NSInteger {}

    Swift

    typealias FaceCaptureError.Code._ErrorType = FaceCaptureError
  • Liveness process statuses.

    See more

    Declaration

    Objective-C

    enum RFSLivenessProcessStatus : NSUInteger {}

    Swift

    enum LivenessProcessStatus : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ERROR_ENUM(RFSFaceErrorDomain, RFSFaceErrorCode) {
        RFSFaceErrorAlreadyRunning,
        RFSFaceErrorMissingCore,
        RFSFaceErrorInternalCoreError,
        RFSFaceErrorBadLicense,
        RFSFaceErrorUnavailable
    }

    Swift

    typealias FaceError.Code._ErrorType = FaceError
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, RFSHintViewState) {
        RFSHintViewStateFront,
        RFSHintViewStateRear,
    }

    Swift

    enum HintViewState : Int, @unchecked Sendable
  • Image Quality charactestic group

    See more

    Declaration

    Objective-C

    enum RFSImageQualityGroup : NSInteger {}

    Swift

    enum ImageQualityGroup : Int, @unchecked Sendable
  • The assessment status of Image Quality Characteristic

    See more

    Declaration

    Objective-C

    enum RFSImageQualityResultStatus : NSInteger {}
  • The image type of RFSImage influences matching results and provides the information about the source of the image.

    See more

    Declaration

    Objective-C

    enum RFSImageType : NSInteger {}

    Swift

    enum ImageType : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_OPTIONS(NSUInteger, RFSLivenessStepSkip) {
        RFSLivenessStepSkipNone         = 0,        // default
        RFSLivenessStepSkipOnboarding   = 1 << 0,   // don't show liveness onboarding screen
        RFSLivenessStepSkipSuccess      = 1 << 1    // don't show liveness success screen
    }

    Swift

    struct RFSLivenessStepSkip : OptionSet, @unchecked Sendable
  • Error codes for the RFSLivenessResponse errors.

    See more

    Declaration

    Objective-C

    enum RFSLivenessErrorCode : NSInteger {}

    Swift

    typealias LivenessError.Code._ErrorType = LivenessError
  • The status of the Liveness processing.

    See more

    Declaration

    Objective-C

    enum RFSLivenessStatus : NSUInteger {}

    Swift

    enum LivenessStatus : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, RFSLivenessType) {
        RFSLivenessTypeActive,
        RFSLivenessTypePassive
    }

    Swift

    @frozen enum LivenessType : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, RFSProcessingMode) {
        RFSProcessingModeOnline,
        RFSProcessingModeOffline
    }
  • Error codes for the RFSMatchFacesResponse errors.

    See more

    Declaration

    Objective-C

    enum RFSMatchFacesErrorCode : NSInteger {}

    Swift

    typealias MatchFacesError.Code._ErrorType = MatchFacesError
  • The AspectRatio according to which alignment is performed

    See more

    Declaration

    Objective-C

    enum RFSOutputImageCropAspectRatio : NSUInteger {}

    Swift

    enum AspectRatio : UInt, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ERROR_ENUM(RFSPersonDatabaseErrorDomain, RFSPersonDatabaseErrorCode) {
      RFSPersonDatabaseErrorCodeAPIFailed
    }

    Swift

    typealias PersonDatabase.Error.Code._ErrorType = PersonDatabase.Error
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_CLOSED_ENUM(NSInteger, RFSRecordingProcess) {
        /// Video will be recorded and send in parallel with the main request to liveness service.
        RFSRecordingProcessAsynchronousUpload,
        /// Video will be recorded, packaged and sent in one request to liveness service.
        RFSRecordingProcessSynchronousUpload,
        /// Video will not be recorder.
        RFSRecordingProcessNotUpload
    }

    Swift

    @frozen enum RecordingProcess : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, RFSCustomizationColor) {
        OnboardingScreenStartButtonBackground = 100,
        OnboardingScreenStartButtonTitle = 101,
        OnboardingScreenBackground = 102,
        OnboardingScreenTitleLabelText = 103,
        OnboardingScreenSubtitleLabelText = 104,
        OnboardingScreenMessageLabelsText = 105,
        
        CameraScreenStrokeNormal = 200,
        CameraScreenStrokeActive = 201,
        CameraScreenSectorTarget = 202,
        CameraScreenSectorActive = 203,
        CameraScreenFrontHintLabelBackground = 204,
        CameraScreenFrontHintLabelText = 205,
        CameraScreenBackHintLabelBackground = 206,
        CameraScreenBackHintLabelText = 207,
        CameraScreenLightToolbarTint = 208,
        CameraScreenDarkToolbarTint = 209,
        
        RetryScreenBackground = 300,
        RetryScreenRetryButtonBackground = 301,
        RetryScreenRetryButtonTitle = 302,
        RetryScreenTitleLabelText = 303,
        RetryScreenSubtitleLabelText = 304,
        RetryScreenHintLabelsText = 305,
        
        ProcessingScreenBackground = 400,
        ProcessingScreenProgress = 401,
        ProcessingScreenTitleLabel = 402,
        
        SuccessScreenBackground = 500
    }

    Swift

    enum CustomizationColor : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, RFSCustomizationImage) {
        OnboardingScreenCloseButton = 100,
        OnboardingScreenIllumination = 101,
        OnboardingScreenAccessories = 102,
        OnboardingScreenCameraLevel = 103,
        
        CameraScreenCloseButton = 200,
        CameraScreenLightOnButton = 201,
        CameraScreenLightOffButton = 202,
        CameraScreenSwitchButton = 203,
        
        RetryScreenCloseButton = 300,
        RetryScreenHintEnvironment = 301,
        RetryScreenHintSubject = 302,
        
        ProcessingScreenCloseButton = 400,
        
        SuccessScreenImage = 500,
    }

    Swift

    enum CustomizationImage : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, RFSCustomizationFont) {
        OnboardingScreenStartButton = 100,
        OnboardingScreenTitleLabel = 101,
        OnboardingScreenSubtitleLabel = 102,
        OnboardingScreenMessageLabels = 103,
        
        CameraScreenHintLabel = 200,
        
        RetryScreenRetryButton = 300,
        RetryScreenTitleLabel = 301,
        RetryScreenSubtitleLabel = 302,
        RetryScreenHintLabels = 303,
        
        ProcessingScreenLabel = 400
    }

    Swift

    enum CustomizationFont : Int, @unchecked Sendable