Module: display

appboy.display is the public interface for the UI portions of Appboy's Web SDK. It is only available in https://js.appboycdn.com/web-sdk/0.1/appboy.min.js and is stripped from the more minimal https://js.appboycdn.com/web-sdk/0.1/appboy.core.min.js.

Methods

<static> automaticallyShowNewInAppMessages() → {string}

Automatically display new in-app messages when they come in from the server.

Returns:

The identifier of the subscription created. This can be passed to removeSubscription to cancel the subscription.

Type
string

<static> showInAppMessage(inAppMessage)

Display a given in-app message. If another message is already being displayed, the message will be returned to the queue until the next time message subscribers (which are created with appboy.subscribeToNewInAppMessages) are invoked.

Parameters:
Name Type Description
inAppMessage ab.InAppMessage

The message to display.