registerSuggestedEntitiesHandler method

void registerSuggestedEntitiesHandler(String entityIdentifier, Future<List<Map<String, dynamic>>> handler())

Registers a handler for providing suggested/default entities.

When iOS displays a picker for the entity type, this handler will be called to provide a list of suggested entities that the user can choose from.

The handler should return a list of entity maps representing commonly used or recently accessed items.

Example:

AppIntentsPlatform.instance.registerSuggestedEntitiesHandler(
  'TaskEntity',
  () async {
    final recentTasks = await database.getRecentTasks(limit: 10);
    return recentTasks.map((t) => {
      'id': t.id,
      'title': t.title,
      'displayRepresentation': t.title,
    }).toList();
  },
);

Implementation

void registerSuggestedEntitiesHandler(
  String entityIdentifier,
  Future<List<Map<String, dynamic>>> Function() handler,
) {
  throw UnimplementedError(
      'registerSuggestedEntitiesHandler() has not been implemented.');
}