Get Settings File

Each VWO SDK client corresponds to the settings file representing the current state of the campaign settings, that is, a list of FullStack running campaign settings. See Review core concepts for more information.

Description

VWO SDK is a helper for executing various FullStack capabilities. It requires a certain set of settings for its work. These settings are related to your FullStack campaigns you create or update in the VWO application.
So, before instantiating the VWO SDK, settings file needs to be fetched.

The method accepts two parameters:

  • account_id - account-id associated with your VWO account.
  • sdk_key - generated inside the respective Project under the FullStack Testing.

Parameter Definitions

Paramter

Type

Description

account_id
Required

Number

Your VWO application's Account ID.

sdk_key
Required

String

Unique environment-key provided to you inside the Projects section in VWO application..

Returns

Returns a Promise which on success returns the settings file which helps in Instantiating the VWO SDK. This method handles any error in fetching the settings file. Please follow the best practices to ensure that your app is prevented from crashing.

Value

Type

Description

Settings File

Object

The settings representing the current state of the running VWO FullStack campaings.

Usage

require 'vwo'

# Fetch and create instance
vwo_client_instance = VWO.new(
  config['account_id'],
  config['sdk_key']
)

vwo_client_instance = VWO.new(
  config['account_id'],
  config['sdk_key'],
  integrations: {
    callback: method(:integrations_callback)
  }
)

Did this page help you?