Lists and Notes

Create and manage notes and to-do list items.

Overview

With the lists and notes domain, users can create to-do lists, mark to-do list items as complete, or ask Siri to create or modify notes in their favorite note-taking app. When creating items in a to-do list, the user may also ask you to set up a reminder based on the user's location or a specific date. Your intents app extension takes the information provided to it and creates the corresponding tasks, notes, and reminders either directly in your app or by communicating that information to your servers.

Topics

First Steps

protocol INNotebookDomainHandling

An interface for adopting all of the protocols in the lists and notes domain.

Create Note

protocol INCreateNoteIntentHandling

The handler interface for creating notes.

class INCreateNoteIntent

A request to create a new note.

class INCreateNoteIntentResponse

Your app's response to a request to create a note.

Append to Note

protocol INAppendToNoteIntentHandling

The handler interface for appending content to a note.

class INAppendToNoteIntent

A request to append content to a note.

class INAppendToNoteIntentResponse

Your app's response to a request to append content to a note.

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.

class INSearchForNotebookItemsIntentResponse

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

Create Task List

protocol INCreateTaskListIntentHandling

The handler interface for creating task lists.

class INCreateTaskListIntent

A request to create a new task list.

class INCreateTaskListIntentResponse

Your app's response to a request to create a task list.

Add Task

protocol INAddTasksIntentHandling

The handler interface for adding tasks to a task list.

class INAddTasksIntent

A request to add tasks to a task list.

class INAddTasksIntentResponse

Your response to a request to add tasks to a task list.

Set Task Attributes

protocol INSetTaskAttributeIntentHandling

The handler interface for updating the attributes of an existing task.

class INSetTaskAttributeIntent

A request to modify the attributes of a task.

class INSetTaskAttributeIntentResponse

Your response to a request to modify the attributes of an existing task.

Note Objects

class INNote

The content and metadata associated with a single note entry in your app.

class INNoteContent

An abstract class that defines the types of content that can be contained in notes.

class INTextNoteContent

The textual content of a note.

class INImageNoteContent

An image contained in a note.

Task Objects

class INTaskList

A collection of individual tasks.

class INTask

An individual task to be completed by the user.

Event Triggers

class INSpatialEventTrigger

A trigger condition based on the user's arrival or departure from a given location.

class INTemporalEventTrigger

A trigger condition based on a date or time.

Resolution Results

class INDateSearchTypeResolutionResult

A resolution result for the types of dates supported by a search.

class INLocationSearchTypeResolutionResult

A resolution result for location-based searches.

class INNoteResolutionResult

A resolution result for notes.

class INNoteContentResolutionResult

A resolution result for the content of notes.

class INNotebookItemTypeResolutionResult

A resolution result for the type of items to look for during a search of notes and tasks.

class INTaskListResolutionResult

A resolution result for a list of tasks.

class INTaskResolutionResult

A resolution result for a single task within a task list.

class INTaskStatusResolutionResult

A resolution result for the status of a task.

class INSpatialEventTriggerResolutionResult

A resolution result for the location-based trigger associated with a task.

class INTemporalEventTriggerResolutionResult

A resolution result for the time-based trigger associated with a task.

class INNoteContentTypeResolutionResult

A resolution result for the type of data contained in notes.