Function activate

  • activate(siteId, codeVersion, navigator?): void

  • This function is used to activate the Contextual Commerce SDK, and initiates communication with Contextual Commerce's servers.

    Parameters

    • siteId: string

      The 5-character(alpha-numeric, case sensitive) site identifier provided to you by your Contextual Commerce Strategist.

    • codeVersion: string

      The version string of your application code.

    • Optionalnavigator: Navigator

      The Navigator object containing callbacks to navigate to the cart and product pages. This parameter is required for navigation on iOS.

    Returns void

    Placement

    This function must be called on app launch before any other method on the API(with the exception of subscription and registration methods) to allow the SDK to intialize itself with the provided site information.

Settings

Member Visibility