Classes
The following classes are available globally.
-
Base class for creating immutable configuration objects.
See moreDeclaration
Objective-C
@interface RFSBaseConfiguration<T : __kindof RFSBaseConfigurationBuilder *> : NSObject
Swift
class BaseConfiguration<T> : NSObject where T : BaseConfigurationBuilder
-
Base class for creating immutable configuration objects. This is a mutable part that is configured in the
See morebuilderBlock
of theRFSBaseConfiguration
.Declaration
Objective-C
@interface RFSBaseConfigurationBuilder : NSObject
Swift
class BaseConfigurationBuilder : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSCameraToolbarView : UIView <RFSOverriding> @property(readwrite, nonatomic, assign) RFSCameraToolbarViewState state; #pragma mark - Overriding /// Defaults to not `nil`. Can be overriden directly or set to `nil` to hide a button from the toolbar. @property(readonly, nonatomic, nullable) UIButton *torchButton; /// Defaults to not `nil`. Can be overriden directly or set to `nil` to hide a button from the toolbar. @property(readonly, nonatomic, nullable) UIButton *switchCameraButton; /// Defaults to not `nil`. Can be overriden directly or set to `nil` to hide a button from the toolbar. @property(readonly, nonatomic, nullable) UIButton *closeButton; /// Setups default constraints. Can be overriden to provide custom layout constraints. - (void)setupConstraints; /// Updates CameraToolbarView state. Called when `state` propperty is changed. /// Can be overriden to provide custom appearance for different states of ToolbarView. - (void)updateState:(RFSCameraToolbarViewState)state; #pragma mark - Styling - (void)setTintColor:(nullable UIColor *)color forState:(RFSCameraToolbarViewState)state UI_APPEARANCE_SELECTOR; - (nullable UIColor *)tintColorForState:(RFSCameraToolbarViewState)state UI_APPEARANCE_SELECTOR; @end
Swift
class CameraToolbarView : UIView, Overriding
-
RFSMatchFacesRequest
compares two or more images with faces on them to find out the similarity of pairs.The request is used as a parameter to
See more-[RFSFaceSDK matchFaces:completion:]
.Declaration
Objective-C
@interface RFSMatchFacesRequest : NSObject
Swift
class MatchFacesRequest : NSObject
-
The response from the
See moreRFSMatchFacesRequest
.Declaration
Objective-C
@interface RFSMatchFacesResponse : NSObject
Swift
class MatchFacesResponse : NSObject
-
See moreRFSMatchFacesComparedFace
represents a reference information of the compared face.Declaration
Objective-C
@interface RFSMatchFacesComparedFace : NSObject
Swift
class MatchFacesComparedFace : NSObject
-
The Image class wraps regular
See moreUIImage
and provides more information to the input and output data.Declaration
Objective-C
@interface RFSImage : NSObject
Swift
class Image : NSObject
-
Mutable builder part of the
See moreRFSFaceCaptureConfiguration
.Declaration
Objective-C
@interface RFSFaceCaptureConfigurationBuilder : RFSBaseConfigurationBuilder
Swift
class FaceCaptureConfigurationBuilder : BaseConfigurationBuilder
-
Configuration for the FaceCapture.
This class is used as a parameters for
See more-[RFSFaceSDK presentFaceCaptureViewControllerFrom:animated:configuration:onCapture:completion:]
. The configuration provides convenient properties to change the behavior and the appearance of the FaceCapture UI module.Declaration
Objective-C
@interface RFSFaceCaptureConfiguration : RFSBaseConfiguration <RFSFaceCaptureConfigurationBuilder *> <NSObject>
Swift
class FaceCaptureConfiguration : BaseConfiguration<FaceCaptureConfigurationBuilder>, NSObjectProtocol
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSFaceCaptureContentView : RFSPassthroughView <RFSOverriding>
Swift
class FaceCaptureContentView : PassthroughView, Overriding
-
The response from the Face Capture module. This object contains either an image or an error.
See moreDeclaration
Objective-C
@interface RFSFaceCaptureResponse : NSObject
Swift
class FaceCaptureResponse : NSObject
-
The entry point to the Face SDK features.
See moreDeclaration
Objective-C
@interface RFSFaceSDK : NSObject
Swift
class FaceSDK : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSHintView : UIView @property(readwrite, nonatomic, assign) RFSHintViewState state; @property(readwrite, nonatomic, strong, nullable) NSString *text; #pragma mark - Styling @property(readwrite, nonatomic, assign) CGFloat cornerRadius UI_APPEARANCE_SELECTOR; - (void)setTextColor:(nullable UIColor *)color forState:(RFSHintViewState)state UI_APPEARANCE_SELECTOR; - (nullable UIColor *)textColorForState:(RFSHintViewState)state UI_APPEARANCE_SELECTOR; - (void)setBackgroundColor:(nullable UIColor *)color forState:(RFSHintViewState)state UI_APPEARANCE_SELECTOR; - (nullable UIColor *)backgroundColorForState:(RFSHintViewState)state UI_APPEARANCE_SELECTOR; @end
Swift
class HintView : UIView
-
Mutable builder part of the
See moreRFSLivenessConfiguration
.Declaration
Objective-C
@interface RFSLivenessConfigurationBuilder : RFSBaseConfigurationBuilder
Swift
class LivenessConfigurationBuilder : BaseConfigurationBuilder
-
Configuration for the Liveness processing.
This class is used as a parameters for
See more-[RFSFaceSDK startLivenessFrom:animated:configuration:onLiveness:completion:]
. The configuration provides convenient properties to change the behavior and the appearance of the Liveness UI module.Declaration
Objective-C
@interface RFSLivenessConfiguration : RFSBaseConfiguration <RFSLivenessConfigurationBuilder *> <NSObject>
Swift
class LivenessConfiguration : BaseConfiguration<LivenessConfigurationBuilder>, NSObjectProtocol
-
Undocumented
See moreDeclaration
Objective-C
@interface RFSLivenessContentView : RFSPassthroughView <RFSOverriding>
Swift
class LivenessContentView : PassthroughView, Overriding
-
The response from the Liveness module.
See moreDeclaration
Objective-C
@interface RFSLivenessResponse : NSObject
Swift
class LivenessResponse : NSObject
-
See moreRFSMatchFacesComparedFacesPair
represents a result of theRFSMatchFacesRequest
attempt to compare input images.Declaration
Objective-C
@interface RFSMatchFacesComparedFacesPair : NSObject
Swift
class MatchFacesComparedFacesPair : NSObject
-
See moreRFSMatchFacesDetection
represents detection results on an input image as a part ofRFSMatchFacesResponse
.Declaration
Objective-C
@interface RFSMatchFacesDetection : NSObject
Swift
class MatchFacesDetection : NSObject
-
See moreRFSMatchFacesDetectionFace
represents face detection information as a part ofRFSMatchFacesResponse
.Declaration
Objective-C
@interface RFSMatchFacesDetectionFace : NSObject
Swift
class MatchFacesDetectionFace : NSObject
-
This class represents the input image and its attributes for
See moreRFSMatchFacesRequest
.Declaration
Objective-C
@interface RFSMatchFacesImage : NSObject
Swift
class MatchFacesImage : NSObject
-
See moreRFSMatchFacesSimilarityThresholdSplit
is a result of a splits operation Use splitPairs operation on matched faces pairs with similarityThreshold to split the results into matched and unmatched groups.Declaration
Objective-C
@interface RFSMatchFacesSimilarityThresholdSplit : NSObject
Swift
class MatchFacesSimilarityThresholdSplit : NSObject
-
The view that will only handle subview’s touch events. Other events are passed through.
Declaration
Objective-C
@interface RFSPassthroughView : UIView
Swift
class PassthroughView : UIView
-
Point class represents a two number X, Y value.
See moreDeclaration
Objective-C
@interface RFSPoint : NSObject
Swift
class Point : NSObject