RybbitConfig class
Configuration class for the Rybbit Flutter SDK.
Contains all the settings needed to initialize and configure the SDK.
Constructors
-
RybbitConfig({required String siteId, String? apiKey, String analyticsHost = 'https://app.rybbit.io', bool enableLogging = false, Duration requestTimeout = const Duration(seconds: 10), int maxRetries = 3, bool trackScreenViews = true, bool trackAppLifecycle = true, bool trackQuerystring = true, bool autoTrackPageview = true, List<
String> skipPatterns = const [], bool enableOfflineQueue = true, int maxQueueSize = 1000}) -
Creates a new RybbitConfig instance.
const
Properties
- analyticsHost → String
-
The analytics host URL. Defaults to 'https://app.rybbit.io'.
final
- apiKey → String?
-
Your Rybbit API key, if the server requires one.
final
- autoTrackPageview → bool
-
Whether to automatically track initial pageview on SDK initialization. Defaults to true.
final
- enableLogging → bool
-
Whether to enable debug logging. Defaults to false.
final
- enableOfflineQueue → bool
-
Whether to persist events locally and retry when the device is back online.
Defaults to true.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- maxQueueSize → int
-
Maximum number of events to hold in the offline queue.
Oldest events are dropped when the limit is reached. Defaults to 1000.
final
- maxRetries → int
-
Maximum number of retry attempts for failed requests. Defaults to 3.
final
- requestTimeout → Duration
-
Timeout for HTTP requests. Defaults to 10 seconds.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- siteId → String
-
Your Rybbit site ID.
final
-
skipPatterns
→ List<
String> -
List of URL patterns to skip tracking (supports glob patterns like '/admin/*').
Events matching these patterns will not be sent to analytics.
final
- trackAppLifecycle → bool
-
Whether to track app lifecycle events (foreground/background). Defaults to true.
final
- trackQuerystring → bool
-
Whether to include query parameters in page tracking. Defaults to true.
final
- trackScreenViews → bool
-
Whether to automatically track screen navigation. Defaults to true.
final
Methods
-
copyWith(
{String? apiKey, String? siteId, String? analyticsHost, bool? enableLogging, Duration? requestTimeout, int? maxRetries, bool? trackScreenViews, bool? trackAppLifecycle, bool? trackQuerystring, bool? autoTrackPageview, List< String> ? skipPatterns, bool? enableOfflineQueue, int? maxQueueSize}) → RybbitConfig - Creates a copy of this config with the specified parameters overridden.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited