chumbaq library
Chumbaq Flutter SDK — deep linking, attribution, events, push notifications, in-app banners, and in-app messages.
This package is a thin Flutter wrapper over the native Chumbaq Android SDK (and, when available, the Chumbaq iOS SDK). All business logic — offline event queueing, session tracking, HTTP retries, install referrer parsing, FCM integration — lives in native code, so Flutter users get exactly the same behavior as native users.
Entry points:
- Chumbaq — core SDK (init, identify, track, deep links)
- ChumbaqPush — push notification registration
- ChumbaqBanners + ChumbaqBannerCarousel — in-app banner carousel
- ChumbaqMessages — in-app message trigger points and event stream
- ChumbaqDiagnostics — opt-in reporting of swallowed failures
Classes
- BannerCategory
- A category of banners with layout/display settings.
- Chumbaq
- Main entry point for the Chumbaq Flutter SDK.
- ChumbaqBanner
- A single banner returned by ChumbaqBanners.loadBanners.
- ChumbaqBannerCarousel
-
Flutter widget that embeds the native Chumbaq
BannerCarouselView. - ChumbaqBanners
- Banners module — loads and caches in-app banner categories.
- ChumbaqConfig
- Immutable configuration for the Chumbaq SDK.
- ChumbaqConfigBuilder
-
Fluent builder for ChumbaqConfig. Mirrors the Android SDK's
ChumbaqConfig.Builder. - ChumbaqDiagnostics
- Opt-in reporting of failures the SDK otherwise swallows.
- ChumbaqMessages
- In-app messages module.
- ChumbaqPush
- Optional push notification module for the Chumbaq SDK.
- DeepLinkResult
- A resolved deep link — either from a direct intent or from deferred (post-install) matching.
- DeferredMatchResult
- Result of a Chumbaq.matchDeferredDeepLink call.
- IdentifyParams
- Parameters for Chumbaq.identify. Use IdentifyParams.builder.
- IdentifyParamsBuilder
- IdentifyResult
- Result returned from a successful Chumbaq.identify call.
- InAppMessage
- MessageButton
- MessageButtonAction
- A CTA button tap on an in-app message.
- MessageCustomEvent
-
A button with
action="custom_event"was tapped. - MessageEvent
- Typed wrapper for events emitted on the message-event stream.
- MessageLifecycleEvent
- A lifecycle event (impression, click, dismiss) fired on an in-app message.
- MessageTheme
- PushAction
- One button under a push campaign's notification.
- PushCarouselSlide
- One frame of a push campaign's carousel.
- PushTimer
- A countdown carried by a push campaign, rendered by the client.
- TrackConversionParams
- Parameters for Chumbaq.trackConversion.
Enums
- ChumbaqLogLevel
- Verbosity of the Chumbaq SDK's internal logger.
Exceptions / Errors
- ChumbaqApiError
- Thrown on non-2xx HTTP responses from the Chumbaq backend.
- ChumbaqError
- Sealed hierarchy of errors that the Chumbaq SDK may surface.
- ChumbaqInvalidConfig
- Thrown when SDK configuration is invalid (blank baseUrl, etc.).
- ChumbaqNetworkError
- Thrown on transport-level network failures (no response from server).
- ChumbaqNotInitialized
- Thrown when an SDK method is called before Chumbaq.init.
- ChumbaqUnknownError
- Any error that doesn't match a known category.