Class WidgetApi

constructor

• new WidgetApi(config?): WidgetApi

• Initialize a new WidgetApi instance.

  Parameters

  • Optional config: ConfigOptions

    Config details

  Returns WidgetApi

  Example

  Browser example

  var squatchApi = new squatch.WidgetApi({tenantAlias:'test_12b5bo1b25125'});
  Copy

  Example

  Browserify/Webpack example

  var WidgetApi = require('@saasquatch/squatch-js').WidgetApi;
  var squatchApi = new WidgetApi({tenantAlias:'test_12b5bo1b25125'});
  Copy

  Example

  Babel+Browserify/Webpack example

  import {WidgetApi} from '@saasquatch/squatch-js';
  let squatchApi = new WidgetApi({tenantAlias:'test_12b5bo1b25125'});
  Copy

domain

npmCdn

referralCookie

tenantAlias

render

• render(params): Promise<any>

• Requests widget template

  Parameters

  • params: WidgetConfig

    Parameters for request

  Returns Promise<any>

  template html if true.

squatchReferralCookie

• squatchReferralCookie(): Promise<ReferralCookie>

• Looks up the referral code of the current user, if there is any.

  Returns Promise<ReferralCookie>

  code referral code if true.

upsertUser

• upsertUser(params): Promise<any>

• Creates/upserts user, requests widget template.

  Parameters

  • params: WithRequired<WidgetConfig, "user">

    Parameters for request

  Returns Promise<any>

  string if true, with the widget template, jsOptions and user details.