action

Represents a Tangent Action

API Overview

  • Constructors - API calls which return an object, typically one that offers API methods

  • Methods - API calls which can only be made on an object returned by a constructor

API Documentation

Constructors

new

Signature

plugins.core.tangent.manager.action.new(id[, name]) -> action

Type

Constructor

Description

Creates a new Action instance.

Parameters

Returns

Methods

controls

Signature

plugins.core.tangent.manager.action:controls()

Type

Method

Description

Returns the controls the action belongs to.

Parameters

Returns

is

Signature

plugins.core.tangent.manager.action.is() -> boolean

Type

Method

Description

Is an object an action?

Parameters

Returns

onPress

Signature

plugins.core.tangent.manager.action:onPress(pressFn) -> self

Type

Method

Description

Sets the function that will be called when the Tangent sends a 'action on' request.

Parameters

Returns

onRelease

Signature

plugins.core.tangent.manager.action:onRelease(releaseFn) -> self

Type

Method

Description

Sets the function that will be called when the Tangent sends a 'action off' request.

Parameters

Returns

parent

Signature

`plugins.core.tangent.manager.action:parent() -> group

controls` </span>

Type

Method

Description

Returns the group or controls that contains this action.

Parameters

Returns

xml

Signature

plugins.core.tangent.manager.action:xml() -> cp.web.xml

Type

Method

Description

Returns the xml configuration for the Action.

Parameters

Returns