cp.choices.builder.md

docs » cp.choices.builder

---

Choices Builder Module.

API Overview

• Functions - API calls offered directly by the extension
• new
• Methods - API calls which can only be made on an object returned by a constructor
• id
• params
• subText
• text

API Documentation

Functions

new

Signature	cp.choices.builder.new(choiceType) -> builder
Type	Function
Description	Creates a new choice builder instance.
Parameters	* choice - The choice instance to configure.
Returns	* The new choice builder.

Methods

id

Signature	cp.choices.builder:id(value) -> builder
Type	Method
Description	Indicates the choice is a favorite.
Parameters	* value - True or false.
Returns	* The choice builder.

params

Signature	cp.choices.builder:params(value) -> builder
Type	Method
Description	Specifies a table of parameter values for the choice. These
Parameters	* value - The table of parameters.
Returns	* The choice builder, added to the choices set.

subText

Signature	cp.choices.builder:subText(value) -> builder
Type	Method
Description	Specifies the subText value for the choice being built.
Parameters	* value - The subText title for the choice.
Returns	* The choice builder.

text

Signature	cp.choices.builder:text(value) -> builder
Type	Method
Description	Specifies the text value for the choice being built.
Parameters	* value - The text title for the choice.
Returns	* The choice builder, added to the choices set.