# cp.choices.builder

Choices Builder Module.

---

## API Overview
**Functions** - _API calls offered directly by the extension_
 * [new](#new)

**Methods** - _API calls which can only be made on an object returned by a constructor_
 * [id](#id)
 * [image](#image)
 * [params](#params)
 * [subText](#subtext)
 * [text](#text)

---

## API Documentation

#### Functions

### [new](#new)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `cp.choices.builder.new(choiceType) -> builder`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Creates a new choice builder instance.                                                                     |
| **Parameters**                              | <ul><li>`choice`	- The choice instance to configure.</li></ul> |
| **Returns**                                 | <ul><li>The new choice builder.</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/extensions/cp/choices/init.lua line 7](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/choices/init.lua#L7) |

---

#### Methods

### [id](#id)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `cp.choices.builder:id(value) -> builder`                                                                    |
| **Type**                                    | Method                                                                     |
| **Description**                             | Sets the ID of the choice.                                                                     |
| **Parameters**                              | <ul><li>`value` - The ID.</li></ul> |
| **Returns**                                 | <ul><li>The choice builder.</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/extensions/cp/choices/init.lua line 53](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/choices/init.lua#L53) |

---

### [image](#image)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `cp.choices.builder:image(value) -> builder`                                                                    |
| **Type**                                    | Method                                                                     |
| **Description**                             | Sets the image of the choice.                                                                     |
| **Parameters**                              | <ul><li>value - A `hs.image` image object that will be displayed next to the choice</li></ul> |
| **Returns**                                 | <ul><li>The choice builder.</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/extensions/cp/choices/init.lua line 67](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/choices/init.lua#L67) |

---

### [params](#params)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `cp.choices.builder:params(value) -> builder`                                                                    |
| **Type**                                    | Method                                                                     |
| **Description**                             | Specifies a table of parameter values for the choice. These values need to be simple - text, numbers, booleans, or tables.                                                                     |
| **Parameters**                              | <ul><li>`value`	- The table of parameters.</li></ul> |
| **Returns**                                 | <ul><li>The choice builder, added to the choices set.</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/extensions/cp/choices/init.lua line 83](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/choices/init.lua#L83) |

---

### [subText](#subtext)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `cp.choices.builder:subText(value) -> builder`                                                                    |
| **Type**                                    | Method                                                                     |
| **Description**                             | Specifies the `subText` value for the choice being built.                                                                     |
| **Parameters**                              | <ul><li>`value`	- The subText title for the choice.</li></ul> |
| **Returns**                                 | <ul><li>The choice builder.</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/extensions/cp/choices/init.lua line 39](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/choices/init.lua#L39) |

---

### [text](#text)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `cp.choices.builder:text(value) -> builder`                                                                    |
| **Type**                                    | Method                                                                     |
| **Description**                             | Specifies the text value for the choice being built.                                                                     |
| **Parameters**                              | <ul><li>`value`	- The text title for the choice.</li></ul> |
| **Returns**                                 | <ul><li>The choice builder, added to the choices set.</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/extensions/cp/choices/init.lua line 25](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/choices/init.lua#L25) |

---

---

<script src="https://giscus.app/client.js"
        data-repo="CommandPost/CommandPost"
        data-repo-id="MDEwOlJlcG9zaXRvcnk3NDY0NTk2NQ=="
        data-category="Website Discussion"
        data-category-id="DIC_kwDOBHMBzc4CXFFA"
        data-mapping="pathname"
        data-strict="0"
        data-reactions-enabled="1"
        data-emit-metadata="0"
        data-input-position="bottom"
        data-theme="dark"
        data-lang="en"
        crossorigin="anonymous"
        async>
</script>