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

Container to display a row of interactive components.

TYPE_BUTTON  = 2

Button object.

TYPE_CHANNEL_SELECT  = 8

Select menu for channels.

TYPE_CHECKPOINT_CARD  = 20

Undocumented.

TYPE_CONTAINER  = 17

Container that visually groups a set of components.

TYPE_CONTENT_INVENTORY_ENTRY  = 16

Undocumented.

TYPE_FILE  = 13

Displays an attached file.

TYPE_FILE_UPLOAD  = 19

Component for uploading files.

TYPE_LABEL  = 18

Container associating a label and description with a component.

TYPE_MEDIA_GALLERY  = 12

Display images and other media.

TYPE_MENTIONABLE_SELECT  = 7

Select menu for mentionables (users and roles).

TYPE_ROLE_SELECT  = 6

Select menu for roles.

TYPE_SECTION  = 9

Container to display text alongside an accessory component.

TYPE_SELECT_MENU  = 3

TYPE_SEPARATOR  = 14

Component to add vertical padding between other components.

TYPE_STRING_SELECT  = 3

Select menu for picking from defined text options.

TYPE_TEXT_DISPLAY  = 10

Markdown text.

TYPE_TEXT_INPUT  = 4

Text input object.

TYPE_THUMBNAIL  = 11

Small image that can be used as an accessory.

TYPE_USER_SELECT  = 5

Select menu for users.

USAGE  = ['Message', 'Modal']

Usage of ActionRow in Modal is deprecated. Use `Component::Label` as the top-level container.

Properties

$components  : array<string|int, ComponentObject>

Components contained by the action row.

$id  : int|null

32 bit integer used as an optional identifier for component.

$type  : int

Component type.

Methods

__get()  : mixed

Handles dynamic get calls onto the part.

__set()  : void

Handles dynamic set calls onto the part.

addComponent()  : $this

Adds a component to the action row.

addComponents()  : $this

Add a group of components to the action row.

clearComponents()  : $this

Removes all components from the action row.

fromPart()  : self

Creates a new instance of the builder from a given Part.

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>

new()  : self

Creates a new action row.

removeComponent()  : $this

Removes a component from the action row.

checkForGetMutator()  : string|false

Checks if there is a get mutator present.

checkForSetMutator()  : string|false

Checks if there is a set mutator present.

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.

getProperty()  : mixed

Gets a property on the parent part.

setId()  : self

The id field is optional and is used to identify components in the response from an interaction. The id must be unique within the message and is generated sequentially if left empty. Generation of ids won't use another id that exists in the message if you have one defined for another component. Sending components with an id of 0 is allowed but will be treated as empty and replaced by the API. 32 bit integer used as an optional identifier for component.

setProperty()  : void

Sets an property on the parent part.

studly()  : string

Converts a string to studlyCase.