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

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.

Delete a Task

protocol INDeleteTasksIntentHandling

An interface that handles requests to delete tasks from a task list.

Beta
class INDeleteTasksIntent

A request to delete one or more tasks.

Beta
class INDeleteTasksIntentResponse

Your response to a request to delete tasks.

Beta

Snooze a Task

protocol INSnoozeTasksIntentHandling

The handler interface that snoozes tasks in a task list.

Beta
class INSnoozeTasksIntent

A request to snooze one or more tasks.

Beta
class INSnoozeTasksIntentResponse

Your response to a delete tasks request.

Beta

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 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 the user needs to complete.

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.

class INTemporalEventTriggerTypeOptionsResolutionResult

A resolution result that adds a temporal event trigger.

Beta

Resolution Results

class INAddTasksTargetTaskListResolutionResult

A resolution result that adds tasks to a target task list.

Beta
class INDeleteTasksTaskListResolutionResult

A resolution result for deleting task lists.

Beta
class INDeleteTasksTaskResolutionResult

A resolution result for deleting tasks.

Beta
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 INSnoozeTasksTaskResolutionResult

A resolution result for snoozing a task.

Beta
class INSpatialEventTriggerResolutionResult

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

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 INTemporalEventTriggerResolutionResult

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

class INTaskPriorityResolutionResult

A resolution result for the priority associated with a task.

Beta
class INNoteContentTypeResolutionResult

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

Deprecated

See Also

Siri Domains

Messaging

Send messages and search the user’s received messages.

Workouts

Start, end, and manage fitness routines.

Payments

Send payments between users or pay bills.

VoIP Calling

Initiate calls and search the user’s call history.

Visual Codes

Convey contact and payment information using Quick Response (QR) codes.

Photos

Search for and display photos.

Ride Booking

Book rides and report their status.

Car Commands

Manage vehicle door locks and get the vehicle’s status.

CarPlay

Interact with a vehicle’s CarPlay system.

Restaurant Reservations

Create and manage restaurant reservations with help from the Maps app.

Media

Listen and control audio through Siri Intents or listen and watch media content from your app with shortcuts.

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