Flutter でのキャプチャ | Unico Developer Portal

Flutter でのキャプチャ

プラットフォームチャネルを使って Flutter アプリからキャプチャを開きます。

バックエンドは、Journey フローと、アプリの URL スキームを使った callbackUri を指定して、Human Plugin にプロセスを作成します。MethodChannel が、レスポンスの link を iOS では ASWebAuthenticationSession で、Android では Custom Tabs で開きます。外部パッケージは不要です。

作成のレスポンスの Human Plugin id を保持してください。バックエンドはこの id で結果を読み取ります。

前提条件

Flutter 3 以降
iOS 向け: Xcode 14 以降
Android 向け: Android Studio
myapp のような、アプリ固有の URL スキーム

1. スキームを指定してプロセスを作成する

バックエンドはスキームを callbackUri として送信します。

{
  "flow": "humantoken",
  "clientId": "client-a",
  "correlationId": "order-1001",
  "credential": { "type": "DUI_TYPE_NG_BVN", "value": "<document number>" },
  "callbackUri": "myapp://callback"
}

そして id と link をアプリに返します。

2. Dart サービスを作成する

// lib/services/capture_service.dart
import 'package:flutter/services.dart';

class CaptureService {
  static const _channel = MethodChannel('capture_plugin');

  /// キャプチャが終了した場合は true、本人が閉じた場合は false を返します。
  Future<bool> open(String link) async {
    try {
      final result = await _channel.invokeMethod<String>('openSession', {'url': link});
      return result != null;
    } on PlatformException {
      return false;
    }
  }
}

3. iOS プラグインを実装する

// ios/Runner/CapturePlugin.swift
import Flutter
import AuthenticationServices

class CapturePlugin: NSObject, FlutterPlugin, ASWebAuthenticationPresentationContextProviding {
    private var session: ASWebAuthenticationSession?

    static func register(with registrar: FlutterPluginRegistrar) {
        let channel = FlutterMethodChannel(name: "capture_plugin", binaryMessenger: registrar.messenger())
        let instance = CapturePlugin()
        registrar.addMethodCallDelegate(instance, channel: channel)
    }

    func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
        guard call.method == "openSession",
              let args = call.arguments as? [String: Any],
              let urlString = args["url"] as? String,
              let url = URL(string: urlString) else {
            result(FlutterMethodNotImplemented)
            return
        }

        let newSession = ASWebAuthenticationSession(
            url: url,
            callbackURLScheme: "myapp"
        ) { callbackURL, error in
            self.session = nil
            if let callbackURL = callbackURL {
                result(callbackURL.absoluteString)
            } else {
                result(FlutterError(code: "SESSION_ERROR",
                                    message: error?.localizedDescription ?? "Session cancelled",
                                    details: nil))
            }
        }
        newSession.presentationContextProvider = self
        newSession.prefersEphemeralWebBrowserSession = true
        newSession.start()
        session = newSession
    }

    func presentationAnchor(for session: ASWebAuthenticationSession) -> ASPresentationAnchor {
        guard let windowScene = UIApplication.shared.connectedScenes.first as? UIWindowScene,
              let window = windowScene.windows.first else {
            return ASPresentationAnchor()
        }
        return window
    }
}

AppDelegate.swift に登録します。

CapturePlugin.register(with: self.registrar(forPlugin: "CapturePlugin")!)

4. Android プラグインを実装する

android/app/build.gradle に依存関係を追加します。

implementation("androidx.browser:browser:1.5.0")

// android/app/src/main/kotlin/<your.package>/CapturePlugin.kt
package com.yourapp

import android.net.Uri
import androidx.browser.customtabs.CustomTabsIntent
import io.flutter.embedding.engine.plugins.FlutterPlugin
import io.flutter.embedding.engine.plugins.activity.ActivityAware
import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding
import io.flutter.plugin.common.MethodCall
import io.flutter.plugin.common.MethodChannel

class CapturePlugin : FlutterPlugin, MethodChannel.MethodCallHandler, ActivityAware {
    private var channel: MethodChannel? = null
    private var binding: ActivityPluginBinding? = null
    private var pendingResult: MethodChannel.Result? = null

    override fun onAttachedToEngine(flutterBinding: FlutterPlugin.FlutterPluginBinding) {
        channel = MethodChannel(flutterBinding.binaryMessenger, "capture_plugin")
        channel?.setMethodCallHandler(this)
    }

    override fun onMethodCall(call: MethodCall, result: MethodChannel.Result) {
        if (call.method == "openSession") {
            val url = call.argument<String>("url") ?: return result.error("MISSING_URL", "URL is required", null)
            pendingResult = result
            val activity = binding?.activity ?: return result.error("NO_ACTIVITY", "No activity", null)
            CustomTabsIntent.Builder().build().launchUrl(activity, Uri.parse(url))
        } else {
            result.notImplemented()
        }
    }

    fun handleRedirect(uri: Uri) {
        if (uri.scheme == "myapp") {
            pendingResult?.success(uri.toString())
            pendingResult = null
        }
    }

    override fun onAttachedToActivity(binding: ActivityPluginBinding) { this.binding = binding }
    override fun onDetachedFromActivity() { binding = null }
    override fun onReattachedToActivityForConfigChanges(binding: ActivityPluginBinding) { this.binding = binding }
    override fun onDetachedFromActivityForConfigChanges() { binding = null }
    override fun onDetachedFromEngine(binding: FlutterPlugin.FlutterPluginBinding) { channel = null }
}

MainActivity.kt でプラグインを登録し、戻りを処理します。

override fun configureFlutterEngine(flutterEngine: FlutterEngine) {
    super.configureFlutterEngine(flutterEngine)
    flutterEngine.plugins.add(CapturePlugin())
}

override fun onNewIntent(intent: Intent) {
    super.onNewIntent(intent)
    intent.data?.let { uri ->
        if (uri.scheme == "myapp") {
            val plugin = flutterEngine?.plugins?.get(CapturePlugin::class.java) as? CapturePlugin
            plugin?.handleRedirect(uri)
        }
    }
}

5. スキームを登録する

iOS
Android

Info.plist に追加します。

<key>CFBundleURLTypes</key>
<array>
    <dict>
        <key>CFBundleURLSchemes</key>
        <array>
            <string>myapp</string>
        </array>
    </dict>
</array>

AndroidManifest.xml の、メインの <activity> 内に追加します。

<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data android:scheme="myapp" android:host="callback" />
</intent-filter>

6. キャプチャを開始する

final ended = await CaptureService().open(link);

if (ended) {
  // キャプチャが終了しました。バックエンドに、Human Plugin の id を使った
  // GET /v1/processes/{id} で結果を読み取るよう依頼します。
} else {
  // 本人がセッションを閉じました。
}

まとめ

ファイル	用途
`lib/services/capture_service.dart`	Dart の `MethodChannel` サービス
`ios/Runner/CapturePlugin.swift`	iOS: `ASWebAuthenticationSession`
`ios/Runner/AppDelegate.swift`	プラグインの登録
`android/.../CapturePlugin.kt`	Android: Custom Tabs
`android/.../MainActivity.kt`	プラグインの登録と戻りの処理
`Info.plist`	iOS の URL スキーム
`AndroidManifest.xml`	Android の intent filter

前提条件​

1. スキームを指定してプロセスを作成する​

2. Dart サービスを作成する​

3. iOS プラグインを実装する​

4. Android プラグインを実装する​

5. スキームを登録する​

6. キャプチャを開始する​

まとめ​