Class default

Implements

BrowserHackleClient

Constructors

constructor

new default(
    core: HackleCore,
    synchronizer: PollingSynchronizer,
    sessionManager: SessionManager,
    userManager: UserManager,
    piiEventManager: PIIEventManager,
    fetchThrottler: Throttler,
    pageManager: PageManager,
    inAppMessageUi: InAppMessageUi,
    devTools?: DevTools,
): default
Parameters
- core: HackleCore
- synchronizer: PollingSynchronizer
- sessionManager: SessionManager
- userManager: UserManager
- piiEventManager: PIIEventManager
- fetchThrottler: Throttler
- pageManager: PageManager
- inAppMessageUi: InAppMessageUi
- OptionaldevTools: DevTools
Returns default

Methods

getSessionId

getSessionId(): string
Returns current session ID

Returns string
if session is unavailable, returns 0.ffffffff

Since
11.8.0

Implementation of BrowserHackleClient.getSessionId

getUser

getUser(): User
Returns User
Implementation of BrowserHackleClient.getUser

setUser

setUser(user: User): Promise<void>
Parameters
- user: User
Returns Promise<void>
Implementation of BrowserHackleClient.setUser

setUserId

setUserId(userId: string | number): Promise<void>
Parameters
- userId: string | number
Returns Promise<void>
Implementation of BrowserHackleClient.setUserId

setDeviceId

setDeviceId(deviceId: string): Promise<void>
Parameters
- deviceId: string
Returns Promise<void>
Implementation of BrowserHackleClient.setDeviceId

setUserProperty

setUserProperty(key: string, value: any): Promise<void>
Parameters
- key: string
- value: any
Returns Promise<void>
Implementation of BrowserHackleClient.setUserProperty

setUserProperties

setUserProperties(properties: Properties): Promise<void>
Parameters
- properties: Properties
Returns Promise<void>
Implementation of BrowserHackleClient.setUserProperties

updateUserProperties

updateUserProperties(operations: PropertyOperations): Promise<void>
Updates the user's properties.
Parameters
- operations: PropertyOperations
  Property operations to update user properties.
Returns Promise<void>
Implementation of BrowserHackleClient.updateUserProperties

updatePushSubscriptions

updatePushSubscriptions(operations: HackleSubscriptionOperations): Promise<void>
Updates the user's push subscriptions.
Parameters
- operations: HackleSubscriptionOperations
  Push subscription operations to update user properties.
Returns Promise<void>
Implementation of BrowserHackleClient.updatePushSubscriptions

updateSmsSubscriptions

updateSmsSubscriptions(operations: HackleSubscriptionOperations): Promise<void>
Updates the user's SMS subscriptions.
Parameters
- operations: HackleSubscriptionOperations
  SMS subscription operations to update user properties.
Returns Promise<void>
Implementation of BrowserHackleClient.updateSmsSubscriptions

updateKakaoSubscriptions

updateKakaoSubscriptions(
operations: HackleSubscriptionOperations,
): Promise<void>
Updates the user's Kakao subscriptions.
Parameters
- operations: HackleSubscriptionOperations
  Kakao subscription operations to update user properties.
Returns Promise<void>
Implementation of BrowserHackleClient.updateKakaoSubscriptions

resetUser

resetUser(): Promise<void>
Returns Promise<void>
Implementation of BrowserHackleClient.resetUser

setPhoneNumber

setPhoneNumber(phoneNumber: string): Promise<void>
Set user's phone number. Existing value will be replaced by new value if you call this method multiple times.
Parameters
- phoneNumber: string
  String satisfying valid E.164 format is accepted.
Returns Promise<void>
Implementation of BrowserHackleClient.setPhoneNumber

unsetPhoneNumber

unsetPhoneNumber(): Promise<void>
Reset user's phone number to be an empty value.

Returns Promise<void>
Implementation of BrowserHackleClient.unsetPhoneNumber

variation

variation(
    experimentKey: number,
    user?: string | User,
    defaultVariation?: string,
): string
Determine the variation to expose to the user for experiment.

This method return the {"A"} if:
- The experiment key is invalid
- The experiment has not started yet
- The user is not allocated to the experiment
- The determined variation has been dropped
Parameters
- experimentKey: number
  the unique key of the experiment.
- Optionaluser: string | User
  the user to participate in the experiment. MUST NOT be null.
- OptionaldefaultVariation: string
  the default variation of the experiment.
Returns string
string the decided variation for the user, or the default variation.

Implementation of BrowserHackleClient.variation

variationDetail

variationDetail(
    experimentKey: number,
    user?: string | User,
    defaultVariation?: string,
): Decision
Determine the variation to expose to the user for experiment, and returns an object that describes the way the variation was determined.
Parameters
- experimentKey: number
  the unique key of the experiment.
- Optionaluser: string | User
  the user to participate in the experiment. MUST NOT be null. (e.g. { id: "userId"} )
- OptionaldefaultVariation: string
  the default variation of the experiment. MUST NOT be null.
Returns Decision
object

Implementation of BrowserHackleClient.variationDetail

isFeatureOn

isFeatureOn(featureKey: number, user?: string | User): boolean
Determine whether the feature is turned on to the user.
Parameters
- featureKey: number
  the unique key for the feature.
- Optionaluser: string | User
  the user requesting the feature.
Returns boolean
boolean True if the feature is on. False if the feature is off.

Since
2.0.0

Implementation of BrowserHackleClient.isFeatureOn

featureFlagDetail

featureFlagDetail(featureKey: number, user?: string | User): FeatureFlagDecision
Determine whether the feature is turned on to the user, and returns an object that describes the way the value was determined.
Parameters
- featureKey: number
  the unique key for the feature.
- Optionaluser: string | User
  the identifier of user.
Returns FeatureFlagDecision
Since
2.0.0

Implementation of BrowserHackleClient.featureFlagDetail

track

track(event: string | HackleEvent<string>, user?: string | User): void
Records the event performed by the user.
Parameters
- event: string | HackleEvent<string>
  the unique key of the event. MUST NOT be null.
- Optionaluser: string | User
  the identifier of user that performed the event. id MUST NOT be null. (e.g. { id: "userId"} )
Returns void
Implementation of BrowserHackleClient.track

trackPageView

trackPageView(option?: PageView): void
Parameters
- Optionaloption: PageView
Returns void
Deprecated
trackPageView is deprecated and do nothing.

Use the setCurrentPage method to track the page view.

Implementation of BrowserHackleClient.trackPageView

setCurrentPage

setCurrentPage(page: HacklePage): void
Tracking the page manually This method always triggers page events regardless of whether the page has changed
Parameters
- page: HacklePage
Returns void
Implementation of BrowserHackleClient.setCurrentPage

remoteConfig

remoteConfig(user?: User): HackleRemoteConfig
Return a instance of Hackle Remote Config.
Parameters
- Optionaluser: User
  the identifier of user.
Returns HackleRemoteConfig
Implementation of BrowserHackleClient.remoteConfig

onReady

onReady(block: () => void, timeout?: number): void
Parameters
- block: () => void
  callback function.
- timeout: number = DEFAULT_ON_READY_TIMEOUT
Returns void
Deprecated
use onInitialized instead.

Implementation of BrowserHackleClient.onReady

getExperiment

getExperiment(experimentKey: number): HackleExperiment
Parameters
- experimentKey: number
Returns HackleExperiment
Implementation of BrowserHackleClient.getExperiment

onInitialized

onInitialized(config?: { timeout?: number }): Promise<{ success: boolean }>
Parameters
- Optionalconfig: { timeout?: number }
Returns Promise<{ success: boolean }>
Implementation of BrowserHackleClient.onInitialized

showUserExplorer

showUserExplorer(): void
Show User Explorer.

Returns void
Implementation of BrowserHackleClient.showUserExplorer

hideUserExplorer

hideUserExplorer(): void
Hide User Explorer.

Returns void
Implementation of BrowserHackleClient.hideUserExplorer

fetch

fetch(): Promise<void>
Fetch dashboard config data.

Returns Promise<void>
Implementation of BrowserHackleClient.fetch

setInAppMessageListener

setInAppMessageListener(listener: HackleInAppMessageListener): void
Set InAppMessage listener.
Parameters
- listener: HackleInAppMessageListener
  The listener to be set.
Returns void
Implementation of BrowserHackleClient.setInAppMessageListener

getDisplayedInAppMessageView

getDisplayedInAppMessageView(): HackleInAppMessageView
Get displayed InAppMessage view.

Returns HackleInAppMessageView
if there is no displayed InAppMessage, return null.

Implementation of BrowserHackleClient.getDisplayedInAppMessageView

close

close(): void
Returns void
Implementation of BrowserHackleClient.close

Class default

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

getSessionId

Returns string

Since

getUser

Returns User

setUser

Parameters

Returns Promise<void>

setUserId

Parameters

Returns Promise<void>

setDeviceId

Parameters

Returns Promise<void>

setUserProperty

Parameters

Returns Promise<void>

setUserProperties

Parameters

Returns Promise<void>

updateUserProperties

Parameters

Returns Promise<void>

updatePushSubscriptions

Parameters

Returns Promise<void>

updateSmsSubscriptions

Parameters

Returns Promise<void>

updateKakaoSubscriptions

Parameters

Returns Promise<void>

resetUser

Returns Promise<void>

setPhoneNumber

Parameters

Returns Promise<void>

unsetPhoneNumber

Returns Promise<void>

variation

Parameters

Returns string

variationDetail

Parameters

Returns Decision

isFeatureOn

Parameters

Returns boolean

Since

featureFlagDetail

Parameters

Returns FeatureFlagDecision

Since

track

Parameters

Returns void

trackPageView

Parameters

Returns void

Deprecated

setCurrentPage

Parameters

Returns void

remoteConfig

Parameters

Returns HackleRemoteConfig

onReady

Parameters

Returns void

Deprecated