Class: ExternalActionView

Extends

$k.ActionView

Methods

configurationElement() → {$k.Instance|undefined}

Get configuration element

Since: 5.2.0
Inherited From: $k.View#configurationElement

Returns:

Type:: $k.Instance | undefined

domainModel() → {$k.SemanticElement|$k.SemanticElementCollection|$k.HitCollection|undefined}

Get domain model

Since: 5.4.0
Inherited From: $k.View#domainModel

Returns:

Type:: $k.SemanticElement | $k.SemanticElementCollection | $k.HitCollection | undefined

getPanelsToActivate() → {Array.<$k.SemanticElement>}

Get the panel configurations activated by the current action.

Only supported in the following application environment(s): View-Configuration-Mapper

Since: 5.3.2
Inherited From: $k.View#getPanelsToActivate
Deprecated: Use the corresponding function of the action
See: $k.Action#getPanelsToActivate

Returns:

Type:: Array.<$k.SemanticElement>

getVariable(variable) → {any}

get the value of the given variable

Parameters:

Name	Type	Description
`variable`	string

Since: 5.2.0
Inherited From: $k.View#getVariable

Returns:

(arrays of) SemanticElements and timestamps are auto-converted to native form

Type:: any

panelView() → {$k.PanelView|undefined}

Get this view's panel view

Since: 5.4.0
Inherited From: $k.View#panelView

Returns:

Type:: $k.PanelView | undefined

parentView() → {$k.View|undefined}

Get this view's parent view

Since: 5.3.2
Inherited From: $k.View#parentView

Returns:

Type:: $k.View | undefined

renderContext() → {$k.JSONRenderContext}

Get render context

Only supported in the following application environment(s): View-Configuration-Mapper

Since: 5.0.0
Inherited From: $k.View#renderContext
Deprecated: Direct access to the render context is deprecated. To store and recall state, either use the session or use .setVariable() and .getVariable() on this object.

Returns:

Type:: $k.JSONRenderContext

roles() → {Array.<string>}

Get the identifiers of any roles assigned to the view.

Since: 5.4.0
Inherited From: $k.View#roles

Returns:

Role identifiers

Type:: Array.<string>

semanticElement() → {$k.SemanticElement|undefined}

Get semantic element

Since: 5.2.0
Inherited From: $k.View#semanticElement

Returns:

Type:: $k.SemanticElement | undefined

session() → {$k.Session|undefined}

Get the current session

Only supported in the following application environment(s): View-Configuration-Mapper

Since: 5.2.0
Inherited From: $k.View#session

Returns:

Type:: $k.Session | undefined

setBlob(blob)

For a download action sets the blob to download

Parameters:

Name	Type	Description
`blob`	$k.Blob \| string	Blob or blob locator string

Since: 6.0.0

setPathParameter(parameterName, value)

Parameters:

Name	Type	Description
`parameterName`	string	Name of a path parameter in the URL
`value`	string	Value to substitute the parameter by

Since: 6.0.0

setState(state) → {object}

Set the state of the view

Parameters:

Name	Type	Description
`state`	object

Version: Experimental feature, might be removed at any time
Since: 5.4.0
Inherited From: $k.View#setState

Returns:

Type:: object

setTarget(targetWindowName)

Parameters:

Name	Type	Description
`targetWindowName`	string	One of '_self', '_blank', '_parent', '_top', or an arbitrary identifier

Since: 6.0.0
See: https://developer.mozilla.org/en-US/docs/Web/API/Window/open#target

setURL(url)

For web link actions, set the URL that should be opened by the web UI.

Parameters:

Name	Type	Description
`url`	string	URL string. May contain Mustache delimited tokens that will be replaced with parameters provided by the $k.ExternalActionView.setPathParameter() function.

Since: 6.0.0

setVariable(variable, value)

set the value of the given variable

Parameters:

Name	Type	Description
`variable`	string
`value`	any	supported variable types include all javascript base types as well as: timestamp, SemanticElement and arrays of the latter

Since: 5.2.0
Inherited From: $k.View#setVariable

state() → {object}

Get the state of the view - varies according to view type and implementation

Version: Experimental feature, might be removed at any time
Since: 5.4.0
Inherited From: $k.View#state

Returns:

Type:: object

subViews() → {Array.<$k.View>}

Get this view's sub-views or an empty array if there are none

Since: 5.4.0
Inherited From: $k.View#subViews

Returns:

Type:: Array.<$k.View>

viewsWithRole(role) → {Array.<$k.View>}

Get all views with the given role searching from this view down to all sub-views.

Parameters:

Name	Type	Description
`role`	string	Role identifier

Since: 5.4.0
Inherited From: $k.View#viewsWithRole

Returns:

Type:: Array.<$k.View>

viewType() → {string}

Get the view type

Since: 5.4.0
Inherited From: $k.View#viewType

Returns:

the view type: edit, query, etc.

Type:: string

viewWithRole(role) → {$k.View|undefined}

Get the single view with the given role searching from this view down to all sub-views. If there are multiple views with that role, undefined is returned.

Parameters:

Name	Type	Description
`role`	string	Role identifier

Since: 5.8.2
Inherited From: $k.View#viewWithRole
See: $k.View#viewsWithRole

Returns:

The view with the given role or undefined if there are zero or more than one matching views.

Type:: $k.View | undefined