ConstructorIO

ConstructorIO

Class to instantiate the ConstructorIO client.

Constructor

new ConstructorIO(parameters) → {class}

Properties:
Name Type Description
search object Interface to module:search
browse object Interface to module:browse
autocomplete object Interface to module:autocomplete
recommendations object Interface to module:recommendations
tracker object Interface to module:tracker
quizzes object Interface to module:quizzes
Source:
Parameters:
Name Type Description
parameters object Parameters for client instantiation
Name Type Attributes Default Description
apiKey string Constructor.io API key
serviceUrl string <optional>
'https://ac.cnstrc.com' API URL endpoint
segments array <optional>
User segments
testCells object <optional>
User test cells
clientId string <optional>
Client ID, defaults to value supplied by 'constructorio-id' module
sessionId string <optional>
Session ID, defaults to value supplied by 'constructorio-id' module
userId string <optional>
User ID
fetch function <optional>
If supplied, will be utilized for requests rather than default Fetch API
trackingSendDelay number <optional>
250 Amount of time to wait before sending tracking events (in ms)
sendReferrerWithTrackingEvents boolean <optional>
true Indicates if the referrer is sent with tracking events
sendTrackingEvents boolean <optional>
false Indicates if tracking events should be dispatched
idOptions object <optional>
Options object to be supplied to 'constructorio-id' module
eventDispatcher object <optional>
Options related to 'EventDispatcher' class
Name Type Attributes Default Description
enabled boolean <optional>
true Determine if events should be dispatched
waitForBeacon boolean <optional>
true Wait for beacon before dispatching events
networkParameters object <optional>
Parameters relevant to network requests
Name Type Attributes Description
timeout number <optional>
Request timeout (in milliseconds) - may be overridden within individual method calls
Returns:
Type:
class

Methods

setClientOptions(apiKey, segmentsopt, testCellsopt, userIdopt)

Sets the client options
Source:
Parameters:
Name Type Attributes Description
apiKey string Constructor.io API key
segments array <optional>
User segments
testCells object <optional>
User test cells
userId string <optional>
User ID