com.slack.api.model.kotlin_extension.block.element.MultiUsersSelectElementBuilder.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.MultiUsersSelectElement
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

@BlockLayoutBuilder
class MultiUsersSelectElementBuilder : Builder {
    private var placeholder: PlainTextObject? = null
    private var actionId: String? = null
    private var initialUsers: List? = null
    private var confirm: ConfirmationDialogObject? = null
    private var maxSelectedItems: Int? = null
    private var _focusOnLoad: Boolean? = null

    /**
     * Adds a plain text element to the placeholder field.
     *
     * The placeholder text shown on the menu. Maximum length for the text in this field is 150 characters.
     *
     * @see Multi users select element documentation
     */
    fun placeholder(text: String, emoji: Boolean? = null) {
        placeholder = PlainTextObject(text, emoji)
    }

    /**
     * An identifier for the action triggered when a menu option is selected. 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 Multi users select element documentation
     */
    fun actionId(id: String) {
        actionId = id
    }

    /**
     * An array of user IDs of any valid users to be pre-selected when the menu loads.
     *
     * @see Multi users select element documentation
     */
    fun initialUsers(vararg users: String) {
        initialUsers = users.toList()
    }

    /**
     * A confirm object that defines an optional confirmation dialog that appears before the multi-select choices are submitted.
     *
     * @see Multi users select element documentation
     */
    fun confirm(builder: ConfirmationDialogObjectBuilder.() -> Unit) {
        confirm = ConfirmationDialogObjectBuilder().apply(builder).build()
    }

    /**
     * Specifies the maximum number of items that can be selected in the menu. Minimum number is 1.
     *
     * @see Multi users select element documentation
     */
    fun maxSelectedItems(max: Int) {
        maxSelectedItems = max
    }

    /**
     * Indicates whether the element will be set to autofocus within the view object.
     * Only one element can be set to true. Defaults to false.
     *
     * @see Multi users select element documentation
     */
    fun focusOnLoad(focusOnLoad: Boolean) {
        _focusOnLoad = focusOnLoad
    }

    override fun build(): MultiUsersSelectElement {
        return MultiUsersSelectElement.builder()
            .placeholder(placeholder)
            .actionId(actionId)
            .initialUsers(initialUsers)
            .confirm(confirm)
            .maxSelectedItems(maxSelectedItems)
            .focusOnLoad(_focusOnLoad)
            .build()
    }
}