介紹SiriKit
SiriKit是讓你的內容通過Siri展示的一個框架庫。當用戶向Siri請求特別類型的服務時,系統就會使用Intents Extension(自定義)來支持那些服務,如果需要圖形界面交互,還可以創建Intents Extension UI來在Siri界面上顯示自定義的UI界面。
目前為止,Siri只支持下面的6種服務類型:
- 語音或者視頻呼叫
- 信息通訊
- 支付功能
- 查找圖片
- 鍛煉
- 預約出行工具
交互過程

1 Siri語義解析,得到一個Intent,傳給Intent Extension處理
2 自定義處理對象時限相關服務域協議,resolve、confirm、handle(必須有)三個步驟某個intent。
3 返回XXXIntentResponse對象給Siri,用于回饋一個intent的響應
Siri和Maps通過intent擴展于你的app進行交互。intent擴展的入口點事INExtension對象,其唯一的工作就是讓Siri能夠響應到用戶的請求。當要實現一個intent擴展時,有三個類型對象是你會經常用到的:
- 一個定義了用戶的intent以及包含Siri從用戶收集到的信息的intent對象。
- 一個自定義處理對象,你可以用來解析、確認、處理某個intent。
- 一個數據對象,用于回饋一個intent的響應對象。
當有合適給你的擴展處理的intent時,Siri會向你的INExtension對象索要一個可以用來處理的這個intent的對象。
一個處理對象,可以是想要的任意類型。但它必須實現一些特殊的方法,以此來處理傳遞過來的intent。
每個intent的處理必須采用相關的協議。該協議的方法有三類:解析方法、確認方法、處理方法。
你可以在這些方法里面實現如何處理某個intent,并且返回那些提供給Siri的數據。
下面的圖片顯示了在Siri和你的擴展里面的處理程序對象中的高級別流。
在這個例子中,當用戶使用出行預約服務請求一個預約時,Siri創建一個包含出行的參數的intent對象,并將它發送到適合的擴展。
解析處理方法分析這個intent包含的這些值是否能夠滿足乘坐值。當所有的出行參數都得到解決,Siri詢問用戶要如何處理這個請求以及執行任何最終的驗證。
在確認階段,處理程序提供了一個包含出行細節的響應對象,Siri會將這個對象呈現給用戶。
如果用戶接受了這個出行預約,Siri就會要求處理程序來處理這個intent。而處理程序則進行處理,并返回一個詳細的響應結果
項目配置
為了支持SiriKit,必須先添加一個intent擴展到你的應用。
添加應用擴展:Intents Extension,假如你想自定義在Siri的界面,則勾選包含UIExtension選項;
打開Intent Extension的info.plist,在NSExtension的NSExtensionAttributes鍵下,可以看到 IntensSupported 和IntentsRestrictedWhileLocked,分別代表著支持的Intent和鎖屏狀態下支持的Intent。而NSExtensionPrincipalClass字段定義了處理Intent的入口類(繼承于INExtension)。
解析以及處理Intents
當Intent傳入到入口類中,首先會調用- (id)handlerForIntent:(INIntent *)intent;
方法,該方法的返回值是一個實現了XXXIntentHandling
協議的對象,也就是上文中的處理類。
每一個XXXIntentHandling
協議中會定義一個必須實現的handle
方法,一個可選的confirm
方法,和若干reslove
方法(依據當前場景下Intent參數而定)。
比如Payment的INSendPaymentIntentHandling
協議
功能 | 代碼 |
---|---|
處理方法 | - handleSendPayment:completion: |
確認方法 | - confirmSendPayment:completion: |
解析貨幣單位方法 | - resolveCurrencyAmountForSendPayment:withCompletion: |
解析附加語方法 | - resolveNoteForSendPayment:withCompletion: |
解析付款方式方法 | - resolvePaymentMethodForSendPayment:withCompletion: |
解析收款人方法 | - resolvePayeeForSendPayment:withCompletion: |
依照不同的場景(Intents Domains)和不同的命令,協議中的解析方法數目會變化。每一個解析方法都需要得到一個INIntentResolutionResult
類型的實例,用來保存校驗結果。
INIntentResolutionResult
及其子類有不同的構造方法生成不同類型的結果,用來指定和Siri的交互。
值類型 | 說明 |
---|---|
INIntentResolutionResult | |
+ (instancetype)needsValue; | 需要一個值,Siri會提示用戶給一個值 |
+ (instancetype)notRequired; | 不是必要的,是否給值都會過這個resolve |
+ (instancetype)unsupported; | 不支持的,Siri會提示用戶這個值不被支持 |
INBooleanResolutionResult | |
+ (instancetype)successWithResolvedValue:(BOOL)resolvedValue; | 成功解析 |
+ (instancetype)confirmationRequiredWithValueToConfirm:(nullable NSNumber *)valueToConfirm; | Siri提示用戶確認當前是否是一個bool值 |
當一個intent的所有參數都成功解析了,處理程序就會向用戶詢問是否確認這個intent的細節,并且提供一個建議響應。當所有參數被成功解析后,或者在不要求所有參數進行解析,那么就認為是解析成功。
在確認期間,就可以執行所有的intent參數的附加驗證,以確保你可以使用該信息來執行所請求的服務。如果之前的解析函數是單元測試,那么這個確認函數就是集成測試,保證所有輸入參數正確。
最后一個處理intent的階段,就是執行與這個intent相關的動作。在-handleSendPayment:completion
函數中做相應業務邏輯,需要注意的是你在Extension中做的修改也應當反應到App主程序當中,所以需要提供任務的數據給到App。SiriKit提供了一個包含intent細節(INIntent、INIntentResponse
)的InInteraction對象,你可以使用userActivityInstance.interaction
得到它,在App啟動時調用
- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray *restorableObjects))restorationHandler
函數處理來自Extension的數據。
自定義界面(Intent UI Extension)
上文說道,創建Extension的時候,可以在新建頁面勾選UI Extension選項,創建一個Extension工程來展示頁面。
配置
同樣我們打開UI Extension的info.plist文件,我們能看見NSExtension鍵,其中有NSExtensionMainStoryboard
這個鍵值,用來指定入口的StoryBoard。和App不一樣的是,如果不適用StoryBoard方式,我們需要使用NSExtensionPrincipalClass這個鍵來指定入口的ViewController。
實現ViewController
系統創建了ViewController,加載視圖,調用viewDidLoad
方法并且調用了INUIHostedViewControlling
協議的configureWithInteraction:context:completion:
方法,傳遞了一個交互對象,用于配置界面。 當配置完成后,ViewController就會展示在Siri或者Maps應用界面的空白部分。這時會調用viewWillAppear/viewDidAppear
方法。
當視圖消失時,也會調用生命周期的viewWillDisappear/viewDidDisappear
方法。
關于控制器的使用,蘋果給出了幾點注意事項:
切換子控制器來展示不同類型的內容。 你的Intents UI擴展只有一個主視圖控制器,如果你想為不同的Intents展示不同的內容,你需要使用不同的視圖??梢栽?strong>configureWithInteraction:context:completion:這個方法里面,根據提供的intentObject來創建不同的子視圖。
在你的視圖控制器可用的期間,動態調整內容。 在** viewDidAppear:方法里面才開始啟動動畫,在viewWillDisappear: **方法里面要結束動畫。
盡快的配置好你的視圖控制器,這樣Siri才能更快的展示它。 你的視圖控制器也許不會在屏幕上停留太久,所以盡量利用本地資源以及提供的INInteraction對象來配置你的設置。如果你需要從服務器拉取更多的信息,請異步完成,并在稍后再更新你的界面。
請不要在界面里面展示廣告。你可以展示你自己的品牌信息,但是你不能夠加入其它廣告。
參考資料:
SiriKit 學習筆記
SiriKit編程指南