Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

ユーザー操作を処理する

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

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

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

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

ユーザー操作で Activity を起動するには、GlanceModifier.clickable 修飾子を使用して、actionStartActivity 関数を Button などのコンポーズ可能に渡します。

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

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

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

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

サービスを起動する

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

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

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

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

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

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

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

文字列アクション
ComponentName
インテント
BroadcastReceiver クラス

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

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

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

Lambda アクションを実行する

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

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

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

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

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

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
    }
}GlanceSnippets.kt

ユーザーがクリックすると、指定された 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)
    }
}
GlanceSnippets.kt

アクションにパラメータを提供する

アクションに追加情報を提供するには、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() }
    }
}GlanceSnippets.kt

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

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

パラメータは 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
        // ...
    }
}GlanceSnippets.kt

Glance を使用した単体テスト

ウィジェットの指標を追跡する