Flutter Agent
📄️ Quickstart
Get started with NetFUNNEL 4 Flutter Agent in 5-10 minutes with this quick start guide.
📄️ Installation & Initialization
NetFUNNEL Flutter agent installation and initialization guide.
🗃️ Integration Methods
2 items
📄️ Initialization Option Reference
This document describes all initialization options available in the Netfunnel.instance.initialize() function.
📄️ API Reference
Complete reference for NetFUNNEL Flutter Agent functions, callbacks, and response formats.
📄️ Troubleshooting
Common issues, solutions, and frequently asked questions for NetFUNNEL Flutter Agent integration.
Overview
Flutter Agent is a client-side SDK that provides NetFUNNEL 4 traffic control functionality for Flutter applications.
Key Features
- Client-side SDK: Direct integration into Flutter applications
- Code-based integration: Precise control through button clicks, API calls, etc.
- Native waiting room: WebView-based waiting room template
- Real-time queue updates: Provides queue position, wait time, and progress information
- Network recovery: Automatic recovery from network issues
- Robust error handling: Comprehensive callback system
- Lightweight SDK: Minimal dependencies
System Requirements
- Flutter: 3.0.0 or higher
- Dart: 3.0.0 or higher
Compatible Environments
- Flutter applications: iOS and Android native apps
- Hybrid apps: Flutter-based hybrid applications
How It Works
- SDK initialization: Initialize NetFUNNEL and configure settings
- Code-based integration: Control traffic using
nfStartandnfStopfunctions - Waiting room display: WebView-based waiting room is automatically displayed
Agent Operation Flow
Before waiting: Page load → Agent initialization → Trigger rule match
While waiting: NetFUNNEL server request → NetFUNNEL key issuance → Move to waiting room page
After waiting: Service page entry → NetFUNNEL key return
Integration Methods
Code-based Integration
Code-based integration supports two control types:
- Basic control: Entry rate control
- Section control: Maintain concurrent user count in specific sections
To compare basic control and section control and choose the most suitable approach for your use case, refer to the Integration Methods Overview.
Limitations
Flutter Agent does not support URL-Triggered integration. Only code-based integration can be used.
Quick Start
To quickly get started with Flutter Agent, refer to the Quick Start guide.
Need a basic project for practice? Check out the Sample Projects.
Documentation
Core Documentation
- Quick Start: Get started in 5-10 minutes with basic examples
- Installation and Initialization: Detailed guide on dependencies and configuration
- Integration Methods: Comparison of basic control and section control
- API Reference: Complete function specifications, callbacks, and response formats
- Initialization Options: All initialization parameters and usage
- Troubleshooting: Common issues, solutions, and FAQ
Implementation Guides
- Basic Control Integration: Basic control implementation guide
- Section Control Integration: Section control implementation guide
Related Content
- Android Agent: Android SDK integration guide
- iOS Agent: iOS SDK integration guide
- Sample Projects: Ready-to-use project templates