Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

Latest commit

 

History

History
60 lines (49 loc) · 4.28 KB

plugins.core.tangent.manager.binding.md

File metadata and controls

60 lines (49 loc) · 4.28 KB

docs » plugins.core.tangent.manager.binding


Represents a Tangent Binding

API Overview

  • Constructors - API calls which return an object, typically one that offers API methods
  • binding
  • Methods - API calls which can only be made on an object returned by a constructor
  • member
  • members
  • name
  • xml

API Documentation

Constructors

Signature plugins.core.tangent.manager.binding(id[, name]) -> binding
Type Constructor
Description Creates a new Binding instance.
Parameters
  • id - The ID number of the binding.
  • name - The name of the binding.
Returns
  • the new binding.

Methods

Signature plugins.core.tangent.manager.binding:member(parameter) -> self
Type Method
Description Adds a parameter as a member of the Binding group. The order is significant
Parameters
  • param - The parameter to add to the binding.
Returns
  • The binding instance.
Signature plugins.core.tangent.manager.binding:members(...) -> self
Type Method
Description Adds the list of parameters to this binding.
Parameters
  • ... - the list of parameters to bind.
Returns
  • The binding instance.
Signature plugins.core.tangent.manager.binding:name() -> string
Type Method
Description Returns the name of this binding.
Parameters
  • None
Returns
  • The name.
Signature plugins.core.tangent.manager.binding:xml() -> cp.web.xml
Type Method
Description Returns the xml configuration for the Binding.
Parameters
  • None
Returns
  • The xml for the Binding.