Initialization

Obtain an Appetize client instance using one of the getClient methods.

getClient(selector)

Get an instance of the Appetize client.

const client = await window.appetize.getClient('#my_iframe')

Parameters

NameTypeDescription

selector

string

A query selector string pointing to the embedded iframe

getClient(selector, config)

Get an instance of the Appetize client as well as set the initial config when loading the client.

Useful when the embed link might not be known up front and the configuration has to be applied at runtime.

const client = await window.appetize.getClient('#my_iframe', {
    buildId: '{buildId|publicKey}',
    device: 'iphone11pro',
    osVersion: '15.0'
    ...
})

Parameters

NameTypeDescription

selector

string

A query selector string pointing to the embedded iframe

config

A JSON object describing the Configuration options for the device.

Last updated