The documentation is currently a work in progress whilst the product is in alpha.

AndroidInput

Android Only

The interface used to enable advanced user input on a notification.


View the Action input documentation to learn more.

Properties

allowFreeFormInput

Sets whether the user can freely enter text into the input.

allowFreeFormInput?: undefined | false | true;

This value changes the behaviour of the notification:

  • If true, when an action is pressed this allows the user to type free form text into the input area.
  • If false, you must provide an array of choices the user is allowed to use as the input.

Defaults to true.

allowGeneratedReplies

Sets whether generated replies can be added to the action.

allowGeneratedReplies?: undefined | false | true;

Generated replies will only be shown if the input has choices and whether the device is able to generate replies.

Defaults to true.

choices

An array of pre-defined input choices the user can select.

choices?: string[];

If allowFreeFormInput is false, this property must contain at least one choice.

editableChoices

If true, the user will be able to edit the selected choice before sending the action event, however allowFreeFormInput must also be true.

editableChoices?: undefined | false | true;

By default, the platform will decide whether choices can be editable. To explicitly enable or disable this, provide true or false.

placeholder

The placeholder text to display inside of the user input area.

placeholder?: undefined | string;

Copyright 2020 © Invertase Limited

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License and code samples are licensed under the Apache 2.0 License.

All product names, logos, and brands are property of their respective owners. All company, product and service names used in this website are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.