androidx.privacysandbox.ui.client.compose

This package lets an application host Compose UI which renders content from SdkRuntime-aware SDK.

Top-level functions summary

Unit
@Composable
@ExperimentalFeatures.ChangingContentUiZOrderApi
SandboxedSdkUi(
    sandboxedUiAdapter: SandboxedUiAdapter,
    modifier: Modifier,
    providerUiOnTop: Boolean,
    sandboxedSdkViewEventListener: SandboxedSdkViewEventListener?
)

Composable that can be used to remotely render UI from a SandboxedSdk to host app window.

Unit
@Composable
SandboxedSdkUiBelowHostWindow(
    sandboxedUiAdapter: SandboxedUiAdapter,
    modifier: Modifier,
    sandboxedSdkViewEventListener: SandboxedSdkViewEventListener?
)

This function is deprecated. This library is no longer supported.

Top-level functions

@Composable
@ExperimentalFeatures.ChangingContentUiZOrderApi
fun SandboxedSdkUi(
    sandboxedUiAdapter: SandboxedUiAdapter,
    modifier: Modifier = Modifier,
    providerUiOnTop: Boolean = false,
    sandboxedSdkViewEventListener: SandboxedSdkViewEventListener? = null
): Unit

Composable that can be used to remotely render UI from a SandboxedSdk to host app window.

Parameters
sandboxedUiAdapter: SandboxedUiAdapter

an adapter that provides content from a SandboxedSdk to be displayed as part of a host app's window.

modifier: Modifier = Modifier

the Modifier to be applied to this SandboxedSdkUi.

providerUiOnTop: Boolean = false

sets the Z-order of the SandboxedSdkUi surface, relative to its host window. True means on top, while false means below (it is false if it is not specified).

sandboxedSdkViewEventListener: SandboxedSdkViewEventListener? = null

an event listener to the UI presentation.

SandboxedSdkUiBelowHostWindow

@Composable
fun SandboxedSdkUiBelowHostWindow(
    sandboxedUiAdapter: SandboxedUiAdapter,
    modifier: Modifier = Modifier,
    sandboxedSdkViewEventListener: SandboxedSdkViewEventListener? = null
): Unit

Composable that can be used to remotely render UI from a SandboxedSdk to host app window.

It always sets the Z-order of the remote content surface below its host window.

This library is no longer supported.

Parameters
sandboxedUiAdapter: SandboxedUiAdapter

an adapter that provides content from a SandboxedSdk to be displayed as part of a host app's window.

modifier: Modifier = Modifier

the Modifier to be applied to this SandboxedSdkUiBelowHostWindow.

sandboxedSdkViewEventListener: SandboxedSdkViewEventListener? = null

an event listener to the UI presentation.