connect.models.Param - Haxe SDK Documentation

Parameters are used in product and asset definitions.

Constructor

`new()`

Variables

`constraints:Constraints`

Parameter constraints.

`description:String`

Description of parameter.

`events:Events`

Events.

`hint:String`

Hint for parameter value.

`marketplace:Marketplace`

Marketplace.

`name:String`

Name of parameter.

`phase:String`

Param phase.

`placeholder:String`

Placeholder for parameter.

`scope:String`

Scope of parameter.

`shared:String`

Provider access. One of: view, edit.

`structuredValue:Dictionary`

Only for parameter types phone, address, checkbox and object.

`title:String`

Title of parameter.

`type:String`

Type of parameter. One of: text, dropdown, password, email, checkbox, subdomain, domain, phone, url, choice.

`value:String`

Value of parameter.

`valueChoice:Collection<String>`

Collections of string choices for parameter.

`valueChoices:Collection<Choice>`

Collection of available dropdown choices for parameter.

`valueError:String`

Error indicated for parameter.

Methods

`isCheckboxChecked(fieldName:String):Bool`

If this Param is a checkbox, returns the status of the field specified in the param.

Parameters:

`fieldName`	Name of the field whose status we want to check.

class Param

package connect.models

extends IdModel › Model