Index

Welcome to the BlueConic Backend Javascript API documentation.

Use the navigation to the left to find the object you are interested in. Alternatively, use the quick links below. To print the documentation, simply navigate to the object of your choice and hit Print.

The main packages of the Javascript Backend API

Domain

Objects modeling important parts of the BlueConic, e.g.: [Channel](blueconic.api.data.domain.Channel.html), [Connection](blueconic.api.data.domain.Connection.html), [Dialogue](blueconic.api.data.domain.Dialogue.html), [Plugin](blueconic.api.data.domain.Plugin.html), [ProfileProperty](blueconic.api.data.domain.ProfileProperty.html), [Segment](blueconic.api.data.domain.Segment.html), [User](blueconic.api.data.domain.User.html)

Store

Interfaces to access objects, e.g.: [connectionStore](blueconic.api.data.store.connectionStore.html), [dialogueStore](blueconic.api.data.store.dialogueStore.html), [profilePropertyStore](blueconic.api.data.store.profilePropertyStore.html), [segmentStore](blueconic.api.data.store.segmentStore.html)

Selector

Interfaces to retrieve stored objects, e.g.: [AreaSelector](blueconic.api.widgets.selector.AreaSelector.html), [DialogueSelector](blueconic.api.widgets.selector.DialogueSelector.html), [OptimizerSelector](blueconic.api.widgets.selector.OptimizerSelector.html), [ProfilePropertySelector](blueconic.api.widgets.selector.ProfilePropertySelector.html), [SegmentSelector](blueconic.api.widgets.selector.SegmentSelector.html)

Forms

Useful form widgets, e.g.: [Label](blueconic.api.widgets.form.label.Label.html), [SimpleInputWrapper](blueconic.api.widgets.form.inputwrapper.SimpleInputWrapper.html)

Plugins

A common foundation for objects, e.g.: [_BaseConnection](blueconic.api.widgets.plugins._BaseConnection.html), [_BaseInsight](blueconic.api.widgets.plugins._BaseInsight.html), [_BaseInsightSettings](blueconic.api.widgets.plugins._BaseInsightSettings.html), [_BaseInteraction](blueconic.api.widgets.plugins._BaseInteraction.html), [_BaseListener](blueconic.api.widgets.plugins._BaseListener.html), [_BaseToolbar](blueconic.api.widgets.plugins._BaseToolbar.html)

Mixins

Useful behaviours, e.g.: [_PausableMixin](blueconic.api.widgets.mixins._PausableMixin.html), [_StoreBasedItemWidgetMixin](blueconic.api.widgets.mixins._StoreBasedItemWidgetMixin.html)

If you want to learn about using the Backend API, check out the tutorials under Getting Started.