Scyther

public class Scyther

Undocumented

  • An initialised, shared instance of the Scyther class.

    Declaration

    Swift

    public static let instance: Scyther

  • Delegate instance for listening to key events and performing subsequent actions

    Declaration

    Swift

    public weak var delegate: ScytherDelegate?

  • Boolean value for controlling whether or not the Scyther library should be run on builds installed via the AppStore and builds that contain a production installation receipt. Must be set before calling Scyther.instance.start

    Declaration

    Swift

    public var runsOnProductionBuilds: Bool

  • The gesture that is to be used to invoke the Scyther menu. Defaults to shake.

    Declaration

    Swift

    public var selectedGesture: ScytherGesture

  • Toggler utility class. Used for local toggle/feature flag overrides.

    Declaration

    Swift

    public static let toggler: Toggler

  • ConfigurationSwitcher utility class. Used for local toggle/feature flag overrides.

    Declaration

    Swift

    public static let configSwitcher: ConfigurationSwitcher

  • Logger utility class. Used for local network logging.

    Declaration

    Swift

    public static let logger: Logger

  • ConsoleLogger utility class. Used for intercepting local console output.

    Declaration

    Swift

    public static let consoleLogger: ConsoleLogger

  • NotificationTester utility class. Used for testing push notification functionality.

    Declaration

    Swift

    public static let notificationTester: NotificationTester

  • InterfaceToolkit utility class. Used for overlaying UI Elements onto the running application.

    Declaration

    Swift

    public static let interfaceToolkit: InterfaceToolkit

  • Developer options that will be displayed on the main menu

    Declaration

    Swift

    public var developerOptions: [DeveloperOption]

  • 64 Character device token registered with APNS. Example: 30eee4d53612de08c61477d4503b23220d76d74efed258230ef3536afd4504f2

    Declaration

    Swift

    public var apnsToken: String?

  • Variable length device token registerd with FCM. Example: dEoOEdh9yEy5sK-BeTxzJR:APA91bH0bNeYvYadpl98frTc6FYY1DbicXc40QrTDj5aOFxPNZF-JLEGvawxWl6g9GXgZod04_UV95zBlzdYFnxByHSCcySmzyrqfPk1IQC7aIfefBTL7a3FX9dQVNnG4x1igi317YUf

    Declaration

    Swift

    public var fcmToken: String?

  • Initialises the Scyther library and sets the required data to properly intercept network calls and console logs. This will not run on Production/AppStore builds if runsOnProductionBuilds is not set to true.

    Declaration

    Swift

    public func start()

  • Convenience function for manually showing the Scyther menu. Would be used when no gesture is wanted to invoke the menu.

    Declaration

    Swift

    public static func presentMenu(from viewController: UIViewController? = nil)

  • Undocumented

    Declaration

    Swift

    public static func dismissMenu(animated: Bool, completion: (() -> Void)? = nil)