StartActivityIntentAction.kt
/*
* Copyright 2021 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.glance.appwidget.action
import android.app.Activity
import android.content.Intent
import androidx.glance.action.Action
import androidx.glance.action.ActionParameters
import androidx.glance.action.StartActivityAction
import androidx.glance.action.actionParametersOf
internal class StartActivityIntentAction(
val intent: Intent,
override val parameters: ActionParameters = actionParametersOf()
) : StartActivityAction
/**
* Creates an [Action] that launches an [Activity] from the given [Intent] when triggered. The
* intent should specify a component with [Intent.setClass] or [Intent.setComponent].
*
* This action is supported by app widgets only.
*
* The given intent will be wrapped in a [PendingIntent]. This means that if you create multiple
* actions with this function, they will be conflated unless the underlying intents are
* distinct from one another, as defined by [Intent.filterEquals]. For example, if you create two
* [Intent]s that target the same Activity but only differ by parameters, they will get conflated
* (the PendingIntent created by the first call to actionStartActivity will be overwritten by the
* second). A simple way to avoid this is to set a unique data URI on these intents, so that they
* are distinct as defined by [Intent.filterEquals]. There is more information in the class
* documentation for [PendingIntent]. This is taken care of by the library for the
* [androidx.glance.action.actionStartActivity] overloads defined in the androidx.glance.action
* package.
*
* @param intent the intent used to launch the activity
* @param parameters the parameters associated with the action. Parameter values will be added to
* the activity intent, keyed by the parameter key name string.
*/
fun actionStartActivity(
intent: Intent,
parameters: ActionParameters = actionParametersOf()
): Action = StartActivityIntentAction(intent, parameters)