divkit.dsl.ActionSetState.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-json-builder Show documentation
DivKit is an open source Server-Driven UI (SDUI) framework. SDUI is a an emerging technique that leverage the server to build the user interfaces of their mobile app.
There is a newer version: 30.32.0
Show newest version
@file:Suppress(
    "unused",
    "UNUSED_PARAMETER",
)

package divkit.dsl

import com.fasterxml.jackson.annotation.JsonAnyGetter
import com.fasterxml.jackson.annotation.JsonIgnore
import com.fasterxml.jackson.annotation.JsonValue
import divkit.dsl.annotation.*
import divkit.dsl.core.*
import divkit.dsl.scope.*
import kotlin.Any
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.collections.Map

/**
 * Switches the appearance of content in `div-state`.
 * 
 * Can be created using the method [actionSetState].
 * 
 * Required parameters: `type, state_id`.
 */
@Generated
class ActionSetState internal constructor(
    @JsonIgnore
    val properties: Properties,
) : ActionTyped {
    @JsonAnyGetter
    internal fun getJsonProperties(): Map = properties.mergeWith(
        mapOf("type" to "set_state")
    )

    operator fun plus(additive: Properties): ActionSetState = ActionSetState(
        Properties(
            stateId = additive.stateId ?: properties.stateId,
            temporary = additive.temporary ?: properties.temporary,
        )
    )

    class Properties internal constructor(
        /**
         * The path of the state inside `state` that needs to be activated. Set in `div_data_state_id/id/state_id` format. Can be hierarchical: `div_data_state_id/id_1/state_id_1/../id_n/state_id_n`. Consists of: `div_data_state_id` - `state_id` numeric value of the `state` object in data;
`id` - `id` value of the `state` object;
`state_id` - `state_id` value of the state object in `state`.
         */
        val stateId: Property?,
        /**
         * Indicates a state change:`true`: The change is temporary and when the element is re-created, the state will change back to the initial one (default value).
`false` - The state change is permanent.
         * Default value: `true`.
         */
        val temporary: Property?,
    ) {
        internal fun mergeWith(properties: Map): Map {
            val result = mutableMapOf()
            result.putAll(properties)
            result.tryPutProperty("state_id", stateId)
            result.tryPutProperty("temporary", temporary)
            return result
        }
    }
}

/**
 * @param stateId The path of the state inside `state` that needs to be activated. Set in `div_data_state_id/id/state_id` format. Can be hierarchical: `div_data_state_id/id_1/state_id_1/../id_n/state_id_n`. Consists of: `div_data_state_id` - `state_id` numeric value of the `state` object in data;
`id` - `id` value of the `state` object;
`state_id` - `state_id` value of the state object in `state`.
 * @param temporary Indicates a state change:`true`: The change is temporary and when the element is re-created, the state will change back to the initial one (default value).
`false` - The state change is permanent.
 */
@Generated
fun DivScope.actionSetState(
    `use named arguments`: Guard = Guard.instance,
    stateId: String? = null,
    temporary: Boolean? = null,
): ActionSetState = ActionSetState(
    ActionSetState.Properties(
        stateId = valueOrNull(stateId),
        temporary = valueOrNull(temporary),
    )
)

/**
 * @param stateId The path of the state inside `state` that needs to be activated. Set in `div_data_state_id/id/state_id` format. Can be hierarchical: `div_data_state_id/id_1/state_id_1/../id_n/state_id_n`. Consists of: `div_data_state_id` - `state_id` numeric value of the `state` object in data;
`id` - `id` value of the `state` object;
`state_id` - `state_id` value of the state object in `state`.
 * @param temporary Indicates a state change:`true`: The change is temporary and when the element is re-created, the state will change back to the initial one (default value).
`false` - The state change is permanent.
 */
@Generated
fun DivScope.actionSetStateProps(
    `use named arguments`: Guard = Guard.instance,
    stateId: String? = null,
    temporary: Boolean? = null,
) = ActionSetState.Properties(
    stateId = valueOrNull(stateId),
    temporary = valueOrNull(temporary),
)

/**
 * @param stateId The path of the state inside `state` that needs to be activated. Set in `div_data_state_id/id/state_id` format. Can be hierarchical: `div_data_state_id/id_1/state_id_1/../id_n/state_id_n`. Consists of: `div_data_state_id` - `state_id` numeric value of the `state` object in data;
`id` - `id` value of the `state` object;
`state_id` - `state_id` value of the state object in `state`.
 * @param temporary Indicates a state change:`true`: The change is temporary and when the element is re-created, the state will change back to the initial one (default value).
`false` - The state change is permanent.
 */
@Generated
fun TemplateScope.actionSetStateRefs(
    `use named arguments`: Guard = Guard.instance,
    stateId: ReferenceProperty? = null,
    temporary: ReferenceProperty? = null,
) = ActionSetState.Properties(
    stateId = stateId,
    temporary = temporary,
)

/**
 * @param stateId The path of the state inside `state` that needs to be activated. Set in `div_data_state_id/id/state_id` format. Can be hierarchical: `div_data_state_id/id_1/state_id_1/../id_n/state_id_n`. Consists of: `div_data_state_id` - `state_id` numeric value of the `state` object in data;
`id` - `id` value of the `state` object;
`state_id` - `state_id` value of the state object in `state`.
 * @param temporary Indicates a state change:`true`: The change is temporary and when the element is re-created, the state will change back to the initial one (default value).
`false` - The state change is permanent.
 */
@Generated
fun ActionSetState.override(
    `use named arguments`: Guard = Guard.instance,
    stateId: String? = null,
    temporary: Boolean? = null,
): ActionSetState = ActionSetState(
    ActionSetState.Properties(
        stateId = valueOrNull(stateId) ?: properties.stateId,
        temporary = valueOrNull(temporary) ?: properties.temporary,
    )
)

/**
 * @param stateId The path of the state inside `state` that needs to be activated. Set in `div_data_state_id/id/state_id` format. Can be hierarchical: `div_data_state_id/id_1/state_id_1/../id_n/state_id_n`. Consists of: `div_data_state_id` - `state_id` numeric value of the `state` object in data;
`id` - `id` value of the `state` object;
`state_id` - `state_id` value of the state object in `state`.
 * @param temporary Indicates a state change:`true`: The change is temporary and when the element is re-created, the state will change back to the initial one (default value).
`false` - The state change is permanent.
 */
@Generated
fun ActionSetState.defer(
    `use named arguments`: Guard = Guard.instance,
    stateId: ReferenceProperty? = null,
    temporary: ReferenceProperty? = null,
): ActionSetState = ActionSetState(
    ActionSetState.Properties(
        stateId = stateId ?: properties.stateId,
        temporary = temporary ?: properties.temporary,
    )
)

/**
 * @param stateId The path of the state inside `state` that needs to be activated. Set in `div_data_state_id/id/state_id` format. Can be hierarchical: `div_data_state_id/id_1/state_id_1/../id_n/state_id_n`. Consists of: `div_data_state_id` - `state_id` numeric value of the `state` object in data;
`id` - `id` value of the `state` object;
`state_id` - `state_id` value of the state object in `state`.
 * @param temporary Indicates a state change:`true`: The change is temporary and when the element is re-created, the state will change back to the initial one (default value).
`false` - The state change is permanent.
 */
@Generated
fun ActionSetState.evaluate(
    `use named arguments`: Guard = Guard.instance,
    stateId: ExpressionProperty? = null,
    temporary: ExpressionProperty? = null,
): ActionSetState = ActionSetState(
    ActionSetState.Properties(
        stateId = stateId ?: properties.stateId,
        temporary = temporary ?: properties.temporary,
    )
)

@Generated
fun ActionSetState.asList() = listOf(this)