BotCommands/io.github.freya022.botcommands.api.components.data/InteractionConstraints

InteractionConstraints

class InteractionConstraints(source)

Controls who can use components (buttons, selection menus).

A user can use a component if they fit at least one of the allowed elements.

You can filter by:

User ID
Role ID
Permissions

You can create interaction constraints from the static methods, or by using the existing instance in the component builders.

Types

object Companion

Properties

val allowedRoles: TLongArrayList

val allowedUsers: TLongArrayList

allowingPermissions

val allowingPermissions: EnumSet<Permission>

val isEmpty: Boolean

Functions

fun addPermissions(vararg permissions: Permission): InteractionConstraints

fun addPermissions(permissions: Collection<Permission>): InteractionConstraints

fun addRoleIds(vararg roleIds: Long): InteractionConstraints

fun addRoleIds(roleIds: Collection<Long>): InteractionConstraints

fun addRoles(vararg roles: Role): InteractionConstraints

fun addRoles(roles: Collection<Role>): InteractionConstraints

fun addUserIds(vararg userIds: Long): InteractionConstraints

fun addUserIds(userIds: Collection<Long>): InteractionConstraints

fun addUsers(vararg userIds: UserSnowflake): InteractionConstraints

fun addUsers(users: Collection<UserSnowflake>): InteractionConstraints

@JvmName(name = "plusAssignPermission")

operator fun plusAssign(permissions: Collection<Permission>)

@JvmName(name = "plusAssignRoles")

operator fun plusAssign(roles: Collection<Role>)

@JvmName(name = "plusAssignUsers")

operator fun plusAssign(users: Collection<UserSnowflake>)

operator fun plusAssign(permission: Permission)

operator fun plusAssign(role: Role)

operator fun plusAssign(user: UserSnowflake)

fun setConstraints(otherConstraints: InteractionConstraints): InteractionConstraints