Skip to content
Longport WhaleLongport Whale
WhaleAppSDK

Optional APIs

WhaleAppSDK analytics-event forwarding and project scope

Current WhaleAppSDK versions expose analytics-event callbacks on iOS and Android. Broker and the Whale project team must still agree whether forwarding is enabled and which event names and properties are in scope.

Warning

Never append tokens, refresh tokens, Client identity data, account numbers, or other sensitive information. Broker App should consume only events explicitly agreed as stable for the project.

Android

LBWhaleApp.callback = object : LBWhaleAppCallback {
    override fun onLBWhaleAppAnalyticsEvent(
        eventName: String,
        properties: org.json.JSONObject
    ) {
        // Forward only event names and properties agreed for the project.
    }
}

iOS

- (void)lbWhaleAppAnalyticsEventWithName:(NSString *)name
                              properties:(NSDictionary *)properties {
    // Forward only event names and properties agreed for the project.
}

Event scope

Common foundational events include:

  • $AppViewScreen: page displayed.
  • $AppPageLeave: page left.
  • $AppClick: click.
  • whale_sdk_*: Broker App API calls and SDK lifecycle callbacks, such as whale_sdk_start, whale_sdk_start_success, and whale_sdk_start_callback_run.

The SDK may also produce internal business events for community-content exposure, search-result exposure, or news-feed exposure. These events are not guaranteed to be stable for Broker use; do not depend on or forward them unless they are explicitly included in the project delivery scope.

Whale Docs