com.slack.api.model.kotlin_extension.block.composition.ConfirmationDialogObjectBuilder.kt Maven / Gradle / Ivy

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

import com.slack.api.model.block.composition.ConfirmationDialogObject
import com.slack.api.model.block.composition.PlainTextObject
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.container.SingleTextObjectContainer
import com.slack.api.model.kotlin_extension.block.composition.dsl.TextObjectDsl
import com.slack.api.model.kotlin_extension.block.element.ButtonStyle

// same name with the object + "Builder" suffix
@BlockLayoutBuilder
class ConfirmationDialogObjectBuilder private constructor(
    private val textContainer: SingleTextObjectContainer
) : Builder, TextObjectDsl by textContainer {

    constructor() : this(SingleTextObjectContainer())

    private var title: PlainTextObject? = null
    private var confirm: PlainTextObject? = null
    private var deny: PlainTextObject? = null
    private var style: String? = null

    /**
     * Fills the title field with a plain text object.
     *
     * Defines the dialog's title. Maximum length for this field is 100 characters.
     *
     * @see Confirmation dialog object documentation
     */
    fun title(text: String, emoji: Boolean? = null) {
        title = PlainTextObject(text, emoji)
    }

    /**
     * Fills the confirm field with a plain text object.
     *
     * The text of the button that confirms the action. Maximum length for the text in this field is 30 characters.
     *
     * @see Confirmation dialog object documentation
     */
    fun confirm(text: String, emoji: Boolean? = null) {
        confirm = PlainTextObject(text, emoji)
    }

    /**
     * Fills the deny field with a plain text object.
     *
     * The text of the button that cancels the action. Maximum length for the text in this field is 30 characters.
     *
     * @see Confirmation dialog object documentation
     */
    fun deny(text: String, emoji: Boolean? = null) {
        deny = PlainTextObject(text, emoji)
    }

    /**
     * Defines the color scheme applied to the confirm button.
     * A value of danger will display the button with a red background on desktop, or red text on mobile.
     * A value of primary will display the button with a green background on desktop, or blue text on mobile.
     * If this field is not provided, the default value will be primary.
     *
     * This implementation uses a typed enum to fill the style field.
     *
     * @see Confirmation dialog object documentation
     */
    fun style(style: ButtonStyle) {
        this.style = style.value
    }

    /**
     * Defines the color scheme applied to the confirm button.
     * A value of danger will display the button with a red background on desktop, or red text on mobile.
     * A value of primary will display the button with a green background on desktop, or blue text on mobile.
     * If this field is not provided, the default value will be primary.
     *
     * This implementation uses a string to fill the style field. This may be preferable if a new button style is
     * introduced and the [ButtonStyle] enum is insufficient.
     *
     * @see Confirmation dialog object documentation
     */
    fun style(style: String) {
        this.style = style
    }

    override fun build(): ConfirmationDialogObject {
        return ConfirmationDialogObject.builder()
            .title(title)
            .text(textContainer.underlying)
            .confirm(confirm)
            .deny(deny)
            .style(style)
            .build()
    }
}