ユーザー操作を処理する

Glance では、Action クラスを使用してユーザー インタラクションの処理を簡素化します。Glance の Action クラスは、ユーザーが実行できるアクションを定義します。アクションに応じて実行されるオペレーションを指定できます。GlanceModifier.clickable メソッドを使用して、任意のコンポーネントに Action を適用できます。

アプリ ウィジェットはリモート プロセスで動作するため、アクションは作成時に定義され、リモート プロセスで実行されます。ネイティブの RemoteViews では、PendingIntents を使用してこれを行います。

このページでは、次の操作について説明します。

アクティビティを起動する

ユーザー インタラクションでアクティビティを起動するには、GlanceModifier.clickable 修飾子を使用して、Button または他のコンポーザブルに actionStartActivity 関数を指定します。

actionStartActivity に次のいずれかを指定します。

  • ターゲット アクティビティ クラス
  • ComponentName
  • インテント

Glance は、指定されたターゲットとパラメータを使用して、アクションを PendingIntent に変換します。次の例では、ユーザーがボタンをクリックすると NavigationActivity が起動します。

@Composable
fun MyContent() {
    // ..
    Button(
        text = "Go Home",
        onClick = actionStartActivity<MyActivity>()
    )
}

サービスをリリースする

アクティビティの起動と同様に、actionStartService メソッドのいずれかを使用して、ユーザー操作でサービスを起動します。

actionStartService に次のいずれかを指定します。

  • ターゲット アクティビティ クラス
  • ComponentName
  • インテント

@Composable
fun MyButton() {
    // ..
    Button(
        text = "Sync",
        onClick = actionStartService<SyncService>(
            isForegroundService = true // define how the service is launched
        )
    )
}

ブロードキャスト イベントを送信する

actionSendBroadcast メソッドのいずれかを使用して、ユーザー インタラクションに関するブロードキャスト イベントを送信します。

actionSendBroadcast に次のいずれかを指定します。

@Composable
fun MyButton() {
    // ..
    Button(
        text = "Send",
        onClick = actionSendBroadcast<MyReceiver>()
    )
}

カスタム アクションを実行する

特定のターゲットを起動する代わりに、Glance はラムダ アクションまたは actionRunCallback を使用して、ユーザー インタラクション時の UI や状態の更新などのアクションを実行できます。

Lambda アクションを実行する

ラムダ関数は、UI 操作のコールバックとして使用できます。

たとえば、ラムダ関数を GlanceModifier.clickable 修飾子に渡します。

Text(
    text = "Submit",
    modifier = GlanceModifier.clickable {
        submitData()
    }
)

または、それをサポートするコンポーザブルの onClick パラメータに渡します。

Button(
    text = "Submit",
    onClick = {
        submitData()
    }
)

Run ActionCallback

または、actionRunCallback メソッドを使用して、ユーザー インタラクションに対するアクションを実行します。これを行うには、ActionCallback のカスタム実装を指定します。

@Composable
private fun MyContent() {
    // ..
    Image(
        provider = ImageProvider(R.drawable.ic_hourglass_animated),
        modifier = GlanceModifier.clickable(
            onClick = actionRunCallback<RefreshAction>()
        ),
        contentDescription = "Refresh"
    )
}

class RefreshAction : ActionCallback {
    override suspend fun onAction(
        context: Context,
        glanceId: GlanceId,
        parameters: ActionParameters
    ) {
        // TODO implement
    }
}

ユーザーがクリックすると、指定された ActionCallback の suspend onAction メソッドが呼び出され、定義されたロジック（更新データのリクエストなど）が実行されます。

アクションの実行後にウィジェットを更新するには、新しいインスタンスを作成して update(..) を呼び出します。詳しくは、GlanceAppWidget の状態を管理するセクションをご覧ください。

class RefreshAction : ActionCallback {
    override suspend fun onAction(
        context: Context,
        glanceId: GlanceId,
        parameters: ActionParameters
    ) {
        // do some work but offset long-term tasks (e.g a Worker)
        MyAppWidget().update(context, glanceId)
    }
}

アクションにパラメータを指定する

アクションに追加情報を提供するには、ActionParameters API を使用して型付きの Key-Value ペアを作成します。たとえば、クリックされた宛先を定義するには:

private val destinationKey = ActionParameters.Key<String>(
    NavigationActivity.KEY_DESTINATION
)

class MyAppWidget : GlanceAppWidget() {

    // ..

    @Composable
    private fun MyContent() {
        // ..
        Button(
            text = "Home",
            onClick = actionStartActivity<NavigationActivity>(
                actionParametersOf(destinationKey to "home")
            )
        )
        Button(
            text = "Work",
            onClick = actionStartActivity<NavigationActivity>(
                actionParametersOf(destinationKey to "work")
            )
        )
    }

    override suspend fun provideGlance(context: Context, id: GlanceId) {
        provideContent { MyContent() }
    }
}

内部的には、パラメータはアクティビティの起動に使用されるインテントに含まれており、ターゲット アクティビティが取得できるようになっています。

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        val destination = intent.extras?.getString(KEY_DESTINATION) ?: return
        // ...
    }
}

パラメータは ActionCallback にも渡されます。定義された Parameters.Key を使用して値を取得します。

class RefreshAction : ActionCallback {

    private val destinationKey = ActionParameters.Key<String>(
        NavigationActivity.KEY_DESTINATION
    )

    override suspend fun onAction(
        context: Context,
        glanceId: GlanceId,
        parameters: ActionParameters
    ) {
        val destination: String = parameters[destinationKey] ?: return
        // ...
    }
}

前へ
Glance を使用した単体テスト
次へ
ウィジェットの指標を追跡する