Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Configuration

Set common configurations for the Bluedot SDK

Hierarchy

  • Configuration

Index

Properties

Properties

setConfigurationDomain

setConfigurationDomain: (BDGlobalConfigUrl?: string) => void

Indicate which Bluedot environment(development/production) to be used. It's production by default.

param

GlobalConfig url

throws

ValidationError Throws validation error for invalid URL format

Type declaration

    • (BDGlobalConfigUrl?: string): void

    • Parameters

      • Optional BDGlobalConfigUrl: string

      Returns void

setDebugModeEnabled

setDebugModeEnabled: (enabled: boolean) => void

Manages debug mode. When debug mode is enabled any errors will be logged to the console.

param

When set to true debugging is enabled

throws

InvalidInputTypeError If enabled is not a boolean

Type declaration

    • (enabled: boolean): void

    • Parameters

      • enabled: boolean

      Returns void

setLocationMinimumAccuracy

setLocationMinimumAccuracy: (accuracy: number) => void

Set the minimum value that representing the accuracy of the latitude and longitude properties, expressed in meters. Default is 50 meters

param

A positive double value representing the accuracy of the latitude and longitude properties, expressed in meters

throws

ValidationError Throws validation error for accuracy is not a positive number

Type declaration

    • (accuracy: number): void

    • Parameters

      • accuracy: number

      Returns void

setLocationTimeout

setLocationTimeout: (timeout: number) => void

Set the timeout for location acquiring. If the returned location's accuracy > the set minimum accuracy, sdk will retry until the location's accuracy < the set minimum accuracy or timeouted. It's timeouted after 5 seconds by default

param

A positive integer representing maximum delay for location retry, expressed in millisecond

throws

ValidationError Throws validation error for timeout is not a positive integer

Type declaration

    • (timeout: number): void

    • Parameters

      • timeout: number

      Returns void

setUserPersistenceEnabled

setUserPersistenceEnabled: (enabled: boolean) => void

When true causes the generated installRef to be saved to local storage, meaning if a browser user visits the site using the Web SDK then the stored installRef will be used for later wave events. Note this assumes you have received the relevant permissions from the user.

When false deletes all installRefs stored in localStorage and ensures new installRefs will be generated each time the page is loaded

param

When set to true installRefs are stored, when false they are deleted As Node and React Native environments do not use localStorage, in these environments this will have no effect

Type declaration

    • (enabled: boolean): void

    • Parameters

      • enabled: boolean

      Returns void

Generated using TypeDoc