southgames_flutter library
Flutter SDK for SouthGames gamification and loyalty platform.
Classes
- Attribution
- Attribution data captured from tracking links, deep links, or UTM parameters.
- Campaign
- An active campaign available for play.
- CreateCodeResult
-
Response from creating a new promo code for a user via
POST /api/v1/codes. - CtaButton
- A call-to-action button on an in-app notification.
- EarnPointsResponse
- Response from earning points.
- FirebaseMessaging
- The FirebaseMessaging entry point.
- GameViewResult
- Result returned when a marketplace game finishes.
- InAppBlock
- A single content block within an in-app notification.
- InAppBlockButton
-
A button within a
button_groupblock. - InAppNotification
- An in-app notification targeted to the current user.
- InAppTrigger
- Trigger configuration for an in-app notification.
- NotificationOverlayWidget
- PlayResponse
- Response from playing a game.
- PointsBalance
- Response from getting a client's points balance.
- PointsLedgerEntry
- A single entry in the points ledger.
- PushConfig
- Configuration for push notification behavior.
- PushPermissionResult
- Result of requesting notification permissions.
- RedeemResult
- Response from redeeming a promo code.
- RegisterResponse
- Response from registering a client.
- RemoteMessage
- A class representing a message sent from Firebase Cloud Messaging.
- RemoteNotification
- A class representing a notification which has been constructed and sent to the device via FCM.
- SouthGamesConfig
- Configuration for the SouthGames SDK.
- SouthGamesGameView
- A widget that loads and runs a marketplace game in a WebView.
- SouthGamesNotificationManager
- Manages in-app notification delivery, trigger evaluation, impression tracking, and frequency capping.
- SouthGamesNotificationOverlay
-
An overlay widget that listens to
SouthGamesSDK.notifications.onNotificationand automatically displays in-app notifications. - SouthGamesPush
- Handles push notification registration, permissions, and token management using Firebase Cloud Messaging.
- SouthGamesSDK
- Main entry point for the SouthGames Flutter SDK.
- SpendPointsResponse
- Response from spending points.
- TrackEventResult
- Result of tracking a custom event via SouthGamesSDK.trackEvent.
Constants
- kDefaultBaseUrl → const String
- Default production base URL.
- kSdkVersion → const String
- Current SDK version. Keep in sync with pubspec.yaml.
Functions
-
defaultBackgroundMessageHandler(
RemoteMessage message) → Future< void> - Background message handler for SouthGames push notifications.
Typedefs
- OnCtaTap = void Function(String action)
- Callback when the user taps a CTA button in a notification.
- OnNotificationShown = void Function(InAppNotification notification)
- Callback when a notification is shown. Use this to customize behavior.
Exceptions / Errors
- SouthGamesException
- Exception thrown when the SDK encounters an API error.
- SouthGamesNotInitializedException
-
Exception thrown when the SDK is used before calling
SouthGames.init.