ExternalScreen

ExternalScreen

new ExternalScreen()

Description:

  • ExternalScreen Object

Source:

Classes

ExternalScreen

Members

namespace

Description:

  • Getter for namespace

Source:

Getter for namespace

(static) ExternalObjects

Source:
Properties:
Name Type Description
ExternalObjects Array.<ExternalScreen>

The list of all External Screen Objects

(static) UUIDBrowserSession

Source:
Properties:
Name Type Description
UUIDBrowserSession string

Browser session id

(static) externalData

Source:
Properties:
Name Type Description
externalData any

Data from the external screen.

(static) externalScreenContainer

Source:
Properties:
Name Type Description
externalScreenContainer string

The external screen container.

(static) externalScreens

Source:
Properties:
Name Type Description
externalScreens array

List of external screens.

(static) externalScreensNamespaces

Source:
Properties:
Name Type Description
externalScreensNamespaces array

List of external screens namespaces.

(static) onBeforeScreenOnload

Source:
Properties:
Name Type Description
onBeforeScreenOnload array

Before screen unload callbacks.

(static) popups

Source:
Properties:
Name Type Description
popups array

The windows/popups opened.

Methods

createEmitter()

Description:

  • Creates a new event listener

Source:

createListener()

Description:

  • Creates a new event listener

Source:

destroy()

Description:

  • Creates a new event listener

Source:

emit(eventName, payload)

Description:

  • Emits an event

Source:
Parameters:
Name Type Description
eventName string

The name of the event
payload object

The payload/data to send

getActiveWindowForeignKey() → {string}

Description:

  • Method used for setting the active window foreign key

Source:
Returns:

activeWindowForeignKey

Type
string

getExternalData()

Description:

  • Creates a new event listener

Source:

off(eventName, fn)

Description:

  • Removes the event listeners

Source:
Parameters:
Name Type Description
eventName string

The name of the event
fn function

The callback method

on(eventName, fn)

Description:

  • Method for listening for events

Source:
Parameters:
Name Type Description
eventName string

The name of the event to listen for
fn function

The callback method

setActiveWindowForeignKey(foreignKey)

Description:

  • Method used for setting the active window foreign key

Source:
Parameters:
Name Type Description
foreignKey string

setActiveWindowListener(ln)

Description:

  • Method for setting up an activeWidow listener method

Source:
Parameters:
Name Type Description
ln function

Listener method

setCloseWindowListener(ln)

Description:

  • Method for setting up an closeWindow listener method

Source:
Parameters:
Name Type Description
ln function

Listener method

setDataAvailListener(ln)

Description:

  • Method for setting up data available listener method

Source:
Parameters:
Name Type Description
ln

Listener method

setLaunchContainerListener(ln)

Description:

  • Method for setting up a launchContainer listener method

Source:
Parameters:
Name Type Description
ln function

Listener method

setNamespace(namespace) → {void}

Description:

  • Method for setting up the ExternalScreen namespace

Source:
Parameters:
Name Type Description
namespace string
Returns:
Type
void

setRefreshListener(ln)

Description:

  • Method for setting up a refresh listener method

Source:
Parameters:
Name Type Description
ln function

setRefreshSchemeListener(ln)

Description:

  • Method for setting up a refreshScheme listener method besides the default behaviour

Source:
Parameters:
Name Type Description
ln function

(static) forEachPopup(func)

Description:

  • Method to loop over each external screen popup

Source:
Parameters:
Name Type Description
func

Function to call for each popup

(static) getExternalPopup(screenNamespace)

Description:

  • Method for returning the external screen popup by namespace

Source:
Parameters:
Name Type Description
screenNamespace

The External Screen namespace used when launching

(static) getLocalOpened(name) → {Object}

Description:

  • Method for getting the ExternalScreen Opened locally from localStorage

Source:
Parameters:
Name Type Description
name string
Returns:
Type
Object

(static) initBrowserSessionId()

Description:

  • Method used for initializing the browser session id

Source:

(static) loadExternalDesignerNamespace()

Description:

  • Method for setting screenNamespace from query param screenNamespace

Source:

(static) setContainer(containerName)

Description:

  • Sets the external screen container

Source:
Parameters:
Name Type Description
containerName string

(static) setExternalData()

Description:

  • Creates a new event listener

Source: