Classes

The following classes are available globally.

  • Class for communicating with the Fritz API

    See more

    Declaration

    Swift

    @available(OSX 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *)
    public final class APIClient
  • This class attemmpts to strategically batch send requests and batch retry requests on failures. The main flow of this class looks like:

    SUCCESS:

    1. Add event to queue
    2. If threshold met, flush the queue
    3. Flush was successful

    FAILURE

    1. Add event to queue
    2. If threshold met, flush the queue
    3. Flush failed
    4. Add items back into items array
    5. Stop processing queue (maintenance mode)
    6. If a healthcheck retrier is not currently waiting, create one and start waiting for a successful healthcheck

    HEALTHCHECK SUCCESS

    1. We received a successful healthcheck
    2. Start processing items again (disable maintenance mode)

    HEALTHCHECK FAILURE

    1. We received a failed healthcheck, exponential backoff and retry health check
    See more

    Declaration

    Swift

    @available(OSX 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *)
    public final class BatchedRequestQueue<Element>
  • Declaration

    Swift

    @objc(FritzConfiguration)
    public class Configuration : NSObject
  • Class representing a Fritz-related error

    Note

    You subscribe to a notification to be notified anytime an error is encountered in the SDK.

    See more

    Declaration

    Swift

    @available(OSX 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *)
    @objc(FritzError)
    public final class FritzError : NSError
  • Declaration

    Swift

    @objc(FritzCore)
    public class FritzCore : NSObject
  • Encapsualtes your App Token and the Environment in which to send all Fritz-related requests.

    Note

    By default the SDK will read your App Token from the FritzToken line in your apps Info.plist. However, by providing a Session when conforming to BaseIdentifiedModel you have the ability to use models in your app that are from different Fritz accounts. This is useful if you are an SDK author and want to include Fritz as a dependency in your SDK without affecting the end-develoeprs ability to also use Fritz with their App Token.
    See more

    Declaration

    Swift

    @available(OSX 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *)
    @objc(FritzSession)
    public final class Session : NSObject
  • Declaration

    Swift

    @objc(FritzManagedMLModel)
    public final class ManagedMLModel : MLModel
  • Declaration

    Swift

    @objc(FritzVisionImageMetadata)
    public class FritzVisionImageMetadata : NSObject
  • Represents a label for an image.

    See more

    Declaration

    Swift

    @available(OSX 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *)
    @objc(FritzVisionLabel)
    public class FritzVisionLabel : NSObject
  • Object identified in object detection model. Contains the label and corresponding BoundingBox of identified model.

    See more

    Declaration

    Swift

    @objc(FritzVisionObject)
    public class FritzVisionObject : NSObject
  • BoundingBox Contains coordinates to draw bounding boxes on images as predicted directly by the model. However, because of cropping or resizing done to accomadate model size constraints, the default values may not map to coordinates in your view. Use the toCGRect functions to convert bounding box coordinates to fit the image.

    See more

    Declaration

    Swift

    @objc(BoundingBox)
    public class BoundingBox : NSObject
  • An image or image buffer used in vision detection.

    See more

    Declaration

    Swift

    @available(OSX 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *)
    @objc(FritzVisionImage)
    public class FritzVisionImage : NSObject