Skip to main content

Options

Starting from version 3.6.6, the SDK supports additional configuration options.

Description​

options is represented as a Record<string, string>, where each key corresponds to an option name and each value represents the option’s value.

At the moment, the SDK includes one predefined option — pos.

/**
 * The field is responsible for passing user-defined or widget-specific variables
 * (for example, the "products" widget).
 */
options?: {
    /**
     * Point of sale identifier
     */
    pos?: string;
} & Record<string, string>;
warning

Important: For options to work correctly, they must be configured and approved on the backend side.
Otherwise, setting them will not have any effect.

Example​

 const inAppStoryManager = new window.IAS.InAppStoryManager({
    apiKey: "{projectToken}",
    options: {
      pos: "your-pos",
      yourCustomOption: "your-custom-option-value"
    }
  })

It is recommended to set the options after initializing the SDK and before opening any reader for the first time.
Changing the options while a reader is active will not cause the values to update reactively.

If you need to filter the feed stream output or display onboarding messages (InAppMessages) based on the options, make sure to set them before launching these components.

Updating Options​

In scenarios where you need to switch users or re-filter the stories feed using new parameters, update the options and then manually refresh the feed.

<div id="stories_widget"></div>
import { AppearanceManager, InAppStoryManager } from "@inappstory/js-sdk";

const inAppStoryManager = new InAppStoryManager({
    apiKey: "{projectToken}"
  });
const appearanceManager = new AppearanceManager();
const storiesList = new inAppStoryManager.StoriesList(
  "#stories_widget",
  appearanceManager
);

inAppStoryManager.setOptions({
    pos: "your-pos",
    yourCustomOption: "your-custom-option-value"
});

// Reload stories after options changed (Optional)
storiesList.reload();