Class

INSearchForNotebookItemsIntent

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

Overview

Siri creates an INSearchForNotebookItemsIntent object when the user asks to search for existing notes, tasks, and reminders. The intent object contains search parameters such as the type of items to return, strings to match against the title or content, the completion status of tasks, or the trigger conditions used to generate reminders.

To handle this intent, the handler object in your Intents extension must adopt the INSearchForNotebookItemsIntentHandling protocol. Your handler should confirm the request and create an INSearchForNotebookItemsIntentResponse object with the search results.

For a list of other intents in the lists and notes domain, see INNotebookDomainHandling.

Additional Intent Attributes

Table 1 lists additional attributes of this intent object.

Table 1

Search for notebook items intent attributes

Attribute

Description

Supported by

Siri

Always requires unlocked device

Yes

Example Phrases

There are many ways in which users can ask Siri to search for notebook items. Table 2 provides a few sample phrases in different languages. You can use these phrases during testing to trigger your intents. This list is not exhaustive and Siri may recognize many other phrases.

Table 2

Siri phrases that trigger a search for notes, tasks, task lists, or reminders

Locale

Example 1

Example 2

en

Show me all my notes on <appName>

Show me what I created last week on <appName>

zh_CN

显示我所有的便笺(在<appName> 上)

显示我上个星期所有新建立的(在 appName> 上)

zh_HK

顯示(<appName> 入面)所有嘅備忘錄

顯示我上星期(喺 <appName>)建立嘅項目

zh_TW

顯示我所有的備忘錄(在 <appName> 上)

顯示我上週在 <appName> 上建立的東西

yue_CN

显示(<appName> 入面)所有嘅备忘录

显示我上星期(喺 <appName>)建立嘅项目

ar

اعرض جميع ملاحظاتي على <appName>

اعرض ما تم إنشاؤه الأسبوع الماضي على <appName>

da

vis mig alle mine noter i <appName>

vis mig hvad blev oprettet i <appName> sidste uge i

de

Zeige mir alle meine Notizen auf <appName>

Zeig mir die Notizen die ich letzte Woche in <appName> erstellt habe

es

Enséñame todas mis notas en <appName>

Muéstrame lo que creé en <appName> la semana pasada

fi

Näytä kaikki muistutukset apissa <appName>

Näytä viime viikolla apissa <appName> luomani muistutukset

fr

Montre-moi toutes mes notes sur <appName>

Montre-moi ce que j'ai créé la semaine dernière sur <appName>

he

תראי לי את כל הפתקים ב<appName>

תראי מה יצרתי שבוע שעבר ב<appName>

it

Mostrami tutte le mie note su <appName>

Mostrami cosa ho creato la scorsa settimana su <appName>

ja

<appName> のメモを全部見せて

<appName> で先週作ったメモを全部見せて

ko

<appName> 에 있는 모든 노트 보여줘

<appName> 에서 지난 주에 만든 것 보여줘

ms

Tunjukkan semua nota saya pada <appName>

Tunjukkan item yang diciptakan minggu lepas pada <appName>

nb

Vis alle notatene mine i <appName>

Vis det jeg laget i forrige uke på <appName>

nl

Toon me alle notities in <appName>

Toon wat ik vorige week aangemaakt heb op <appName>

pt

Mostrar todas as minhas notas no <appName>

Mostre o que eu criei na semana passada no <appName>

ru

Покажи все мои заметки в <appName>

Покажи мне что я создал на прошлой неделе в <appName>

sv

Visa mig alla mina anteckningar i <appName>

Visa mig vad jag skapade förra veckan i <appName>

th

แสดงโน้ตทั้งหมดบนแอพ <appName>

แสดงสิ่งที่ฉันสร้างอาทิตย์ที่แล้วในแอพ <appName>

tr

<appName> 'deki tüm notlarımı göster

<appName> 'de geçen hafta oluşturduğum notları göster

In the preceding examples, <appName> represents the name of the app whose Intents extension handles the request.

Topics

Searching by Type

var itemType: INNotebookItemType

The type of items to include in your search.

enum INNotebookItemType

Constants indicating the types of items to search.

Searching by Content

var title: INSpeakableString?

The title text to search for in a note, task, or task list.

var content: String?

The text to search for in the body of a note.

Searching for Tasks by Their Status

var status: INTaskStatus

The completion state to look for when searching for tasks.

enum INTaskStatus

Constants indicating the completion state of a task.

Searching for Tasks by Location

var location: CLPlacemark?

The value to use when searching for location-triggered reminders.

var locationSearchType: INLocationSearchType

An indicator of how to apply location values to your search.

enum INLocationSearchType

Constants indicating the type of location-based search to perform.

Searching by Date

var dateTime: INDateComponentsRange?

The value to use when performing date-based searches.

var dateSearchType: INDateSearchType

An indicator of how to apply date values to your search.

enum INDateSearchType

Constants indicating the type of date-based search to perform.

Identifying the Notebook Item

var notebookItemIdentifier: String?

The unique identifier that your app assigned to the item.

Relationships

Inherits From

Conforms To

See Also

Search for Notebook Items

protocol INSearchForNotebookItemsIntentHandling

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

class INSearchForNotebookItemsIntentResponse

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