quicui_code_push_client library

QuicUI - Code Push for Flutter

A Flutter package that provides over-the-air (OTA) code push functionality. Configuration is loaded automatically from quicui.yaml.

Quick Start

  1. Create a quicui.yaml in your project root:
server:
  url: "https://your-server.com"
app:
  id: "com.example.app"
version:
  current: "1.0.0"

  1. Set QUICUI_API_KEY environment variable or add to quicui.yaml

  2. Use in your app:

import 'package:quicui_code_push_client/quicui_code_push_client.dart';

void main() async {
  final client = await QuicUICodePush.create();
  await client.initialize();
  
  final patch = await client.checkForUpdates();
  if (patch != null) {
    await client.downloadAndInstall(patch);
    await client.restartApp();
  }
  
  runApp(const MyApp());
}

Classes

PatchInfo
Information about a code patch
QuicUICodePush
Main QuicUI code push client
SDKInfo
Model class for SDK information

Exceptions / Errors

QuicUIApiKeyMissingException
Exception thrown when API key is not configured
QuicUIAppIdMissingException
Exception thrown when app ID is not configured
QuicUIConfigInvalidException
Exception thrown when quicui.yaml is invalid or has missing required fields
QuicUIConfigNotFoundException
Exception thrown when quicui.yaml configuration file is missing
QuicUIException
QuicUI Code Push Exceptions Base exception for all QuicUI errors
QuicUIPatchException
Exception thrown when patch download or installation fails
QuicUISDKIncompatibleException
Exception thrown when SDK is not compatible
QuicUIServerUrlMissingException
Exception thrown when server URL is not configured