composeextensions/sco.carlukesoftware.composeextensions.utils/GetString

GetString

sealed interface GetString

A sealed interface for representing a string that can be retrieved in different ways. This is useful for decoupling UI components from how strings are sourced, whether they come from a remote API (ApiString) or from local Android string resources (StringResource).

It provides methods to resolve the string value both within a Composable context and outside of it (using an Android Context).

Example Usage:

// In a ViewModel
val title: GetString = GetString.StringResource(R.string.my_title)
val subtitle: GetString = GetString.ApiString("Live Data from API")

// In a Composable
@Composable
fun MyScreen(title: GetString, subtitle: GetString) {
    Column {
        Text(text = title.asString())       // Uses stringResource()
        Text(text = subtitle.asString())    // Uses the raw string
    }
}

// Outside of Compose (e.g., in a Service or BroadcastReceiver)
fun showNotification(context: Context, title: GetString) {
    val notificationText = title.asString(context) // Uses context.getString()
    // ... build and show notification
}

Inheritors

ApiString

StringResource

Types

ApiString

data class ApiString(val value: String) : GetString

Represents a string that is obtained from an external source, like a network API. This class wraps a raw String value, distinguishing it from a local Android string resource.

StringResource

class StringResource(@StringRes val resourceId: Int, val args: Any) : GetString

Represents a string that can be retrieved from Android string resources. This is useful for providing localized strings within the application.

Functions

asString

@Composable

open fun asString(): String

open fun asString(context: Context): String