| 1 | /**
|
| 2 | * Copyright 2018 Google Inc. All Rights Reserved.
|
| 3 | *
|
| 4 | * Licensed under the Apache License, Version 2.0 (the "License");
|
| 5 | * you may not use this file except in compliance with the License.
|
| 6 | * You may obtain a copy of the License at
|
| 7 | *
|
| 8 | * http://www.apache.org/licenses/LICENSE-2.0
|
| 9 | *
|
| 10 | * Unless required by applicable law or agreed to in writing, software
|
| 11 | * distributed under the License is distributed on an "AS IS" BASIS,
|
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
| 13 | * See the License for the specific language governing permissions and
|
| 14 | * limitations under the License.
|
| 15 | */
|
| 16 | import * as Api from '../../../api/v2';
|
| 17 | /** @public */
|
| 18 | export declare type OptionArgument = string;
|
| 19 | export interface OptionItems<TOptionItem = OptionItem | string> {
|
| 20 | /**
|
| 21 | * key: Unique string ID for this option.
|
| 22 | * @public
|
| 23 | */
|
| 24 | [key: string]: TOptionItem;
|
| 25 | }
|
| 26 | /**
|
| 27 | * Option item. Used in actions.intent.OPTION intent.
|
| 28 | * @public
|
| 29 | */
|
| 30 | export interface OptionItem {
|
| 31 | /**
|
| 32 | * Synonyms that can be used by the user to indicate this option if they do not use the key.
|
| 33 | * @public
|
| 34 | */
|
| 35 | synonyms?: string[];
|
| 36 | /**
|
| 37 | * Name of the item.
|
| 38 | * @public
|
| 39 | */
|
| 40 | title: string;
|
| 41 | /**
|
| 42 | * Optional text describing the item.
|
| 43 | * @public
|
| 44 | */
|
| 45 | description?: string;
|
| 46 | /**
|
| 47 | * Square image to show for this item.
|
| 48 | * @public
|
| 49 | */
|
| 50 | image?: Api.GoogleActionsV2UiElementsImage;
|
| 51 | }
|
| 52 | /** @hidden */
|
| 53 | export interface ApiOptionItem extends Api.GoogleActionsV2UiElementsCarouselSelectCarouselItem {
|
| 54 | }
|
| 55 | /** @hidden */
|
| 56 | export declare const convert: (items: OptionItems) => ApiOptionItem[];
|