btx library
Public BTX Flutter SDK.
Configure the SDK once, identify the signed-in customer when available, and use the facade for logs, feature flags, and messenger presentation.
await Btx.configure(
BtxConfiguration(
publishableClientKey: 'cfk_...',
),
);
await Btx.identify(
const BtxCustomer(externalId: 'customer_123'),
);
Btx.log(
'checkout_started',
properties: {'cartId': 'cart_123'},
);
Btx.messenger.present();
Classes
- Btx
- Singleton BTX Flutter SDK facade.
- BtxAndroidNotificationOpen
- Plain-Dart Android notification-open event supplied by a host push provider.
- BtxAndroidPushSource
- Firebase-neutral Android push source supplied by the host app.
- BtxAppContext
- App version, build, and runtime attributes attached to BTX requests.
- BtxAssistantIdentity
- BtxAttachment
- BtxCardIntro
- BtxClientConfiguration
- Immutable BTX SDK configuration.
- BtxClientController
- Long-lived BTX SDK entry point.
- BtxClientTheme
- BtxConfiguration
- Configuration passed to Btx.configure.
- BtxCredentials
- Host-bundled BTX credentials file shape for the default mobile bootstrap.
- BtxCustomer
- BtxCustomerSdk
- Public SDK bootstrap facade for BTX host telemetry.
- BtxCustomerSdkDisableReason
- BtxCustomerSdkInitialization
- Initialization descriptor for the single public BTX telemetry bootstrap.
- BtxCustomerSdkScope
- Optional widget-tree scope for an already initialized BtxCustomerSdk.
- BtxCustomerSdkStatus
- BtxFeatureFlagsState
- BtxForegroundNotification
- BtxHost
- Root widget that lets the facade present SDK-owned Flutter UI.
- BtxHostIdentity
- Host-owned signed-in identity for bundled bootstrap and telemetry runtimes.
- BtxHostTelemetryAppSession
- Backward-compatible alias for existing SDK app-session APIs.
- BtxImageInput
- BtxKnowledgeBaseArticle
- BtxKnowledgeBaseArticleRevision
- BtxKnowledgeBaseArticleRoute
- BtxKnowledgeBaseArticleSummary
- BtxKnowledgeBaseAsset
- BtxKnowledgeBaseBase
- BtxKnowledgeBaseCategory
- BtxKnowledgeBaseError
- BtxKnowledgeBaseFacade
- SDK-owned knowledge base presentation namespace.
- BtxKnowledgeBaseProject
- BtxKnowledgeBaseSearchResponse
- BtxKnowledgeBaseSearchResult
- BtxKnowledgeBaseSection
- BtxKnowledgeBaseSnapshot
- BtxKnowledgeBaseTheme
- BtxLaunchContext
- BtxLogSessionContext
- BtxMessage
- BtxMessengerError
- BtxMessengerFacade
- SDK-owned messenger presentation namespace.
- BtxMessengerMount
- BtxMessengerOptions
- Messenger behavior owned by the BTX Flutter SDK facade.
- BtxMessengerScope
- BtxMessengerSheetConfiguration
- BtxMessengerSnapshot
- BtxMessengerView
- BtxPublishableClientKeys
- Platform/package-specific publishable client keys for one host app.
- BtxPushCoordinator
- BtxPushEvent
- BtxPushFacade
- SDK-owned push namespace.
- BtxSystemMessageIntro
- BtxTelemetryAppSession
- Host-owned app-session context for structured telemetry and diagnostics.
- BtxTelemetryConfiguration
- Optional telemetry bootstrap behavior for BtxCustomerSdk.initialize.
- BtxTelemetryRuntimeBootstrap
- Serializable bootstrap for isolate-safe telemetry runtimes.
- BtxThread
- BtxThreadIntro
- BtxThreadIntroRow
Enums
- BtxClientStatus
- BtxConversationPurpose
- The customer intent behind a messenger thread.
- BtxCustomerSdkDisableReasonCode
- BtxCustomerSdkStatusKind
- BtxFeature
- Top-level BTX SDK capabilities enabled for a host app.
- BtxKnowledgeBaseStatus
- BtxLogLevel
- Explicit severity for canonical BTX logs.
- BtxMessengerLayoutDensity
- BtxMessengerPresentation
- BtxPushDelivery
- BtxPushEventType
- BtxPushPermissionStatus
- BtxPushRegistrationStatus
- BtxRealtimeConnectionState
- BtxTelemetryRuntimeMode
- Runtime mode for SDK-owned host telemetry.
Extensions
Properties
- btxProductionApiBaseUrl → Uri
-
final