Reference documentation and code samples for the Google Apps Chat V1 Client class SelectionItem.
An item that users can select in a selection input, such as a checkbox or switch.
Google Workspace Add-ons and Chat apps:
Generated from protobuf message google.apps.card.v1.SelectionInput.SelectionItem
Namespace
Google \ Apps \ Card \ V1 \ SelectionInputMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ text |
string
The text that identifies or describes the item to users. |
↳ value |
string
The value associated with this item. The client should use this as a form input value. For details about working with form inputs, see Receive form data. |
↳ selected |
bool
Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item. |
↳ start_icon_uri |
string
For multiselect menus, the URL for the icon displayed next to the item's |
↳ bottom_text |
string
For multiselect menus, a text description or label that's displayed below the item's |
getText
The text that identifies or describes the item to users.
| Returns | |
|---|---|
| Type | Description |
string |
|
setText
The text that identifies or describes the item to users.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValue
The value associated with this item. The client should use this as a form input value.
For details about working with form inputs, see Receive form data.
| Returns | |
|---|---|
| Type | Description |
string |
|
setValue
The value associated with this item. The client should use this as a form input value.
For details about working with form inputs, see Receive form data.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelected
Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSelected
Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartIconUri
For multiselect menus, the URL for the icon displayed next to
the item's text field. Supports PNG and JPEG files. Must be an HTTPS
URL. For example,
https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
| Returns | |
|---|---|
| Type | Description |
string |
|
setStartIconUri
For multiselect menus, the URL for the icon displayed next to
the item's text field. Supports PNG and JPEG files. Must be an HTTPS
URL. For example,
https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBottomText
For multiselect menus, a text description or label that's
displayed below the item's text field.
| Returns | |
|---|---|
| Type | Description |
string |
|
setBottomText
For multiselect menus, a text description or label that's
displayed below the item's text field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|