@cometchat/chat-uikit-react 4.3.21 → 5.0.0-beta1

package/dist/types/modals/InteractiveActions/URLNavigationAction.d.ts

@@ -0,0 +1,30 @@
+import { ActionEntity } from "../InteractiveEntities/ActionEntity";
+import { fromJsonType } from "./APIAction";
+/**
+ * Represents a URL navigation action that can be performed on a dynamic form.
+ */
+export declare class URLNavigationAction extends ActionEntity {
+    /**
+     * The URL to navigate to.
+     */
+    private url;
+    /**
+     * Creates a new instance of the URLNavigationAction class.
+     * @param {string} url - The URL to navigate to.
+     */
+    constructor(url: string);
+    /**
+     * Returns the URL to navigate to.
+     * @returns {string} The URL to navigate to.
+     */
+    getURL(): string;
+    /**
+     * Creates a `URLNavigationAction` instance from a JSON object.
+     *
+     * Initializes the `URLNavigationAction` with the provided URL.
+     *
+     * @param {fromJsonType} json - The JSON object containing the URL.
+     * @returns {URLNavigationAction} The `URLNavigationAction` instance.
+     */
+    static fromJSON(json: fromJsonType): URLNavigationAction;
+}

package/dist/types/modals/InteractiveActions/index.d.ts

@@ -0,0 +1,3 @@
+export { APIAction } from "./APIAction";
+export { URLNavigationAction } from "./URLNavigationAction";
+export { CustomAction } from "./CustomAction";

package/dist/types/modals/InteractiveElements/BaseInputElement.d.ts

@@ -0,0 +1,50 @@
+import { ElementEntity } from "../InteractiveEntities/ElementEntity";
+import { fromJsonType } from "../InteractiveActions/APIAction";
+/**
+ * Represents the base input for a dynamic form element.
+ */
+export declare class BaseInputElement<T> extends ElementEntity {
+    /**
+     * The response of an input.
+     */
+    private response?;
+    /**
+     * Whether the input element is optional or required.
+     * */
+    private optional?;
+    /**
+     * Creates a new instance of the BaseInputElement class.
+     * @param {string} elementId - The unique identifier of the form element.
+     * @param {string} elementType - The type of the form element.
+     */
+    constructor(elementId: string, elementType: string);
+    /**
+     * Sets the response of an input.
+     */
+    setResponse(response: T): void;
+    /**
+     * Returns the response of an input.
+     * @returns {T} The response of an input.
+     */
+    getResponse(): T | undefined;
+    /**
+ * Returns whether the element is optional or required.
+ * @returns {boolean} Whether the element is optional or required.
+ */
+    getOptional(): boolean | undefined;
+    /**
+     * Sets whether the element is optional or required.
+     * @param {boolean} optional - Whether the element is optional or required.
+     */
+    setOptional(optional: boolean | string): void;
+    /**
+      * Creates an `ElementEntity` from a JSON object based on the `elementType`.
+      *
+      * Initializes the element type (e.g., text, checkbox) and sets the optional property.
+      * Creates a default `TextInputElement` if the `elementType` is unrecognized.
+      *
+      * @param {fromJsonType} json - The JSON object with element properties, including `elementType` and `optional`.
+      * @returns {ElementEntity} The constructed `ElementEntity`.
+      */
+    static fromJSON(json: fromJsonType): ElementEntity;
+}

package/dist/types/modals/InteractiveElements/BaseInteractiveElement.d.ts

@@ -0,0 +1,25 @@
+import { APIAction, CustomAction, URLNavigationAction } from "../InteractiveActions";
+import { ElementEntity } from "../InteractiveEntities";
+import { fromJsonType } from "../InteractiveActions/APIAction";
+/**
+ * Represents a base interactive element in a interactive message.
+ */
+export declare class BaseInteractiveElement extends ElementEntity {
+    /**
+     * Represents an action that can be performed on the message.
+     */
+    private action;
+    constructor(elementId: string, elementType: string, action: APIAction | URLNavigationAction | CustomAction);
+    /**
+     * Returns the action associated with the bubble.
+     * @returns {APIAction | URLNavigationAction | CustomAction} The action associated with the bubble.
+     */
+    getAction(): APIAction | URLNavigationAction | CustomAction;
+    /**
+     * Creates a `BaseInteractiveElement` instance from a JSON object based on the element type.
+     * @param {fromJsonType} json - The JSON object containing the properties of the interactive element, including `elementType`.
+     * @param {string} json.elementType - The type of the element to create (e.g., `button`).
+     * @returns {BaseInteractiveElement} The constructed `BaseInteractiveElement` instance.
+     */
+    static fromJSON(json: fromJsonType): BaseInteractiveElement;
+}

package/dist/types/modals/InteractiveElements/ButtonElement.d.ts

@@ -0,0 +1,48 @@
+import { APIAction, CustomAction, URLNavigationAction } from "../InteractiveActions";
+import { BaseInteractiveElement } from "./index";
+import { fromJsonType } from "../InteractiveActions/APIAction";
+/**
+ * Represents a button element that can be added to a interactive bubble.
+ */
+export declare class ButtonElement extends BaseInteractiveElement {
+    /**
+     * The text to display on the button.
+     */
+    private buttonText;
+    /**
+     * Whether the button should be disabled after it is interacted with.
+     * */
+    private disableAfterInteracted?;
+    /**
+     * Creates an instance of ButtonInput.
+     * @param elementId - The unique identifier for the button element.
+     * @param action - The action to be performed when the button is clicked.
+     * @param buttonText - The text to display on the button.
+     */
+    constructor(elementId: string, action: APIAction | URLNavigationAction | CustomAction, buttonText: string);
+    /**
+     * Gets the text to display on the button.
+     * @returns The text to display on the button.
+     */
+    getButtonText(): string;
+    /**
+     * Gets whether the button should be disabled after it is interacted with.
+     * @returns Whether the button should be disabled after it is interacted with.
+     */
+    getDisableAfterInteracted(): boolean | undefined;
+    /**
+     * Sets whether the button should be disabled after it is interacted with.
+     * @param disableAfterInteracted - Whether the button should be disabled after it is interacted with.
+     */
+    setDisableAfterInteracted(disableAfterInteracted: boolean): void;
+    /**
+     * Creates a `ButtonElement` from a JSON object.
+     *
+     * Initializes a `ButtonElement` using JSON data, setting its action via `ActionEntity.fromJSON`
+     * and applying additional properties like `disableAfterInteracted` if provided.
+     *
+     * @param {fromJsonType} json - The JSON object with properties for the button element.
+     * @returns {ButtonElement} The constructed `ButtonElement` instance.
+     */
+    static fromJSON(json: fromJsonType): ButtonElement;
+}

package/dist/types/modals/InteractiveElements/CheckboxElement.d.ts

@@ -0,0 +1,46 @@
+import { BaseInputElement, OptionElement } from "./index";
+import { fromJsonType } from "../InteractiveActions/APIAction";
+/**
+ * Represents a checkbox input element.
+ */
+export declare class CheckboxElement extends BaseInputElement<string[]> {
+    /** The label of the input element. */
+    private label;
+    /** The default values to be selected in the checkbox. */
+    private defaultValue?;
+    /** The options available for the checkbox input element. */
+    private options;
+    /**
+     * Creates a new instance of the CheckboxInput class.
+     * @param elementId The ID of the input element.
+     * @param label The label of the input element.
+     * @param options The options available for the checkbox input element.
+     */
+    constructor(elementId: string, label: string, options?: OptionElement[]);
+    /**
+     * Gets the label of the input element.
+     * @returns The label of the input element.
+     */
+    getLabel(): string;
+    /**
+     * Sets the default values to be selected in the checkbox.
+     * @param defaultValue The default values to be selected in the checkbox.
+     */
+    setDefaultValue(defaultValue: string[]): void;
+    /**
+     * Gets the default values to be selected in the checkbox.
+     * @returns The default values to be selected in the checkbox.
+     * */
+    getDefaultValue(): string[] | undefined;
+    /**
+     * Gets the options available for the checkbox input element.
+     * @returns The options available for the checkbox input element.
+     */
+    getOptions(): OptionElement[];
+    /**
+     * Creates a `CheckboxElement` from a JSON object.
+     * @param {fromJsonType} json - The JSON object with properties for the checkbox element.
+     * @returns {CheckboxElement} The constructed `CheckboxElement` instance.
+     */
+    static fromJSON(json: fromJsonType): CheckboxElement;
+}

package/dist/types/modals/InteractiveElements/DateTimePickerElement.d.ts

@@ -0,0 +1,124 @@
+import { DateTimePickerMode } from "../../Enums/Enums";
+import { fromJsonType } from "../InteractiveActions/APIAction";
+import { BaseInputElement } from "./BaseInputElement";
+/**
+ * Represents a date and time picker element in a user interface.
+ */
+export declare class DateTimePickerElement extends BaseInputElement<string> {
+    /**
+     * The label for the date-time picker.
+     * @type {string}
+     */
+    private label;
+    /**
+     * The mode of the date-time picker (e.g., date, time, or both).
+     * @type {DateTimePickerMode}
+     */
+    private mode;
+    /**
+     * The default value for the date-time picker.
+     * @type {string}
+     */
+    private defaultValue?;
+    /**
+     * The start date for the date-time picker.
+     * @type {string}
+     */
+    private from?;
+    /**
+     * The end date for the date-time picker.
+     * @type {string}
+     */
+    private to?;
+    /**
+     * The time zone for the date-time picker.
+     * @type {string}
+     */
+    private timezoneCode;
+    /**
+     * The format for the date-time picker.
+     * @type {string | undefined}
+     */
+    private dateTimeFormat?;
+    /**
+     * Creates an instance of `DateTimePickerElement`.
+     */
+    constructor(elementId: string, label: string, mode: DateTimePickerMode, timezoneCode: string, optional?: boolean);
+    /**
+    * Returns the label of the date-time picker.
+    * @returns {string} The label.
+    */
+    getLabel(): string;
+    /**
+     * Returns the default value of the date-time picker.
+     * @returns {string | undefined} The default value.
+     */
+    getDefaultValue(): string | undefined;
+    /**
+     * Sets the default value for the date-time picker.
+     * @param {string} defaultValue - The default value to set.
+     */
+    setDefaultValue(defaultValue: string): void;
+    /**
+     * Returns the mode of the date-time picker.
+     * @returns {DateTimePickerMode} The mode.
+     */
+    getMode(): DateTimePickerMode;
+    /**
+     * Returns the start date of the date-time picker.
+     * @returns {string | undefined} The start date.
+     */
+    getFrom(): string | undefined;
+    /**
+     * Sets the start date for the date-time picker.
+     * @param {string} fromDateTime - The start date to set.
+     */
+    setFrom(fromDateTime: string): void;
+    /**
+     * Returns the end date of the date-time picker.
+     * @returns {string | undefined} The end date.
+     */
+    getTo(): string | undefined;
+    /**
+     * Sets the end date for the date-time picker.
+     * @param {string} toDateTime - The end date to set.
+     */
+    setTo(toDateTime: string): void;
+    /**
+     * Returns the format of the date-time picker.
+     * @returns {string | undefined} The date-time format.
+     */
+    getDateTimeFormat(): string | undefined;
+    /**
+     * Sets the format for the date-time picker.
+     * @param {string} dateTimeFormat - The format to set.
+     */
+    setDateTimeFormat(dateTimeFormat: string): void;
+    /**
+     * Formats a given date-time using the date-time format.
+     *
+     * @param {Date} dateTime - The date-time to format.
+     * @returns {string | undefined} The formatted date-time or undefined if formatting fails.
+     */
+    formatDateTime(dateTime: Date): string | undefined;
+    /**
+     * Sets the time zone code for the date-time picker.
+     * @param {string} timezoneCode - The time zone code to set.
+     */
+    setTimezoneCode(timezoneCode: string): void;
+    /**
+     * Returns the time zone code for the date-time picker.
+     * @returns {string} The time zone code.
+     */
+    getTimezoneCode(): string;
+    /**
+     * Creates a `DateTimePickerElement` from a JSON object.
+     *
+     * This method initializes a `DateTimePickerElement` using the provided JSON data, including properties such as
+     * default value, start and end dates, date-time format, and time zone code.
+     *
+     * @param {fromJsonType} json - The JSON object containing properties for the `DateTimePickerElement`.
+     * @returns {DateTimePickerElement} The constructed `DateTimePickerElement` instance.
+     */
+    static fromJSON(json: fromJsonType): DateTimePickerElement;
+}

package/dist/types/modals/InteractiveElements/DropdownElement.d.ts

@@ -0,0 +1,55 @@
+import { BaseInputElement, OptionElement } from "./index";
+import { fromJsonType } from "../InteractiveActions/APIAction";
+/**
+ * Represents a dropdown input element.
+ */
+export declare class DropdownElement extends BaseInputElement<string> {
+    /**
+     * The label of the input element.
+     */
+    private label;
+    /**
+     * The default value to be selected in the dropdown.
+     */
+    private defaultValue?;
+    /**
+     * The options available for the dropdown input element.
+     */
+    private options;
+    /**
+     * Creates a new instance of DropdownInput.
+     * @param elementId - The ID of the input element.
+     * @param label - The label of the input element.
+     * @param options - The options available for the dropdown input element.
+     */
+    constructor(elementId: string, label: string, options?: OptionElement[]);
+    /**
+     * Gets the label of the input element.
+     * @returns The label of the input element.
+     */
+    getLabel(): string;
+    /**
+     * Gets the default value to be selected in the dropdown.
+     * @returns The default value to be selected in the dropdown.
+     */
+    getDefaultValue(): string | undefined;
+    /**
+     * Sets the default value to be selected in the dropdown.
+     * @param defaultValue - The default value to be selected in the dropdown.
+     */
+    setDefaultValue(defaultValue: string): void;
+    /**
+     * Gets the options available for the dropdown input element.
+     * @returns The options available for the dropdown input element.
+     */
+    getOptions(): OptionElement[];
+    /**
+     * Creates a `DropdownElement` from a JSON object.
+     *
+     * Initializes a `DropdownElement` using JSON data for the element ID, label, options, and optional default value.
+     *
+     * @param {fromJsonType} json - JSON object containing the properties for the dropdown element.
+     * @returns {DropdownElement} The `DropdownElement` instance.
+     */
+    static fromJSON(json: fromJsonType): DropdownElement;
+}

package/dist/types/modals/InteractiveElements/LabelElement.d.ts

@@ -0,0 +1,29 @@
+import { ElementEntity } from "../InteractiveEntities/ElementEntity";
+import { fromJsonType } from "../InteractiveActions/APIAction";
+/**
+ * Represents a label element.
+ */
+export declare class LabelElement extends ElementEntity {
+    /** The text to display in the label. */
+    private text;
+    /**
+     * Creates a new instance of the LabelElement class.
+     * @param {string} elementId - The unique identifier of the form element.
+     * @param {string} text - The text to display in the label.
+     */
+    constructor(elementId: string, text: string);
+    /**
+     * Returns the text to display in the label.
+     * @returns {string} The text to display in the label.
+     */
+    getText(): string;
+    /**
+     * Creates a `LabelElement` from a JSON object.
+     *
+     * Initializes a `LabelElement` using the provided JSON data for the element ID and text.
+     *
+     * @param {fromJsonType} json - JSON object containing the properties for the label element.
+     * @returns {LabelElement} The `LabelElement` instance.
+     */
+    static fromJSON(json: fromJsonType): LabelElement;
+}

package/dist/types/modals/InteractiveElements/OptionElement.d.ts

@@ -0,0 +1,35 @@
+import { fromJsonType } from "../InteractiveActions/APIAction";
+/**
+ * Represents a option.
+ */
+export declare class OptionElement {
+    /** The unique identifier for the option. */
+    private label;
+    /** The display value for the option. */
+    private value;
+    /**
+     * Creates a new instance of the OptionElement class.
+     * @param {string} label - The unique identifier for the option.
+     * @param {string} value - The display value for the option.
+     */
+    constructor(label: string, value: string);
+    /**
+     * Returns the unique identifier for the option.
+     * @returns {string} The unique identifier for the option.
+     */
+    getLabel(): string;
+    /**
+     * Returns the display value for the option.
+     * @returns {string} The display value for the option.
+     */
+    getValue(): string;
+    /**
+     * Creates an `OptionElement` from a JSON object.
+     *
+     * Initializes an `OptionElement` using the provided JSON data for the label and value.
+     *
+     * @param {fromJsonType} json - JSON object containing the properties for the option element.
+     * @returns {OptionElement} The `OptionElement` instance.
+     */
+    static fromJSON(json: fromJsonType): OptionElement;
+}

package/dist/types/modals/InteractiveElements/RadioButtonElement.d.ts

@@ -0,0 +1,54 @@
+import { BaseInputElement, OptionElement } from "./index";
+import { fromJsonType } from "../InteractiveActions/APIAction";
+type fromJSONRadioType = fromJsonType & {
+    options: OptionElement[] & fromJsonType;
+};
+/**
+ * Represents a radio button input element.
+ */
+export declare class RadioButtonElement extends BaseInputElement<string> {
+    /** The label of the input element. */
+    private label;
+    /** The default value of the input element. */
+    private defaultValue?;
+    /** The options available for the radio input element. */
+    private options;
+    /**
+     * Creates a new instance of the RadioButtonElement class.
+     * @param elementId The ID of the radio button element.
+     * @param label The label of the radio button element.
+     * @param options The options available for the radio button element.
+     */
+    constructor(elementId: string, label: string, options?: OptionElement[]);
+    /**
+     * Gets the label of the input element.
+     * @returns The label of the input element.
+     */
+    getLabel(): string;
+    /**
+     * Gets the default value of the input element.
+     * @returns The default value of the input element.
+     */
+    getDefaultValue(): string | undefined;
+    /**
+     * Sets the default value of the input element.
+     * @param defaultValue The default value of the input element.
+     */
+    setDefaultValue(defaultValue: string): void;
+    /**
+     * Gets the options available for the radio input element.
+     * @returns The options available for the radio input element.
+     */
+    getOptions(): OptionElement[];
+    /**
+     * Creates a `RadioButtonElement` from a JSON object.
+     *
+     * Initializes a `RadioButtonElement` using the provided JSON data. It sets the element's options,
+     * label, and default value if specified.
+     *
+     * @param {fromJSONRadioType} json - JSON object containing properties for the radio button element.
+     * @returns {RadioButtonElement} The `RadioButtonElement` instance.
+     */
+    static fromJSON(json: fromJSONRadioType | fromJsonType): RadioButtonElement;
+}
+export {};

package/dist/types/modals/InteractiveElements/SingleSelectElement.d.ts

@@ -0,0 +1,50 @@
+import { BaseInputElement, OptionElement } from "./index";
+import { fromJsonType } from "../InteractiveActions/APIAction";
+/**
+ * Represents a singleSelect button input element.
+ */
+export declare class SingleSelectElement extends BaseInputElement<string> {
+    /** The label of the input element. */
+    private label;
+    /** The default value of the input element. */
+    private defaultValue?;
+    /** The options available for the singleSelect input element. */
+    private options;
+    /**
+     * Creates a new instance of the SingleSelectElement class.
+     * @param elementId The ID of the singleSelect button element.
+     * @param label The label of the singleSelect button element.
+     * @param options The options available for the singleSelect button element.
+     */
+    constructor(elementId: string, label: string, options?: OptionElement[]);
+    /**
+     * Gets the label of the input element.
+     * @returns The label of the input element.
+     */
+    getLabel(): string;
+    /**
+     * Gets the default value of the input element.
+     * @returns The default value of the input element.
+     */
+    getDefaultValue(): string | undefined;
+    /**
+     * Sets the default value of the input element.
+     * @param defaultValue The default value of the input element.
+     */
+    setDefaultValue(defaultValue: string): void;
+    /**
+     * Gets the options available for the singleSelect input element.
+     * @returns The options available for the singleSelect input element.
+     */
+    getOptions(): OptionElement[];
+    /**
+     * Creates a `SingleSelectElement` from a JSON object.
+     *
+     * Initializes a `SingleSelectElement` using the provided JSON data. It sets the element's options,
+     * label, and default value if specified.
+     *
+     * @param {fromJsonType} json - JSON object containing properties for the single select element.
+     * @returns {SingleSelectElement} The `SingleSelectElement` instance.
+     */
+    static fromJSON(json: fromJsonType): SingleSelectElement;
+}

package/dist/types/modals/InteractiveElements/TextInputElement.d.ts

@@ -0,0 +1,69 @@
+import { BaseInputElement } from "./index";
+import { fromJsonType } from "../InteractiveActions/APIAction";
+/**
+ * Represents a text input element.
+ */
+export declare class TextInputElement extends BaseInputElement<string> {
+    /** The label of the input element. */
+    private label;
+    /** The maximum number of lines for a multi-line text input element. */
+    private maxLines?;
+    /** The placeholder text to display in the input element. */
+    private placeholder?;
+    /**
+     * The default value in text input.
+     */
+    private defaultValue?;
+    /**
+     * Creates a new instance of the TextInputElement class.
+     * @param {string} elementId - The unique identifier of the form element.
+     * @param {string} label - The label of the input element.
+     */
+    constructor(elementId: string, label: string);
+    /**
+     * Returns the label of the input element.
+     * @returns {string} The label of the input element.
+     */
+    getLabel(): string;
+    /**
+     * Returns the maximum number of lines for a multi-line text input element.
+     * @returns {number} The maximum number of lines for a multi-line text input element.
+     */
+    getMaxLines(): number | undefined;
+    /**
+     * Sets the maximum number of lines for a multi-line text input element.
+     * @param {number} maxLines - The maximum number of lines for a multi-line text input element.
+     */
+    setMaxLines(maxLines: number): void;
+    /**
+     * Returns the placeholder text to display in the input element.
+     * @returns {string} The placeholder text to display in the input element.
+     */
+    getPlaceholder(): string | undefined;
+    /**
+     * Sets the placeholder text to display in the input element.
+     * @param {string} placeholder - The placeholder text to display in the input element.
+     */
+    setPlaceholder(placeholder: string): void;
+    /**
+     * Returns the default value in text input.
+     * @returns {string} The default value in text input.
+     */
+    getDefaultValue(): string | undefined;
+    /**
+     * Sets the default value in text input.
+     * @param {string} defaultValue - The default value in text input.
+     * @returns {string} The default value in text input.
+     */
+    setDefaultValue(defaultValue: string): void;
+    /**
+     * Creates a `TextInputElement` from a JSON object.
+     *
+     * Initializes a `TextInputElement` using the provided JSON data. It sets properties such as maximum lines,
+     * placeholder text, and default value if specified.
+     *
+     * @param {fromJsonType} json - JSON object containing properties for the text input element.
+     * @returns {TextInputElement} The `TextInputElement` instance.
+     */
+    static fromJSON(json: fromJsonType): TextInputElement;
+}

package/dist/types/modals/InteractiveElements/index.d.ts

@@ -0,0 +1,11 @@
+export { BaseInputElement } from "./BaseInputElement";
+export { BaseInteractiveElement } from "./BaseInteractiveElement";
+export { ButtonElement } from "./ButtonElement";
+export { CheckboxElement } from "./CheckboxElement";
+export { DropdownElement } from "./DropdownElement";
+export { LabelElement } from "./LabelElement";
+export { OptionElement } from "./OptionElement";
+export { RadioButtonElement } from "./RadioButtonElement";
+export { SingleSelectElement } from "./SingleSelectElement";
+export { TextInputElement } from "./TextInputElement";
+export { DateTimePickerElement } from "./DateTimePickerElement";

package/dist/types/modals/InteractiveEntities/ActionEntity.d.ts

@@ -0,0 +1,32 @@
+import { APIAction, CustomAction, URLNavigationAction } from "../InteractiveActions";
+import { ButtonAction } from "../../Enums/Enums";
+import { fromJsonType } from "../InteractiveActions/APIAction";
+/**
+ * Represents an action that can be performed on a UI element, such as a button.
+ */
+export declare class ActionEntity {
+    /**
+     * The type of action to perform when the UI element is interacted with.
+     */
+    private actionType;
+    /**
+     * Creates an instance of the ActionEntity class.
+     * @param {ButtonAction} actionType - The type of action that the button performs.
+     */
+    constructor(actionType: ButtonAction);
+    /**
+     * Returns the type of action to perform when the UI element is interacted with.
+     * @returns {ButtonAction} The type of action to perform when the UI element is interacted with.
+     */
+    getActionType(): ButtonAction;
+    /**
+     * Creates an action instance from a JSON object based on the action type.
+     *
+     * Initializes the appropriate action type (`APIAction`, `URLNavigationAction`, or `CustomAction`)
+     * using the provided JSON data. The action type is determined by the `actionType` property in the JSON.
+     *
+     * @param {fromJsonType} json - JSON object containing the action type and properties.
+     * @returns {APIAction | URLNavigationAction | CustomAction} The corresponding action instance.
+     */
+    static fromJSON(json: fromJsonType): APIAction | URLNavigationAction | CustomAction;
+}