ActionRow
extends Component
in package
An Action Row is a non-interactive container component for other types of components.
It has a type: 1 and a sub-array of components of other types.
Tags
Table of Contents
- TYPE_ACTION_ROW = 1
- TYPE_BUTTON = 2
- TYPE_CHANNEL_SELECT = 8
- TYPE_MENTIONABLE_SELECT = 7
- TYPE_ROLE_SELECT = 6
- TYPE_SELECT_MENU = 3
- TYPE_STRING_SELECT = 3
- TYPE_TEXT_INPUT = 4
- TYPE_USER_SELECT = 5
- $components : array<string|int, Component>
- Components contained by the action row.
- addComponent() : $this
- Adds a component to the action row.
- clearComponents() : $this
- Removes all components from the action row.
- getComponents() : array<string|int, Component>
- Returns all the components in the action row.
- jsonSerialize() : array<string|int, mixed>
- {@inheritDoc}
- new() : self
- Creates a new action row.
- removeComponent() : $this
- Removes a component from the action row.
- generateUuid() : string
- Generates a UUID which can be used for component custom IDs.
Constants
TYPE_ACTION_ROW
public
mixed
TYPE_ACTION_ROW
= 1
TYPE_BUTTON
public
mixed
TYPE_BUTTON
= 2
TYPE_CHANNEL_SELECT
public
mixed
TYPE_CHANNEL_SELECT
= 8
TYPE_MENTIONABLE_SELECT
public
mixed
TYPE_MENTIONABLE_SELECT
= 7
TYPE_ROLE_SELECT
public
mixed
TYPE_ROLE_SELECT
= 6
TYPE_SELECT_MENU
public
mixed
TYPE_SELECT_MENU
= 3
Tags
TYPE_STRING_SELECT
public
mixed
TYPE_STRING_SELECT
= 3
TYPE_TEXT_INPUT
public
mixed
TYPE_TEXT_INPUT
= 4
TYPE_USER_SELECT
public
mixed
TYPE_USER_SELECT
= 5
Properties
$components
Components contained by the action row.
private
array<string|int, Component>
$components
= []
Methods
addComponent()
Adds a component to the action row.
public
addComponent(Component $component) : $this
Parameters
- $component : Component
-
Component to add.
Tags
Return values
$this —clearComponents()
Removes all components from the action row.
public
clearComponents() : $this
Return values
$this —getComponents()
Returns all the components in the action row.
public
getComponents() : array<string|int, Component>
Return values
array<string|int, Component> —jsonSerialize()
{@inheritDoc}
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —new()
Creates a new action row.
public
static new() : self
Return values
self —removeComponent()
Removes a component from the action row.
public
removeComponent(Component $component) : $this
Parameters
- $component : Component
-
Component to remove.
Return values
$this —generateUuid()
Generates a UUID which can be used for component custom IDs.
protected
static generateUuid() : string