Class

INSearchForNotebookItemsIntentResponse

Your app’s response to a request to search for notes, tasks, or reminders.

Declaration

class INSearchForNotebookItemsIntentResponse : INIntentResponse

Overview

Use an INSearchForNotebookItemsIntentResponse object to return the search results requested by the user. Siri communicates the information from your response to the user at appropriate times.

You create an INSearchForNotebookItemsIntentResponse object in the confirm(intent:completion:) and handle(intent:completion:) methods of your handler object. For more information about implementing your handler object, see INSearchForNotebookItemsIntentHandling.

Topics

Initializing the Response Object

init(code: INSearchForNotebookItemsIntentResponseCode, userActivity: NSUserActivity?)

Initializes the response object with the specified code and user activity object.

Getting the Response Code

var code: INSearchForNotebookItemsIntentResponseCode

The code indicating whether your app successfully handled the intent.

enum INSearchForNotebookItemsIntentResponseCode

Constants indicating the state of the response.

Specifying the Search Results

var notes: [INNote]?

The notes found by the search.

var taskLists: [INTaskList]?

The task lists found by the search.

var tasks: [INTask]?

The individual tasks found by the search.

var sortType: INSortType

An indicator of how you sorted the search results.

enum INSortType

Constants indicating how the intent sorted the search results.

Relationships

Inherits From

Conforms To

See Also

Search for Notebook Items

protocol INSearchForNotebookItemsIntentHandling

The handler interface for searching for notes, tasks, and reminders.

class INSearchForNotebookItemsIntent

A request to search for notes, tasks, and reminders.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software