Class

INSearchForAccountsIntent

A request for information about the user’s accounts in your app.

Declaration

class INSearchForAccountsIntent : INIntent

Overview

Siri creates an INSearchForAccountsIntent object when the user asks for information about accounts managed by your app. Accounts can be monetary or nonmonetary. For example, an airline app might allow the user to search for an account containing frequent flier miles. The user can ask for a list of accounts or ask for the balance of a particular account. Use the information provided by the intent object to look up the user’s accounts and provide information about those accounts.

To handle this intent, the handler object in your Intents extension must adopt the INSearchForAccountsIntentHandling protocol. Your handler should confirm the request and create an INSearchForAccountsIntentResponse object with the accounts matching the specified criteria. For successful searches, Siri offers a way for the user to view the results.

Additional Intent Attributes

Table 1 lists additional attributes of this intent object.

Table 1

Search for accounts intent attributes

Attribute

Description

Supported by

Siri Intents

Always requires unlocked device

Yes

When performing a search, Siri automatically asks the user to unlock a currently locked device. You don’t need to explicitly ask to unlock the device. In addition, Siri always prompts the user to confirm the request before asking your Intents extension to handle it.

Example Phrases

Users can ask Siri to search for accounts in a variety of ways. Table 2 provides a few sample phrases in different languages. You can use these phrases during testing to trigger your intents. This list isn’t exhaustive and Siri may recognize many other phrases.

Table 2

Siri phrases that trigger the searching of the user’s accounts

Locale

Example 1

Example 2

en

How much money is in my checking account?

How many points are on my credit card?

zh_CN

我的支票账户里面有多少钱

我的信用卡上面有多少点数

zh_HK

我嘅支票戶口入面有幾多錢

我嘅信用卡入面有幾多積分點數

zh_TW

存款帳戶裡有多少錢

我信用卡上有多少點數

yue_CN

我嘅支票户口入面有几多钱

我嘅信用卡入面有几多积分点数

ar

كم من المال في حسابي بالبنك الوطني

كم نقطة على بطاقة الائتمان الخاصة بي

da

hvor mange penge er der i min lønkonto

hvor mange points er på mit kreditkort

de

Wie viel Geld ist auf meinem Girokonto

Wie viele Punkte habe ich mit meiner Kreditkarte gesammelt.

es

¿Cuánto dinero tengo en mi cuenta corriente?

Dime cuántos puntos tiene mi tarjeta de crédito

fi

Kuinka paljon minulla on rahaa käyttötilillä

Kuinka monta bonuspistettä on luottokortillani

fr

Combien y a-t-il sur mon compte courant

Combien de points y a-t-il sur ma carte de crédit

he

כמה כסף יש בחשבון החסכון שלי

כמה נקודות יש בכרטיס אשראי שלי

it

Quanti soldi ci sono nel mio conto bancario

Quanti punti ho sulla mia carta di credito

ja

チェッキング口座にお金はいくらある

クレジットカードのポイントはどれくらい

ko

통장에 돈 얼마나 있어

신용카드에 포인트 얼마나 있어

ms

Berapa banyak wang dalam akaun semasa saya

Berapakah mata pada kad kredit saya

nb

Hvor mye penger er det på brukskontoen min

Hvor mange poeng har jeg på kredittkortet

nl

Hoeveel geld heb ik op mijn betaalrekening

Hoeveel punten staan er op mijn creditcard.

pt

Quanto dinheiro tem na minha conta corrente

Quantos pontos tem no meu cartão de crédito

ru

Сколько денег на моём текущем счету

Сколько бонусных баллов на моей кредитной карточке

sv

Hur mycket pengar finns det på mitt bankkonto

Hur många poäng har jag på mitt kreditkort

th

ฉันมีเงินอยู่ในบัญชีกระแสรายวันอยู่เท่าไหร่

ฉันมีแต้มบัตรเครดิตเท่าไหร่

tr

Birikim hesabımda ne kadar bakiye var

Kredi kartımda ne kadar puan var

In Table 2, <appName> represents the name of the app whose Intents extension handles the transaction.

Topics

Initializing the Intent Object

Getting the Search Attributes

var accountNickname: INSpeakableString?

The nickname that the user assigned to the account.

var accountType: INAccountType

The type of the account.

var organizationName: INSpeakableString?

The name of an organization attached to the account.

var requestedBalanceType: INBalanceType

The balance type requested by the user.

enum INBalanceType

Constants indicating the meaning of a balance.

Relationships

Inherits From

Conforms To

See Also

Search for Accounts

protocol INSearchForAccountsIntentHandling

The handler interface for searching for account information.

class INSearchForAccountsIntentResponse

Your app’s response to a request to search for account information.

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