사용자 상호작용 처리

Glance는 Action 클래스를 사용하여 사용자 상호작용 처리를 간소화합니다. Glance의 Action 클래스는 사용자가 취할 수 있는 작업을 정의하며 작업에 대한 응답으로 실행되는 작업을 지정할 수 있습니다. GlanceModifier.clickable 메서드를 사용하여 모든 구성요소에 Action을 적용할 수 있습니다.

앱 위젯은 원격 프로세스에 있으므로 작업은 생성 시에 정의되고 실행은 원격 프로세스에서 이루어집니다. 네이티브 RemoteViews에서는 PendingIntents를 사용하여 이 작업을 실행합니다.

이 페이지에서는 다음 작업을 설명합니다.

활동 시작

사용자 상호작용 시 활동을 시작하려면 actionStartActivity 함수를 Button 또는 기타 컴포저블에 GlanceModifier.clickable 수정자를 사용하여 제공합니다.

actionStartActivity에서 다음 중 하나를 제공합니다.

Glance는 제공된 대상 및 매개변수를 사용하여 작업을 PendingIntent로 변환합니다. 다음 예에서는 사용자가 버튼을 클릭하면 NavigationActivity가 시작됩니다.

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

서비스 시작

활동 시작과 마찬가지로 actionStartService 메서드 중 하나를 사용하여 사용자 상호작용 시 서비스를 시작합니다.

actionStartService에서 다음 중 하나를 제공합니다.

@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 또는 상태 업데이트와 같은 작업을 실행할 수 있습니다.

람다 작업 실행

람다 함수를 UI 상호작용의 콜백으로 사용할 수 있습니다.

예를 들어 람다 함수를 GlanceModifier.clickable 수정자에 전달합니다.

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

또는 이를 지원하는 컴포저블의 onClick 매개변수에 전달합니다.

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

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를 사용하여 유형화된 키-값 쌍을 만듭니다. 예를 들어 클릭된 대상을 정의합니다.

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를 사용한 단위 테스트
다음
위젯의 측정항목 추적