Skip to content
API reference

iOS SDK

iOS API reference

Find the public BTX facade, configuration, customer, messaging, Community, telemetry, feature flag, theme, and push types.

BTX facade

Integrate through the static BTX facade and the public types below.

  • BTX.configure(_:) creates or replaces the SDK runtime configuration.
  • BTX.identify(_:) binds a customer or clears identity with nil.
  • BTX.log(_:) enqueues structured product telemetry.
  • BTX.messenger presents messages, feedback, and push actions.
  • BTX.community presents the native idea and discussion surface.
  • BTX.feedbackPreferences exposes observable device-local feedback choices.
  • BTX.featureFlags reads, observes, and refreshes evaluated flags.
01

Configuration and identity

BTXConfigurationSets the publishable key, enabled features, app context, Messenger and Community options, and push behavior.
BTXAppContextAdds explicit app version, build, and low-cardinality host attributes.
BTXCustomerCarries the stable external ID plus optional name, email, and E.164 phone.
02

Customer messages and feedback

BTXMessengerOptionsConfigures labels, theme, feedback triggers, and push behavior.
BTXLaunchContextAdds entry point, source object, title, intro content, and structured thread attributes.
BTXFeedbackOptionsControls shake and screenshot feedback triggers.
BTXFeedbackPreferencesShares the persisted shake toggle between SDK prompts and host Settings.
BTXFeedbackRatingRepresents a positive or negative contextual feedback signal.
BTXFeedbackPromptConfigures the contextual feedback title, question, choices, subject, and optional-text placeholder.
BTXFeedbackSubmissionResultReports submission success with an optional thread ID or a typed failure.
BTXFeedbackSubmissionFailureExplains why contextual feedback could not be accepted, including configuration, identity, availability, and request failures.
BTXThemeStyles SDK-owned messages, Community, feedback, notifications, attachments, and empty states.
BTXThemePaletteMaps six semantic host colors across SDK surfaces.
03

Community

BTXCommunityCenterPresents or dismisses the native Community sheet through BTX.community.
BTXCommunityOptionsConfigures Community titles, welcome copy, team display name, and optional theme.
BTXCommunityIdeaRepresents an idea, author, vote state, comment count, and discussion.
BTXCommunityReplyRepresents a comment or reply with team identity and like state.
BTXCommunityPresentationResultReports whether the Community sheet was presented.
BTXCommunityPresentationFailureExplains disabled, unconfigured, or unavailable presentation failures.

Call BTX.community.present() after enabling .community. Community creates an anonymous member automatically when the host app has not identified a customer, and supports ideas, upvotes, comments, replies, and comment likes.

04

Telemetry, flags, and push

BTXLogInputRepresents a structured telemetry event, level, message, and properties.
BTXFeatureFlagsStateContains evaluated values, load state, revision, and evaluation time.
BTXPushConfigurationControls automatic notification authorization for customer replies.