IPTrainingViewController

open class IPTrainingViewController : UIViewController

View controller used for the training process. The view controller has several views which are displayed depending upon the training that needs to be performed. In addition the following views are controller:

  • Instructions view is displayed prior to training and a status view which displays the result
  • Busy view is displayed while training data is being processed.
  • Status view is displayed to report the result of the training process.

  • Called when training is completed successfully. The View that presented the training view should dismiss the training view.

    Declaration

    Swift

    public var success: ((IPTrainingViewController, Any?, IPUser) -> Void)?

  • Called when trainingfailed. The View that presented the training view should dismiss the training view.

    Declaration

    Swift

    public var failure: ((IPTrainingViewController, Any?, IPUser, Error?) -> Void)?

  • Identifier of the bundle that contains custom facial training UI (ACFacialViewController).

    Declaration

    Swift

    @IBInspectable
open var facialBundleIdentifier: String

  • The name of the nib file that contains the custom facial training UI (ACfacialViewController) The specified nib should contain a ViewController with the Custom Class property set to ACFacialViewController in the Interface Builder Identity Inspector.

    Declaration

    Swift

    @IBInspectable
open var facialNibName: String

  • Identifier of the bundle that contains custom instructions UI (ACTrainingRequiredViewController).

    Declaration

    Swift

    @IBInspectable
open var instructionsBundleIdentifier: String

  • The name of the nib file that contains the custom instructions UI (ACTrainingRequiredViewController) The specified nib should contain a ViewController with the Custom Class property set to ACTrainingRequiredViewController in the Interface Builder Identity Inspector.

    Declaration

    Swift

    @IBInspectable
open var instructionsNibName: String

  • Identifier of the bundle that contains custom status UI (ACStatusViewController).

    Declaration

    Swift

    @IBInspectable
open var statusBundleIdentifier: String

  • The name of the nib file that contains the custom status UI (ACStatusViewController) The specified nib should contain a ViewController with the Custom Class property set to ACStatusViewController in the Interface Builder Identity Inspector.

    Declaration

    Swift

    @IBInspectable
open var statusNibName: String

  • Identifier of the bundle that contains custom busy UI (ACBusyViewController).

    Declaration

    Swift

    @IBInspectable
open var busyBundleIdentifier: String

  • The name of the nib file that contains the custom busy UI (ACBusyViewController) The specified nib should contain a ViewController with the Custom Class property set to ACBusyViewController in the Interface Builder Identity Inspector.

    Declaration

    Swift

    @IBInspectable
open var busyNibName: String

  • The device being trained.

    Declaration

    Swift

    public var user: IPUser?

  • Application defined identifier for the device.

    Declaration

    Swift

    public var identifier: Any?

  • Undocumented

    Declaration

    Swift

    public static func create( user: IPUser, identifier: Any,
                           success: @escaping (_ sender: IPTrainingViewController, _ identifier:Any?, _ user:IPUser) -> Void,
                           failure: @escaping (_ sender: IPTrainingViewController, _ identifier:Any?, _ user: IPUser,_ error: Error?) -> Void) -> IPTrainingViewController?

  • Called when training is complete. Classes which derive from IPTrainingViewController can override this method to perform custom oerations.

    Declaration

    Swift

    open func trainingComplete()

  • Called when training has failed. Classes which derive from IPTrainingViewController can override this method to perform custom oerations.

    Declaration

    Swift

    open func trainingFailed()