API reference

package pl.leancode.flitz.loader

// Entry point for download links. Shows the sign-in (with sign-in), download,
// and error screens, and starts BundleRunnerActivity once a bundle passes the
// loader's checks. Registered in the AAR manifest (exported, singleTask) for
// <scheme>://download links, in the loader's own ":flitz" process and task.
public open class BundleLoaderActivity : AppCompatActivity {
    public companion object {
        // Action of the local-file entry; the path goes in EXTRA_FILE_PATH.
        public const val ACTION_LOAD_FILE: String = "pl.leancode.flitz.loader.action.LOAD_FILE"
        // String extra: the filesystem path of the .flitz to load.
        public const val EXTRA_FILE_PATH: String = "pl.leancode.flitz.loader.extra.FILE_PATH"
    }
}

// Hosts the bundle's Flutter engine and FlutterView, in the ":flitz" process.
// Registered in the AAR manifest with no intent filter. Not launched directly —
// BundleLoaderActivity starts it, and leaving it tears the engine down and
// removes the bundle's extracted files.
public open class BundleRunnerActivity : AppCompatActivity

// The panel. Registered in the AAR manifest (exported) for
// <scheme>://flitz-panel links, in the ":flitz" process and task. Without
// sign-in it finishes at once, showing nothing.
public class PanelActivity : AppCompatActivity

// Open a download link of any scheme; the `download` host decides.
startActivity(
    Intent(this, BundleLoaderActivity::class.java)
        .setAction(Intent.ACTION_VIEW)
        .setData(Uri.parse(downloadLink))
)

// Open the panel (needs sign-in).
startActivity(Intent(this, PanelActivity::class.java))

// Drop-in app delegate base class; subclass this instead of FlutterAppDelegate.
// Routes the loader's URLs received via application(_:open:options:). A
// download URL — or a flitz-panel URL, with sign-in — hands the app's window to
// the loader and shuts down your app's own Flutter engine.
open class BundleLoaderAppDelegate: FlutterAppDelegate, FlutterImplicitEngineDelegate {
    // If you override it, return super's result, as Flutter's template does.
    open override func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
    ) -> Bool

    open override func application(
        _ application: UIApplication,
        open url: URL,
        options: [UIApplication.OpenURLOptionsKey: Any] = [:]
    ) -> Bool

    // Implemented by the loader; not overridable. Calls registerHostPlugins(with:).
    public func didInitializeImplicitFlutterEngine(_ engineBridge: FlutterImplicitEngineBridge)

    // Your app's own plugins, on the engine that renders your UI. Default: no-op.
    // Override and call GeneratedPluginRegistrant.register(with: engineBridge.pluginRegistry).
    @objc open func registerHostPlugins(with engineBridge: FlutterImplicitEngineBridge)

    // Called once per bundle engine, right after it starts and before it is
    // shown. Default: no-op. Override and call
    // GeneratedPluginRegistrant.register(with: engine).
    @objc open func registerPlugins(with engine: FlutterEngine)
}

// Drop-in scene delegate base class for UIScene apps. Routes the loader's URLs
// received via scene(_:openURLContexts:) and at launch, forwards the bundle's
// own deeplinks to the running bundle engine, and replays the captured scene
// connection into that engine once it exists. With Launch set to panel, it
// roots the window on the panel at launch.
open class BundleLoaderSceneDelegate: FlutterSceneDelegate {
    open override func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>)
    open override func scene(
        _ scene: UIScene,
        willConnectTo session: UISceneSession,
        options connectionOptions: UIScene.ConnectionOptions
    )
}

// Hands a link or a local file to the loader from your own native code.
public enum BundleLoader {
    // Returns true for a download, flitz-panel, or flitz-auth URL of any
    // scheme, and acts on it one main-queue turn later: the download screen
    // (after the sign-in step, with sign-in), an "Invalid URL" error, or the
    // panel takes the window. Without sign-in a flitz-panel URL is dropped; a
    // flitz-auth URL is always dropped. Returns false, and does nothing, for
    // any other URL. Callable from any thread.
    @discardableResult
    public static func handle(url: URL) -> Bool

    // Loads the .flitz at a file URL one main-queue turn later. A URL that
    // names no readable file shows "Bundle file not found". Callable from any
    // thread.
    public static func load(fileAt url: URL)
}