com.slack.api.model.kotlin_extension.block.element.ButtonElementBuilder.kt Maven / Gradle / Ivy

Go to download
package com.slack.api.model.kotlin_extension.block.element

import com.slack.api.model.block.composition.ConfirmationDialogObject
import com.slack.api.model.block.composition.PlainTextObject
import com.slack.api.model.block.element.ButtonElement
import com.slack.api.model.kotlin_extension.block.BlockLayoutBuilder
import com.slack.api.model.kotlin_extension.block.Builder
import com.slack.api.model.kotlin_extension.block.composition.ConfirmationDialogObjectBuilder

// same name with the object + "Builder" suffix
@BlockLayoutBuilder
class ButtonElementBuilder : Builder {
    private var actionId: String? = null
    private var text: PlainTextObject? = null
    private var url: String? = null
    private var value: String? = null
    private var style: String? = null
    private var confirm: ConfirmationDialogObject? = null
    private var accessibilityLabel: String? = null

    /**
     * An identifier for this action. You can use this when you receive an interaction payload to identify the source
     * of the action. Should be unique among all other action_ids used elsewhere by your app. Maximum length for this
     * field is 255 characters.
     *
     * @see Button element documentation
     */
    fun actionId(id: String) {
        actionId = id
    }

    /**
     * Inserts a plain text object in the text field for this button.
     *
     * Defines the button's text. Maximum length for the text in this field is 75 characters.
     *
     * @see Button element documentation
     */
    fun text(text: String, emoji: Boolean? = null) {
        this.text = PlainTextObject(text, emoji)
    }

    /**
     * A URL to load in the user's browser when the button is clicked. Maximum length for this field is 3000
     * characters. If you're using url, you'll still receive an interaction payload and will need to send an
     * acknowledgement response.
     *
     * @see Button element documentation
     */
    fun url(text: String) {
        url = text
    }

    /**
     * The value to send along with the interaction payload. Maximum length for this field is 2000 characters.
     *
     * @see Button element documentation
     */
    fun value(text: String) {
        value = text
    }

    /**
     * Decorates buttons with alternative visual color schemes. Use this option with restraint.
     *
     * This implementation uses a type safe enum value for the button style.
     *
     * @see Button element documentation
     */
    fun style(style: ButtonStyle) {
        this.style = style.value
    }

    /**
     * Decorates buttons with alternative visual color schemes. Use this option with restraint.
     *
     * This implementation uses a string for the button style. This might be used if new button styles are introduced
     * and the enum is insufficient.
     *
     * @see Button element documentation
     */
    fun style(style: String) {
        this.style = style
    }

    /**
     * A confirm object that defines an optional confirmation dialog after the button is clicked.
     *
     * @see Button element documentation
     */
    fun confirm(builder: ConfirmationDialogObjectBuilder.() -> Unit) {
        confirm = ConfirmationDialogObjectBuilder().apply(builder).build()
    }

    /**
     * A label for longer descriptive text about a button element.
     * This label will be read out by screen readers instead of the button text object.
     * Maximum length for this field is 75 characters.
     *
     * @see Button element documentation
     */
    fun accessibilityLabel(accessibilityLabel: String) {
        this.accessibilityLabel = accessibilityLabel
    }

    override fun build(): ButtonElement {
        return ButtonElement.builder()
            .actionId(actionId)
            .url(url)
            .value(value)
            .text(text)
            .style(style)
            .confirm(confirm)
            .accessibilityLabel(accessibilityLabel)
            .build()
    }
}