Class: Google::Apps::Card::V1::SelectionInput
- Inherits:
-
Object
- Object
- Google::Apps::Card::V1::SelectionInput
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/apps/card/v1/card.rb
Overview
A widget that creates one or more UI items that users can select. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see Add selectable UI elements.
Chat apps can process the value of items that users select or input. For details about working with form inputs, see Receive form data.
To collect undefined or abstract data from users, use the TextInput widget.
Defined Under Namespace
Modules: SelectionType Classes: PlatformDataSource, SelectionItem
Instance Attribute Summary collapse
-
#external_data_source ⇒ ::Google::Apps::Card::V1::Action
An external data source, such as a relational data base.
-
#items ⇒ ::Array<::Google::Apps::Card::V1::SelectionInput::SelectionItem>
An array of selectable items.
-
#label ⇒ ::String
The text that appears above the selection input field in the user interface.
-
#multi_select_max_selected_items ⇒ ::Integer
For multiselect menus, the maximum number of items that a user can select.
-
#multi_select_min_query_length ⇒ ::Integer
For multiselect menus, the number of text characters that a user inputs before the app queries autocomplete and displays suggested items in the menu.
-
#name ⇒ ::String
The name that identifies the selection input in a form input event.
-
#on_change_action ⇒ ::Google::Apps::Card::V1::Action
If specified, the form is submitted when the selection changes.
-
#platform_data_source ⇒ ::Google::Apps::Card::V1::SelectionInput::PlatformDataSource
A data source from Google Workspace.
-
#type ⇒ ::Google::Apps::Card::V1::SelectionInput::SelectionType
The type of items that are displayed to users in a
SelectionInput
widget.
Instance Attribute Details
#external_data_source ⇒ ::Google::Apps::Card::V1::Action
Returns An external data source, such as a relational data base.
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 |
# File 'proto_docs/google/apps/card/v1/card.rb', line 1104 class SelectionInput include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An item that users can select in a selection input, such as a checkbox # or switch. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # @!attribute [rw] text # @return [::String] # The text that identifies or describes the item to users. # @!attribute [rw] value # @return [::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](https://developers.google.com/workspace/chat/read-form-data). # @!attribute [rw] selected # @return [::Boolean] # 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. # @!attribute [rw] start_icon_uri # @return [::String] # 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`. # @!attribute [rw] bottom_text # @return [::String] # For multiselect menus, a text description or label that's # displayed below the item's `text` field. class SelectionItem include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # For a # {::Google::Apps::Card::V1::SelectionInput `SelectionInput`} widget that uses a # multiselect menu, a data source from Google Workspace. Used to populate # items in a multiselect menu. # # [Google Chat apps](https://developers.google.com/workspace/chat): # @!attribute [rw] common_data_source # @return [::Google::Apps::Card::V1::SelectionInput::PlatformDataSource::CommonDataSource] # A data source shared by all Google Workspace applications, such as # users in a Google Workspace organization. class PlatformDataSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A data source shared by all [Google Workspace # applications] # (https://developers.google.com/workspace/chat/api/reference/rest/v1/HostApp). # # [Google Chat apps](https://developers.google.com/workspace/chat): module CommonDataSource # Default value. Don't use. UNKNOWN = 0 # Google Workspace users. The user can only view and select users from # their Google Workspace organization. USER = 1 end end # The format for the items that users can select. Different options support # different types of interactions. For example, users can select multiple # checkboxes, but can only select one item from a dropdown menu. # # Each selection input supports one type of selection. Mixing checkboxes # and switches, for example, isn't supported. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): module SelectionType # A set of checkboxes. Users can select one or more checkboxes. CHECK_BOX = 0 # A set of radio buttons. Users can select one radio button. RADIO_BUTTON = 1 # A set of switches. Users can turn on one or more switches. SWITCH = 2 # A dropdown menu. Users can select one item from the menu. DROPDOWN = 3 # A multiselect menu for static or dynamic data. From the menu bar, # users select one or more items. Users can also input values to populate # dynamic data. For example, users can start typing the name of a Google # Chat space and the widget autosuggests the space. # # To populate items for a multiselect menu, you can use one of the # following types of data sources: # # * Static data: Items are specified as `SelectionItem` objects in the # widget. Up to 100 items. # * Google Workspace data: Items are populated using data from Google # Workspace, such as Google Workspace users or Google Chat spaces. # * External data: Items are populated from an external data # source outside of Google Workspace. # # For examples of how to implement multiselect menus, see # [Add a multiselect # menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # Multiselect for Google Workspace Add-ons are in # Developer Preview. MULTI_SELECT = 4 end end |
#items ⇒ ::Array<::Google::Apps::Card::V1::SelectionInput::SelectionItem>
Returns An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 |
# File 'proto_docs/google/apps/card/v1/card.rb', line 1104 class SelectionInput include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An item that users can select in a selection input, such as a checkbox # or switch. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # @!attribute [rw] text # @return [::String] # The text that identifies or describes the item to users. # @!attribute [rw] value # @return [::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](https://developers.google.com/workspace/chat/read-form-data). # @!attribute [rw] selected # @return [::Boolean] # 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. # @!attribute [rw] start_icon_uri # @return [::String] # 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`. # @!attribute [rw] bottom_text # @return [::String] # For multiselect menus, a text description or label that's # displayed below the item's `text` field. class SelectionItem include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # For a # {::Google::Apps::Card::V1::SelectionInput `SelectionInput`} widget that uses a # multiselect menu, a data source from Google Workspace. Used to populate # items in a multiselect menu. # # [Google Chat apps](https://developers.google.com/workspace/chat): # @!attribute [rw] common_data_source # @return [::Google::Apps::Card::V1::SelectionInput::PlatformDataSource::CommonDataSource] # A data source shared by all Google Workspace applications, such as # users in a Google Workspace organization. class PlatformDataSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A data source shared by all [Google Workspace # applications] # (https://developers.google.com/workspace/chat/api/reference/rest/v1/HostApp). # # [Google Chat apps](https://developers.google.com/workspace/chat): module CommonDataSource # Default value. Don't use. UNKNOWN = 0 # Google Workspace users. The user can only view and select users from # their Google Workspace organization. USER = 1 end end # The format for the items that users can select. Different options support # different types of interactions. For example, users can select multiple # checkboxes, but can only select one item from a dropdown menu. # # Each selection input supports one type of selection. Mixing checkboxes # and switches, for example, isn't supported. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): module SelectionType # A set of checkboxes. Users can select one or more checkboxes. CHECK_BOX = 0 # A set of radio buttons. Users can select one radio button. RADIO_BUTTON = 1 # A set of switches. Users can turn on one or more switches. SWITCH = 2 # A dropdown menu. Users can select one item from the menu. DROPDOWN = 3 # A multiselect menu for static or dynamic data. From the menu bar, # users select one or more items. Users can also input values to populate # dynamic data. For example, users can start typing the name of a Google # Chat space and the widget autosuggests the space. # # To populate items for a multiselect menu, you can use one of the # following types of data sources: # # * Static data: Items are specified as `SelectionItem` objects in the # widget. Up to 100 items. # * Google Workspace data: Items are populated using data from Google # Workspace, such as Google Workspace users or Google Chat spaces. # * External data: Items are populated from an external data # source outside of Google Workspace. # # For examples of how to implement multiselect menus, see # [Add a multiselect # menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # Multiselect for Google Workspace Add-ons are in # Developer Preview. MULTI_SELECT = 4 end end |
#label ⇒ ::String
Returns The text that appears above the selection input field in the user interface.
Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be "Urgency" or "Select urgency".
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 |
# File 'proto_docs/google/apps/card/v1/card.rb', line 1104 class SelectionInput include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An item that users can select in a selection input, such as a checkbox # or switch. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # @!attribute [rw] text # @return [::String] # The text that identifies or describes the item to users. # @!attribute [rw] value # @return [::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](https://developers.google.com/workspace/chat/read-form-data). # @!attribute [rw] selected # @return [::Boolean] # 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. # @!attribute [rw] start_icon_uri # @return [::String] # 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`. # @!attribute [rw] bottom_text # @return [::String] # For multiselect menus, a text description or label that's # displayed below the item's `text` field. class SelectionItem include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # For a # {::Google::Apps::Card::V1::SelectionInput `SelectionInput`} widget that uses a # multiselect menu, a data source from Google Workspace. Used to populate # items in a multiselect menu. # # [Google Chat apps](https://developers.google.com/workspace/chat): # @!attribute [rw] common_data_source # @return [::Google::Apps::Card::V1::SelectionInput::PlatformDataSource::CommonDataSource] # A data source shared by all Google Workspace applications, such as # users in a Google Workspace organization. class PlatformDataSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A data source shared by all [Google Workspace # applications] # (https://developers.google.com/workspace/chat/api/reference/rest/v1/HostApp). # # [Google Chat apps](https://developers.google.com/workspace/chat): module CommonDataSource # Default value. Don't use. UNKNOWN = 0 # Google Workspace users. The user can only view and select users from # their Google Workspace organization. USER = 1 end end # The format for the items that users can select. Different options support # different types of interactions. For example, users can select multiple # checkboxes, but can only select one item from a dropdown menu. # # Each selection input supports one type of selection. Mixing checkboxes # and switches, for example, isn't supported. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): module SelectionType # A set of checkboxes. Users can select one or more checkboxes. CHECK_BOX = 0 # A set of radio buttons. Users can select one radio button. RADIO_BUTTON = 1 # A set of switches. Users can turn on one or more switches. SWITCH = 2 # A dropdown menu. Users can select one item from the menu. DROPDOWN = 3 # A multiselect menu for static or dynamic data. From the menu bar, # users select one or more items. Users can also input values to populate # dynamic data. For example, users can start typing the name of a Google # Chat space and the widget autosuggests the space. # # To populate items for a multiselect menu, you can use one of the # following types of data sources: # # * Static data: Items are specified as `SelectionItem` objects in the # widget. Up to 100 items. # * Google Workspace data: Items are populated using data from Google # Workspace, such as Google Workspace users or Google Chat spaces. # * External data: Items are populated from an external data # source outside of Google Workspace. # # For examples of how to implement multiselect menus, see # [Add a multiselect # menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # Multiselect for Google Workspace Add-ons are in # Developer Preview. MULTI_SELECT = 4 end end |
#multi_select_max_selected_items ⇒ ::Integer
Returns For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 |
# File 'proto_docs/google/apps/card/v1/card.rb', line 1104 class SelectionInput include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An item that users can select in a selection input, such as a checkbox # or switch. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # @!attribute [rw] text # @return [::String] # The text that identifies or describes the item to users. # @!attribute [rw] value # @return [::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](https://developers.google.com/workspace/chat/read-form-data). # @!attribute [rw] selected # @return [::Boolean] # 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. # @!attribute [rw] start_icon_uri # @return [::String] # 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`. # @!attribute [rw] bottom_text # @return [::String] # For multiselect menus, a text description or label that's # displayed below the item's `text` field. class SelectionItem include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # For a # {::Google::Apps::Card::V1::SelectionInput `SelectionInput`} widget that uses a # multiselect menu, a data source from Google Workspace. Used to populate # items in a multiselect menu. # # [Google Chat apps](https://developers.google.com/workspace/chat): # @!attribute [rw] common_data_source # @return [::Google::Apps::Card::V1::SelectionInput::PlatformDataSource::CommonDataSource] # A data source shared by all Google Workspace applications, such as # users in a Google Workspace organization. class PlatformDataSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A data source shared by all [Google Workspace # applications] # (https://developers.google.com/workspace/chat/api/reference/rest/v1/HostApp). # # [Google Chat apps](https://developers.google.com/workspace/chat): module CommonDataSource # Default value. Don't use. UNKNOWN = 0 # Google Workspace users. The user can only view and select users from # their Google Workspace organization. USER = 1 end end # The format for the items that users can select. Different options support # different types of interactions. For example, users can select multiple # checkboxes, but can only select one item from a dropdown menu. # # Each selection input supports one type of selection. Mixing checkboxes # and switches, for example, isn't supported. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): module SelectionType # A set of checkboxes. Users can select one or more checkboxes. CHECK_BOX = 0 # A set of radio buttons. Users can select one radio button. RADIO_BUTTON = 1 # A set of switches. Users can turn on one or more switches. SWITCH = 2 # A dropdown menu. Users can select one item from the menu. DROPDOWN = 3 # A multiselect menu for static or dynamic data. From the menu bar, # users select one or more items. Users can also input values to populate # dynamic data. For example, users can start typing the name of a Google # Chat space and the widget autosuggests the space. # # To populate items for a multiselect menu, you can use one of the # following types of data sources: # # * Static data: Items are specified as `SelectionItem` objects in the # widget. Up to 100 items. # * Google Workspace data: Items are populated using data from Google # Workspace, such as Google Workspace users or Google Chat spaces. # * External data: Items are populated from an external data # source outside of Google Workspace. # # For examples of how to implement multiselect menus, see # [Add a multiselect # menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # Multiselect for Google Workspace Add-ons are in # Developer Preview. MULTI_SELECT = 4 end end |
#multi_select_min_query_length ⇒ ::Integer
Returns For multiselect menus, the number of text characters that a user inputs before the app queries autocomplete and displays suggested items in the menu.
If unspecified, defaults to 0 characters for static data sources and 3 characters for external data sources.
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 |
# File 'proto_docs/google/apps/card/v1/card.rb', line 1104 class SelectionInput include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An item that users can select in a selection input, such as a checkbox # or switch. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # @!attribute [rw] text # @return [::String] # The text that identifies or describes the item to users. # @!attribute [rw] value # @return [::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](https://developers.google.com/workspace/chat/read-form-data). # @!attribute [rw] selected # @return [::Boolean] # 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. # @!attribute [rw] start_icon_uri # @return [::String] # 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`. # @!attribute [rw] bottom_text # @return [::String] # For multiselect menus, a text description or label that's # displayed below the item's `text` field. class SelectionItem include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # For a # {::Google::Apps::Card::V1::SelectionInput `SelectionInput`} widget that uses a # multiselect menu, a data source from Google Workspace. Used to populate # items in a multiselect menu. # # [Google Chat apps](https://developers.google.com/workspace/chat): # @!attribute [rw] common_data_source # @return [::Google::Apps::Card::V1::SelectionInput::PlatformDataSource::CommonDataSource] # A data source shared by all Google Workspace applications, such as # users in a Google Workspace organization. class PlatformDataSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A data source shared by all [Google Workspace # applications] # (https://developers.google.com/workspace/chat/api/reference/rest/v1/HostApp). # # [Google Chat apps](https://developers.google.com/workspace/chat): module CommonDataSource # Default value. Don't use. UNKNOWN = 0 # Google Workspace users. The user can only view and select users from # their Google Workspace organization. USER = 1 end end # The format for the items that users can select. Different options support # different types of interactions. For example, users can select multiple # checkboxes, but can only select one item from a dropdown menu. # # Each selection input supports one type of selection. Mixing checkboxes # and switches, for example, isn't supported. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): module SelectionType # A set of checkboxes. Users can select one or more checkboxes. CHECK_BOX = 0 # A set of radio buttons. Users can select one radio button. RADIO_BUTTON = 1 # A set of switches. Users can turn on one or more switches. SWITCH = 2 # A dropdown menu. Users can select one item from the menu. DROPDOWN = 3 # A multiselect menu for static or dynamic data. From the menu bar, # users select one or more items. Users can also input values to populate # dynamic data. For example, users can start typing the name of a Google # Chat space and the widget autosuggests the space. # # To populate items for a multiselect menu, you can use one of the # following types of data sources: # # * Static data: Items are specified as `SelectionItem` objects in the # widget. Up to 100 items. # * Google Workspace data: Items are populated using data from Google # Workspace, such as Google Workspace users or Google Chat spaces. # * External data: Items are populated from an external data # source outside of Google Workspace. # # For examples of how to implement multiselect menus, see # [Add a multiselect # menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # Multiselect for Google Workspace Add-ons are in # Developer Preview. MULTI_SELECT = 4 end end |
#name ⇒ ::String
Returns The name that identifies the selection input in a form input event.
For details about working with form inputs, see Receive form data.
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 |
# File 'proto_docs/google/apps/card/v1/card.rb', line 1104 class SelectionInput include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An item that users can select in a selection input, such as a checkbox # or switch. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # @!attribute [rw] text # @return [::String] # The text that identifies or describes the item to users. # @!attribute [rw] value # @return [::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](https://developers.google.com/workspace/chat/read-form-data). # @!attribute [rw] selected # @return [::Boolean] # 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. # @!attribute [rw] start_icon_uri # @return [::String] # 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`. # @!attribute [rw] bottom_text # @return [::String] # For multiselect menus, a text description or label that's # displayed below the item's `text` field. class SelectionItem include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # For a # {::Google::Apps::Card::V1::SelectionInput `SelectionInput`} widget that uses a # multiselect menu, a data source from Google Workspace. Used to populate # items in a multiselect menu. # # [Google Chat apps](https://developers.google.com/workspace/chat): # @!attribute [rw] common_data_source # @return [::Google::Apps::Card::V1::SelectionInput::PlatformDataSource::CommonDataSource] # A data source shared by all Google Workspace applications, such as # users in a Google Workspace organization. class PlatformDataSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A data source shared by all [Google Workspace # applications] # (https://developers.google.com/workspace/chat/api/reference/rest/v1/HostApp). # # [Google Chat apps](https://developers.google.com/workspace/chat): module CommonDataSource # Default value. Don't use. UNKNOWN = 0 # Google Workspace users. The user can only view and select users from # their Google Workspace organization. USER = 1 end end # The format for the items that users can select. Different options support # different types of interactions. For example, users can select multiple # checkboxes, but can only select one item from a dropdown menu. # # Each selection input supports one type of selection. Mixing checkboxes # and switches, for example, isn't supported. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): module SelectionType # A set of checkboxes. Users can select one or more checkboxes. CHECK_BOX = 0 # A set of radio buttons. Users can select one radio button. RADIO_BUTTON = 1 # A set of switches. Users can turn on one or more switches. SWITCH = 2 # A dropdown menu. Users can select one item from the menu. DROPDOWN = 3 # A multiselect menu for static or dynamic data. From the menu bar, # users select one or more items. Users can also input values to populate # dynamic data. For example, users can start typing the name of a Google # Chat space and the widget autosuggests the space. # # To populate items for a multiselect menu, you can use one of the # following types of data sources: # # * Static data: Items are specified as `SelectionItem` objects in the # widget. Up to 100 items. # * Google Workspace data: Items are populated using data from Google # Workspace, such as Google Workspace users or Google Chat spaces. # * External data: Items are populated from an external data # source outside of Google Workspace. # # For examples of how to implement multiselect menus, see # [Add a multiselect # menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # Multiselect for Google Workspace Add-ons are in # Developer Preview. MULTI_SELECT = 4 end end |
#on_change_action ⇒ ::Google::Apps::Card::V1::Action
Returns If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form.
For details about working with form inputs, see Receive form data.
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 |
# File 'proto_docs/google/apps/card/v1/card.rb', line 1104 class SelectionInput include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An item that users can select in a selection input, such as a checkbox # or switch. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # @!attribute [rw] text # @return [::String] # The text that identifies or describes the item to users. # @!attribute [rw] value # @return [::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](https://developers.google.com/workspace/chat/read-form-data). # @!attribute [rw] selected # @return [::Boolean] # 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. # @!attribute [rw] start_icon_uri # @return [::String] # 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`. # @!attribute [rw] bottom_text # @return [::String] # For multiselect menus, a text description or label that's # displayed below the item's `text` field. class SelectionItem include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # For a # {::Google::Apps::Card::V1::SelectionInput `SelectionInput`} widget that uses a # multiselect menu, a data source from Google Workspace. Used to populate # items in a multiselect menu. # # [Google Chat apps](https://developers.google.com/workspace/chat): # @!attribute [rw] common_data_source # @return [::Google::Apps::Card::V1::SelectionInput::PlatformDataSource::CommonDataSource] # A data source shared by all Google Workspace applications, such as # users in a Google Workspace organization. class PlatformDataSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A data source shared by all [Google Workspace # applications] # (https://developers.google.com/workspace/chat/api/reference/rest/v1/HostApp). # # [Google Chat apps](https://developers.google.com/workspace/chat): module CommonDataSource # Default value. Don't use. UNKNOWN = 0 # Google Workspace users. The user can only view and select users from # their Google Workspace organization. USER = 1 end end # The format for the items that users can select. Different options support # different types of interactions. For example, users can select multiple # checkboxes, but can only select one item from a dropdown menu. # # Each selection input supports one type of selection. Mixing checkboxes # and switches, for example, isn't supported. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): module SelectionType # A set of checkboxes. Users can select one or more checkboxes. CHECK_BOX = 0 # A set of radio buttons. Users can select one radio button. RADIO_BUTTON = 1 # A set of switches. Users can turn on one or more switches. SWITCH = 2 # A dropdown menu. Users can select one item from the menu. DROPDOWN = 3 # A multiselect menu for static or dynamic data. From the menu bar, # users select one or more items. Users can also input values to populate # dynamic data. For example, users can start typing the name of a Google # Chat space and the widget autosuggests the space. # # To populate items for a multiselect menu, you can use one of the # following types of data sources: # # * Static data: Items are specified as `SelectionItem` objects in the # widget. Up to 100 items. # * Google Workspace data: Items are populated using data from Google # Workspace, such as Google Workspace users or Google Chat spaces. # * External data: Items are populated from an external data # source outside of Google Workspace. # # For examples of how to implement multiselect menus, see # [Add a multiselect # menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # Multiselect for Google Workspace Add-ons are in # Developer Preview. MULTI_SELECT = 4 end end |
#platform_data_source ⇒ ::Google::Apps::Card::V1::SelectionInput::PlatformDataSource
Returns A data source from Google Workspace.
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 |
# File 'proto_docs/google/apps/card/v1/card.rb', line 1104 class SelectionInput include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An item that users can select in a selection input, such as a checkbox # or switch. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # @!attribute [rw] text # @return [::String] # The text that identifies or describes the item to users. # @!attribute [rw] value # @return [::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](https://developers.google.com/workspace/chat/read-form-data). # @!attribute [rw] selected # @return [::Boolean] # 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. # @!attribute [rw] start_icon_uri # @return [::String] # 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`. # @!attribute [rw] bottom_text # @return [::String] # For multiselect menus, a text description or label that's # displayed below the item's `text` field. class SelectionItem include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # For a # {::Google::Apps::Card::V1::SelectionInput `SelectionInput`} widget that uses a # multiselect menu, a data source from Google Workspace. Used to populate # items in a multiselect menu. # # [Google Chat apps](https://developers.google.com/workspace/chat): # @!attribute [rw] common_data_source # @return [::Google::Apps::Card::V1::SelectionInput::PlatformDataSource::CommonDataSource] # A data source shared by all Google Workspace applications, such as # users in a Google Workspace organization. class PlatformDataSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A data source shared by all [Google Workspace # applications] # (https://developers.google.com/workspace/chat/api/reference/rest/v1/HostApp). # # [Google Chat apps](https://developers.google.com/workspace/chat): module CommonDataSource # Default value. Don't use. UNKNOWN = 0 # Google Workspace users. The user can only view and select users from # their Google Workspace organization. USER = 1 end end # The format for the items that users can select. Different options support # different types of interactions. For example, users can select multiple # checkboxes, but can only select one item from a dropdown menu. # # Each selection input supports one type of selection. Mixing checkboxes # and switches, for example, isn't supported. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): module SelectionType # A set of checkboxes. Users can select one or more checkboxes. CHECK_BOX = 0 # A set of radio buttons. Users can select one radio button. RADIO_BUTTON = 1 # A set of switches. Users can turn on one or more switches. SWITCH = 2 # A dropdown menu. Users can select one item from the menu. DROPDOWN = 3 # A multiselect menu for static or dynamic data. From the menu bar, # users select one or more items. Users can also input values to populate # dynamic data. For example, users can start typing the name of a Google # Chat space and the widget autosuggests the space. # # To populate items for a multiselect menu, you can use one of the # following types of data sources: # # * Static data: Items are specified as `SelectionItem` objects in the # widget. Up to 100 items. # * Google Workspace data: Items are populated using data from Google # Workspace, such as Google Workspace users or Google Chat spaces. # * External data: Items are populated from an external data # source outside of Google Workspace. # # For examples of how to implement multiselect menus, see # [Add a multiselect # menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # Multiselect for Google Workspace Add-ons are in # Developer Preview. MULTI_SELECT = 4 end end |
#type ⇒ ::Google::Apps::Card::V1::SelectionInput::SelectionType
Returns The type of items that are displayed to users in a SelectionInput
widget.
Selection types support different types of interactions. For example, users
can select one or more checkboxes, but they can only select one value from
a dropdown menu.
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 |
# File 'proto_docs/google/apps/card/v1/card.rb', line 1104 class SelectionInput include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An item that users can select in a selection input, such as a checkbox # or switch. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # @!attribute [rw] text # @return [::String] # The text that identifies or describes the item to users. # @!attribute [rw] value # @return [::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](https://developers.google.com/workspace/chat/read-form-data). # @!attribute [rw] selected # @return [::Boolean] # 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. # @!attribute [rw] start_icon_uri # @return [::String] # 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`. # @!attribute [rw] bottom_text # @return [::String] # For multiselect menus, a text description or label that's # displayed below the item's `text` field. class SelectionItem include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # For a # {::Google::Apps::Card::V1::SelectionInput `SelectionInput`} widget that uses a # multiselect menu, a data source from Google Workspace. Used to populate # items in a multiselect menu. # # [Google Chat apps](https://developers.google.com/workspace/chat): # @!attribute [rw] common_data_source # @return [::Google::Apps::Card::V1::SelectionInput::PlatformDataSource::CommonDataSource] # A data source shared by all Google Workspace applications, such as # users in a Google Workspace organization. class PlatformDataSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A data source shared by all [Google Workspace # applications] # (https://developers.google.com/workspace/chat/api/reference/rest/v1/HostApp). # # [Google Chat apps](https://developers.google.com/workspace/chat): module CommonDataSource # Default value. Don't use. UNKNOWN = 0 # Google Workspace users. The user can only view and select users from # their Google Workspace organization. USER = 1 end end # The format for the items that users can select. Different options support # different types of interactions. For example, users can select multiple # checkboxes, but can only select one item from a dropdown menu. # # Each selection input supports one type of selection. Mixing checkboxes # and switches, for example, isn't supported. # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): module SelectionType # A set of checkboxes. Users can select one or more checkboxes. CHECK_BOX = 0 # A set of radio buttons. Users can select one radio button. RADIO_BUTTON = 1 # A set of switches. Users can turn on one or more switches. SWITCH = 2 # A dropdown menu. Users can select one item from the menu. DROPDOWN = 3 # A multiselect menu for static or dynamic data. From the menu bar, # users select one or more items. Users can also input values to populate # dynamic data. For example, users can start typing the name of a Google # Chat space and the widget autosuggests the space. # # To populate items for a multiselect menu, you can use one of the # following types of data sources: # # * Static data: Items are specified as `SelectionItem` objects in the # widget. Up to 100 items. # * Google Workspace data: Items are populated using data from Google # Workspace, such as Google Workspace users or Google Chat spaces. # * External data: Items are populated from an external data # source outside of Google Workspace. # # For examples of how to implement multiselect menus, see # [Add a multiselect # menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). # # [Google Workspace Add-ons and Chat # apps](https://developers.google.com/workspace/extend): # Multiselect for Google Workspace Add-ons are in # Developer Preview. MULTI_SELECT = 4 end end |