Skip to content

Popup

Orbee provides customers with the option to deliver promotional advertisements to their users through the use of Popups.

Installation

This plugin requires no additional installation to be used correctly.

Type aliases

Configuration

This plugin provides the following configuration variables:

Variable Type Required Description
popups Array <PopupConfig> yes Implementation details for each popup

Methods

loadPopup

loadPopup ( popupConfig: [PopupConfig](../../reference/type_aliases.md#popupconfig) ): void

Creates and loads a new popup

Parameter Type Required Description
popupConfig PopupConfig yes Implementation details for popup

getPopups

getPopups (): any

Gets all loaded popups

Events

Generated

This plugin generates the following events:

Action Spec Trigger
open
{
object: 'promotion',
vendor: 'Orbee',
product: 'Popup Application',
label: 'close popup'
}
on popup open
close
{
object: 'promotion',
vendor: 'Orbee',
product: 'Popup Application',
label: 'close popup'
}
on popup closes
completed
{
object: 'promotion',
vendor: 'Orbee',
product: 'Gift Card Application',
label: 'apply for gift card'
name: '<name>'
email: '<email>'
phone_number: '<phone_number>'
}
on popup form completion

Listening

This plugin does not listen for any events.

Dependencies

This plugin has the following plugin dependencies

Required

  • Ad Server

Last update: 2023-04-13