Methods
registerAutocompleteListener
registerAutocompleteListener(listener): FlowArgumentRegister a listener for a autocomplete event.
This is fired when the argument is of type autocomplete
and the user typed a query.
Parameters
Name | Type | Description |
---|---|---|
listener
|
FlowCard.ArgumentAutocompleteCallback | Should return a promise that resolves to the autocomplete results. |
Returns
Example
const myActionCard = this.homey.flow.getActionCard('my_action');
const myActionCardMyArg = myAction.getArgument('my_arg');
myActionCardMyArg.registerAutocompleteListener(async (query, args) => {
const results = [
{
name: 'Value name',
description: 'Optional description',
icon: 'https://path.to/icon.svg',
// For images that are not svg use:
// image: 'https://path.to/icon.png',
// You can freely add additional properties to access in registerRunListener
id: '...',
},
];
// filter based on the query
return results.filter((result) => {
return result.name.toLowerCase().includes(query.toLowerCase());
});
});