Processar interação do usuário

O Glance simplifica o processamento da interação do usuário usando as classes Action. As classes Action do Glance definem as ações que um usuário pode realizar, e você pode especificar a operação realizada em resposta à ação. É possível aplicar um Action a qualquer componente com o GlanceModifier.clickable método.

Os widgets de app ficam em um processo remoto. Portanto, as ações são definidas no momento da criação, e a execução acontece no processo remoto. Em RemoteViews nativas, isso é feito usando PendingIntents.

As ações a seguir são descritas nesta página:

Iniciar uma atividade

Para iniciar uma atividade na interação do usuário, forneça a actionStartActivity função a um Button ou outro elemento combinável usando o GlanceModifier.clickable modificador.

Forneça um dos seguintes em actionStartActivity:

O Glance traduz a ação em uma PendingIntent com o destino e os parâmetros fornecidos. No exemplo a seguir, a NavigationActivity é iniciada quando um usuário clica no botão:

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

Iniciar um serviço

Semelhante ao lançamento de uma atividade, inicie um serviço na interação do usuário usando um dos métodos actionStartService.

Forneça um dos seguintes em actionStartService:

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

Enviar um evento de transmissão

Envie um evento de transmissão na interação do usuário usando um dos actionSendBroadcast métodos:

Forneça um dos seguintes em actionSendBroadcast:

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

Realizar ações personalizadas

Em vez de iniciar um destino específico, o Glance pode usar uma ação lambda ou um actionRunCallback para realizar uma ação, como atualizar a interface ou o estado na interação do usuário.

Executar ações lambda

É possível usar funções lambda como callbacks para as interações da interface.

Por exemplo, transmita a função lambda para o modificador GlanceModifier.clickable:

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

Ou transmita-o para o parâmetro onClick em elementos combináveis que o oferecem suporte:

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

Executar ActionCallback

Como alternativa, use os actionRunCallback métodos para realizar uma ação na interação do usuário. Para fazer isso, forneça uma implementação personalizada do 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
    }
}

No clique do usuário, o método suspend onAction do ActionCallback fornecido é chamado, executando a lógica definida (ou seja, solicitando dados de atualização).

Para atualizar o widget após a ação ser realizada, crie uma nova instância e chame update(..). Para mais detalhes, consulte a seção Gerenciar o estado do 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)
    }
}

Fornecer parâmetros para ações

Para fornecer mais informações a uma ação, use a ActionParameters API para criar um par de chave-valor digitado. Por exemplo, para definir o destino clicado:

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() }
    }
}

Abaixo, os parâmetros são incluídos na intent usada para iniciar a atividade, permitindo que a atividade de destino a recupere.

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

Os parâmetros também são fornecidos ao ActionCallback. Use o Parameters.Key definido para recuperar o valor:

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
        // ...
    }
}

Anterior
Testes de unidade com o Glance
Avançar
Acompanhar métricas do widget