Interface ReactNativeSDKClient

Hackle React Native SDK client interface

Provides methods for A/B testing, feature flags, remote config, event tracking, and user management.

interface ReactNativeSDKClient {
    variation(experimentKey: number): Promise<string>;
    variationSync(experimentKey: number): string;
    variationDetail(experimentKey: number): Promise<ReactNativeDecision>;
    variationDetailSync(experimentKey: number): ReactNativeDecision;
    isFeatureOn(featureKey: number): Promise<boolean>;
    isFeatureOnSync(featureKey: number): boolean;
    featureFlagDetail(featureKey: number): Promise<ReactNativeFeatureFlagDecision>;
    featureFlagDetailSync(featureKey: number): ReactNativeFeatureFlagDecision;
    track(event: Event): void;
    remoteConfig(): Promise<HackleRemoteConfig>;
    remoteConfigSync(): HackleRemoteConfig;
    onReady(): Promise<void>;
    getUser(): Promise<User>;
    setUser(user: User): Promise<void>;
    setUserId(userId: undefined | null | string): Promise<void>;
    setDeviceId(deviceId: string): Promise<void>;
    setUserProperty(key: string, value: PropertyValue): Promise<void>;
    setUserProperties(properties: {
        [key: string]: PropertyValue;
    }): Promise<void>;
    updateUserProperties(operations: PropertyOperations): Promise<void>;
    updatePushSubscriptions(operations: HackleSubscriptionOperations): Promise<void>;
    updateSmsSubscriptions(operations: HackleSubscriptionOperations): Promise<void>;
    updateKakaoSubscriptions(operations: HackleSubscriptionOperations): Promise<void>;
    resetUser(): Promise<void>;
    setPhoneNumber(phoneNumber: string): Promise<void>;
    unsetPhoneNumber(): Promise<void>;
    showUserExplorer(): Promise<void>;
    hideUserExplorer(): Promise<void>;
    fetch(): Promise<void>;
    isInvocableString(command: string): Promise<boolean>;
    bridgeInvoke(command: string): Promise<string>;
    setInAppMessageListener(listener: null | HackleInAppMessageListener): void;
    dismissDisplayedInAppMessageView(): Promise<void>;
    setBackButtonDismissesInAppMessageView(dismisses: boolean): Promise<void>;
    setCurrentScreen(screen: Screen): Promise<void>;
    setOptOutTracking(optOut: boolean): Promise<void>;
    isOptOutTracking(): Promise<boolean>;
    on<K>(eventName: K, fn: EventReceiver<HackleReactNativeSdkTypeClientEventMap[K]>): void;
    off<K>(eventName: K, fn: EventReceiver<HackleReactNativeSdkTypeClientEventMap[K]>): void;
    emit<K>(eventName: K, params: HackleReactNativeSdkTypeClientEventMap[K]): void;
}

Hierarchy

  • Emitter<HackleReactNativeSdkTypeClientEventMap>
    • ReactNativeSDKClient

Methods

variation variationSync variationDetail variationDetailSync isFeatureOn isFeatureOnSync featureFlagDetail featureFlagDetailSync track remoteConfig remoteConfigSync onReady getUser setUser setUserId setDeviceId setUserProperty setUserProperties updateUserProperties updatePushSubscriptions updateSmsSubscriptions updateKakaoSubscriptions resetUser setPhoneNumber unsetPhoneNumber showUserExplorer hideUserExplorer fetch isInvocableString bridgeInvoke setInAppMessageListener dismissDisplayedInAppMessageView setBackButtonDismissesInAppMessageView setCurrentScreen setOptOutTracking isOptOutTracking on off emit

Methods

variation

  • variation(experimentKey): Promise<string>

  • Gets the variation key for an A/B test experiment asynchronously

    Parameters

    • experimentKey: number

      The experiment key identifier

    Returns Promise<string>

    Promise resolving to the variation key (e.g., "A", "B")

variationSync

  • variationSync(experimentKey): string

  • Gets the variation key for an A/B test experiment synchronously

    Parameters

    • experimentKey: number

      The experiment key identifier

    Returns string

    The variation key (e.g., "A", "B")

variationDetail

  • variationDetail(experimentKey): Promise<ReactNativeDecision>

  • Gets detailed decision information for an A/B test experiment asynchronously

    Parameters

    • experimentKey: number

      The experiment key identifier

    Returns Promise<ReactNativeDecision>

    Promise resolving to decision details including variation, reason, and parameters

variationDetailSync

  • variationDetailSync(experimentKey): ReactNativeDecision

  • Gets detailed decision information for an A/B test experiment synchronously

    Parameters

    • experimentKey: number

      The experiment key identifier

    Returns ReactNativeDecision

    Decision details including variation, reason, and parameters

isFeatureOn

  • isFeatureOn(featureKey): Promise<boolean>

  • Checks if a feature flag is enabled asynchronously

    Parameters

    • featureKey: number

      The feature flag key identifier

    Returns Promise<boolean>

    Promise resolving to true if the feature is enabled, false otherwise

isFeatureOnSync

  • isFeatureOnSync(featureKey): boolean

  • Checks if a feature flag is enabled synchronously

    Parameters

    • featureKey: number

      The feature flag key identifier

    Returns boolean

    True if the feature is enabled, false otherwise

featureFlagDetail

  • featureFlagDetail(featureKey): Promise<ReactNativeFeatureFlagDecision>

  • Gets detailed decision information for a feature flag asynchronously

    Parameters

    • featureKey: number

      The feature flag key identifier

    Returns Promise<ReactNativeFeatureFlagDecision>

    Promise resolving to feature flag decision details including isOn status, reason, and parameters

featureFlagDetailSync

  • featureFlagDetailSync(featureKey): ReactNativeFeatureFlagDecision

  • Gets detailed decision information for a feature flag synchronously

    Parameters

    • featureKey: number

      The feature flag key identifier

    Returns ReactNativeFeatureFlagDecision

    Feature flag decision details including isOn status, reason, and parameters

track

  • track(event): void

  • Tracks an event

    Parameters

    • event: Event

      The event to track with a key, and properties

    Returns void

remoteConfig

  • remoteConfig(): Promise<HackleRemoteConfig>

  • Gets the remote config asynchronously

    Returns Promise<HackleRemoteConfig>

    Promise resolving to remote config object for retrieving configuration values

remoteConfigSync

  • remoteConfigSync(): HackleRemoteConfig

  • Gets the remote config synchronously

    Returns HackleRemoteConfig

    Remote config object for retrieving configuration values

onReady

  • onReady(): Promise<void>

  • Waits for the SDK to be fully initialized

    Returns Promise<void>

    Promise that resolves when the SDK is ready

getUser

  • getUser(): Promise<User>

  • Gets the current user object

    Returns Promise<User>

    Promise resolving to the current user

setUser

  • setUser(user): Promise<void>

  • Sets the current user

    Parameters

    • user: User

      The user object to set

    Returns Promise<void>

    Promise that resolves when the user is set

setUserId

  • setUserId(userId): Promise<void>

  • Sets the user ID

    Parameters

    • userId: undefined | null | string

      The user ID to set, or null/undefined to clear

    Returns Promise<void>

    Promise that resolves when the user ID is set

setDeviceId

  • setDeviceId(deviceId): Promise<void>

  • Sets the device ID

    Parameters

    • deviceId: string

      The device ID to set

    Returns Promise<void>

    Promise that resolves when the device ID is set

setUserProperty

  • setUserProperty(key, value): Promise<void>

  • Sets a user property

    Parameters

    • key: string

      The property key

    • value: PropertyValue

      The property value

    Returns Promise<void>

    Promise that resolves when the property is set

    Deprecated

    Use updateUserProperties(operations) instead

setUserProperties

  • setUserProperties(properties): Promise<void>

  • Sets user properties

    Parameters

    • properties: {
          [key: string]: PropertyValue;
      }

      Object containing property key-value pairs

      • [key: string]: PropertyValue

    Returns Promise<void>

    Promise that resolves when the properties are set

    Deprecated

    Use updateUserProperties(operations) instead

updateUserProperties

  • updateUserProperties(operations): Promise<void>

  • Updates user properties using operations

    Parameters

    • operations: PropertyOperations

      Property operations to apply

    Returns Promise<void>

    Promise that resolves when the operations are applied

updatePushSubscriptions

  • updatePushSubscriptions(operations): Promise<void>

  • Updates push notification subscription preferences

    Parameters

    • operations: HackleSubscriptionOperations

      Subscription operations to apply

    Returns Promise<void>

    Promise that resolves when the subscriptions are updated

updateSmsSubscriptions

  • updateSmsSubscriptions(operations): Promise<void>

  • Updates SMS subscription preferences

    Parameters

    • operations: HackleSubscriptionOperations

      Subscription operations to apply

    Returns Promise<void>

    Promise that resolves when the subscriptions are updated

updateKakaoSubscriptions

  • updateKakaoSubscriptions(operations): Promise<void>

  • Updates Kakao subscription preferences

    Parameters

    • operations: HackleSubscriptionOperations

      Subscription operations to apply

    Returns Promise<void>

    Promise that resolves when the subscriptions are updated

resetUser

  • resetUser(): Promise<void>

  • Resets the current user to an anonymous state

    Returns Promise<void>

    Promise that resolves when the user is reset

setPhoneNumber

  • setPhoneNumber(phoneNumber): Promise<void>

  • Sets the user's phone number

    Parameters

    • phoneNumber: string

      The phone number to set

    Returns Promise<void>

    Promise that resolves when the phone number is set

unsetPhoneNumber

  • unsetPhoneNumber(): Promise<void>

  • Removes the user's phone number

    Returns Promise<void>

    Promise that resolves when the phone number is unset

showUserExplorer

  • showUserExplorer(): Promise<void>

  • Shows the user explorer UI for debugging

    Returns Promise<void>

    Promise that resolves when the user explorer is shown

hideUserExplorer

  • hideUserExplorer(): Promise<void>

  • Hides the user explorer UI

    Returns Promise<void>

    Promise that resolves when the user explorer is hidden

fetch

  • fetch(): Promise<void>

  • Manually fetches the latest configuration from the server

    Returns Promise<void>

    Promise that resolves when the fetch is complete

isInvocableString

  • isInvocableString(command): Promise<boolean>

  • Checks if a command string can be invoked via bridge

    Parameters

    • command: string

      The command string to check

    Returns Promise<boolean>

    Promise resolving to true if the command is invocable, false otherwise

bridgeInvoke

  • bridgeInvoke(command): Promise<string>

  • Invokes a command via the bridge

    Parameters

    • command: string

      The command string to invoke

    Returns Promise<string>

    Promise resolving to the command result string

setInAppMessageListener

  • setInAppMessageListener(listener): void

  • Sets the in-app message listener for handling in-app message events

    Parameters

    • listener: null | HackleInAppMessageListener

      The listener to handle in-app message events, or null to remove

    Returns void

dismissDisplayedInAppMessageView

  • dismissDisplayedInAppMessageView(): Promise<void>

  • Dismisses the currently displayed in-app message view. If no in-app message view is currently displayed, this method does nothing.

    Returns Promise<void>

    Promise that resolves when the dismiss is complete

setBackButtonDismissesInAppMessageView

  • setBackButtonDismissesInAppMessageView(dismisses): Promise<void>

  • Configures whether the back button dismisses in-app message views (Android only)

    Parameters

    • dismisses: boolean

      True to allow back button to dismiss, false otherwise

    Returns Promise<void>

    Promise that resolves when the setting is applied

setCurrentScreen

  • setCurrentScreen(screen): Promise<void>

  • Updates the current screen

    Parameters

    • screen: Screen

      Screen information

    Returns Promise<void>

    Promise that resolves when the screen is set

setOptOutTracking

  • setOptOutTracking(optOut): Promise<void>

  • Sets the opt-out tracking state

    Parameters

    • optOut: boolean

      True to opt out of tracking, false to opt in

    Returns Promise<void>

    Promise that resolves when the setting is applied

isOptOutTracking

  • isOptOutTracking(): Promise<boolean>

  • Gets the current opt-out tracking state

    Returns Promise<boolean>

    Promise resolving to true if tracking is opted out, false otherwise

on

  • on<K>(eventName, fn): void

  • Type Parameters

    • K extends "user-updated"

    Parameters

    • eventName: K
    • fn: EventReceiver<HackleReactNativeSdkTypeClientEventMap[K]>

    Returns void

off

  • off<K>(eventName, fn): void

  • Type Parameters

    • K extends "user-updated"

    Parameters

    • eventName: K
    • fn: EventReceiver<HackleReactNativeSdkTypeClientEventMap[K]>

    Returns void

emit

  • emit<K>(eventName, params): void

  • Type Parameters

    • K extends "user-updated"

    Parameters

    • eventName: K
    • params: HackleReactNativeSdkTypeClientEventMap[K]

    Returns void

Settings

Member Visibility

On This Page

Methods