DiscordPHP Documentation

ActionRow extends Layout

in package

• Application

An Action Row is a non-interactive container component for other types of components.

Tags

link

https://discord.com/developers/docs/interactions/message-components#action-rows

since

7.0.0

Table of Contents

Constants

TYPE_ACTION_ROW  = 1

TYPE_BUTTON  = 2

TYPE_CHANNEL_SELECT  = 8

TYPE_CONTAINER  = 17

TYPE_CONTENT_INVENTORY_ENTRY  = 16

TYPE_FILE  = 13

TYPE_MEDIA_GALLERY  = 12

TYPE_MENTIONABLE_SELECT  = 7

TYPE_ROLE_SELECT  = 6

TYPE_SECTION  = 9

TYPE_SELECT_MENU  = 3

TYPE_SEPARATOR  = 14

TYPE_STRING_SELECT  = 3

TYPE_TEXT_DISPLAY  = 10

TYPE_TEXT_INPUT  = 4

TYPE_THUMBNAIL  = 11

TYPE_USER_SELECT  = 5

USAGE  = ['Message', 'Modal']

Properties

$id  : int|null

32 bit integer used as an optional identifier for component.

$type  : int

Component type.

$components  : array<string|int, ComponentObject>

Components contained by the action row.

Methods

addComponent()  : $this

Adds a component to the action row.

clearComponents()  : $this

Removes all components from the action row.

getComponents()  : array<string|int, ComponentObject>

Returns all the components in the action row.

getCustomId()  : string|null

Returns the custom ID of the button.

getType()  : int

Retrieves the type of the component.

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.

getId()  : int|null

The id field is optional and is used to identify components in the response from an interaction that aren't interactive components.