BaseIdentifiedModel

@available(OSX 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *)
@objc(FritzBaseIdentifiedModel)
public protocol BaseIdentifiedModel : AnyObject, ReadModelProvider

This is the main entry point to exposing Fritz functionality on your Xcode-generated model classes.

Note

You should not conform your generated class to this protocol directly, instead conform to either SwiftIdentifiedModel when using Swift, or ObjcIdentifiedModel when using Objective-C.

  • The Fritz model identifier that matches this class.

    Note

    You should copy this identifier from the Fritz dashboard

    Declaration

    Swift

    @objc(fritzModelIdentifier)
    static var modelIdentifier: String { get }
  • This is the version of the model that is packaged with your application at submission time.

    Note

    As you upload newer versions of your model to the Fritz dashboard, clients will download those versions and begin using them automatically. This version is specifically for tracking the version that is installed on the device when they first download the app from the App Store. In order to maintain accurate tracking you should update this version number when you package a later version of a model into your app and resubmit to the App Store with that later version.

    Declaration

    Swift

    @objc(fritzPackagedModelVersion)
    static var packagedModelVersion: Int { get }
  • The specific version of the model requested by the SDK.

    Note

    Specifying a pinned version will override usage of the the packaged version, granting the SDK flexibility in regards to downloading different models.

    Declaration

    Swift

    @objc(fritzPinnedModelVersion)
    optional static var pinnedModelVersion: Int { get }
  • Signifies whether or not the model is encrypted.

    Declaration

    Swift

    @objc(fritzEncryptionSeed)
    optional static var encryptionSeed: [UInt8] { get }
  • A Fritz configuration encapsualtes your App Token and the Environment in which to send all Fritz-related requests.

    Declaration

    Swift

    @objc(fritzConfiguration)
    optional static var configuration: Configuration { get }
  • Specifies whether or not phone must be connected to wifi for model downloads to happen. If not set, defaults to false, models will download over cell connections.

    Declaration

    Swift

    @objc(fritzWifiRequiredForDownload)
    optional static var wifiRequiredForDownload: Bool { get }