ドキュメント

Intentのハンドル

Intentを実行し、処理内容に関するフィードバックをSiriKitに提供します。

最新の英語ドキュメント

Handling an Intent

概要

Intentのリゾルブとコンファームが完了すると、SiriKitから、ユーザーのリクエストを実行することでIntentをハンドルするよう求められます。Intentをハンドルする際は、以下を実行します。

Intentに対応するタスクを実行する。
何を実行したかに関する情報を格納した、responseオブジェクトを返す。

ほとんどのIntentはIntents App Extensionから直接ハンドルしますが、場合によって、アプリにリクエストをハンドルさせるよう、SiriKitに依頼できます。

例：ワークアウト開始Intentをハンドルする

ワークアウトアプリではタイマーやその他のヘルスケア関連情報を構成しなければならない場合がありますが、これらのタスクをIntents App Extensionからハンドルするのは容易ではありません。このため、ワークアウトIntentのハンドルでは、SiriKitにアプリの起動を指示します。

リスト1は、ワークアウト開始のハンドル方法の例です。このメソッドで作成されるresponseオブジェクトには、SiriKitがアプリを起動する必要があることを示すコードが含まれています。

リスト1

ワークアウト開始Intentをハンドルする

func handle(startWorkout intent: INStartWorkoutIntent,
       completion: @escaping (INStartWorkoutIntentResponse) -> Void) {
    // Let the app start the workout. 
    let response = INStartWorkoutIntentResponse(code: .continueInApp,
             userActivity: nil)
    completion(response)
}

例：配車リクエストIntentをハンドルする

配車予約アプリは、ユーザーが予約する乗車について詳細な情報を提供する必要があります。配車予約情報を取得するには、自分の組織のサービスとやり取りし、返された情報を使ってINRideStatus（英語）オブジェクトを作成する必要があります。

リスト2は、配車予約リクエストに応答する方法の例を示しています。メソッドの多くは、乗車の詳細情報をINRideStatus（英語）オブジェクトに配置するものです。そのプロセスにおいて、メソッドは乗車の詳細情報を配車予約サービスに伝え、配車される車と運転手の情報を取得します。メソッドは最終的に、INRideStatus（英語）オブジェクトを含むレスポンスをSiriKitに返します。

リスト2

配車リクエストIntentをハンドルする

func handle(requestRide intent: INRequestRideIntent, 
        completion: @escaping (INRequestRideIntentResponse) -> Void) {
    var rideOption : INRideOption? = nil
        
    // Save a reference to the ride for status updates
    self.bookedRideIntent = intent
        
    if let phrase = intent.rideOptionName?.spokenPhrase {
        switch phrase {
        case "SUV":
            rideOption = self.createSUVRideOption(pickup: 
                        intent.pickupLocation!, 
                        dropOff: intent.dropOffLocation!)
            break
        case "Compact":
            rideOption = self.createCompactRideOption(pickup: 
                        intent.pickupLocation!, 
                        dropOff: intent.dropOffLocation!)
            break
        case "Sedan":
            rideOption = self.createSedanRideOption(pickup:
                        intent.pickupLocation!, 
                        dropOff: intent.dropOffLocation!)
            break
                
        default:    // Default to a sedan.
            rideOption = self.createSedanRideOption(pickup:
                        intent.pickupLocation!, 
                        dropOff: intent.dropOffLocation!)
            break
        }
    }
        
    // Create the status for the response.
    let rideStatus = INRideStatus()
    rideStatus.rideOption = rideOption
    let (vehicle, driver) = self.getVehicleAndDriver(intent: intent,
            rideOption: rideOption!)
        
    // Assign the driver and vehicle.
    rideStatus.vehicle = vehicle
    rideStatus.driver = driver
    rideStatus.estimatedPickupDate = 
             self.getPickupTimeForVehicle(vehicle : vehicle)
    rideStatus.pickupLocation = intent.pickupLocation
    rideStatus.dropOffLocation = intent.dropOffLocation

    // Book the ride and get its ID.
    rideStatus.rideIdentifier = 
             self.bookRide(rideDetails : rideStatus)
    
    // Get the current ride phase. 
    rideStatus.phase = 
             self.phaseForRide(identifier : rideStatus.rideIdentifier)

    // Deliver the response to SiriKit
    if rideStatus.phase == .confirmed {
        let response = INRequestRideIntentResponse(code: .success,
               userActivity: nil)
        response.rideStatus = rideStatus
        completion(response)
    } else {
        let activity = NSUserActivity(activityType:
            "com.example.myRideApp.noRideAvailable")
        let response = INRequestRideIntentResponse(code: 
               .failureRequiringAppLaunch, userActivity: activity)
        response.rideStatus = rideStatus
        completion(response)
    }
}