DiscordPHP Documentation

Separator extends Layout
in package
implements ComponentV2

Separator components allow you to divide components with a divider.

You can make the divider big or small, and make it invisible if needed.

Tags
link
https://discord.com/developers/docs/interactions/message-components#separator
since
10.5.0

Table of Contents

Interfaces

ComponentV2
This interface is a contract for V2 components.

Constants

SPACING_LARGE  = 2
SPACING_SMALL  = 1
Spacing size 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']

Properties

$id  : int|null
32 bit integer used as an optional identifier for component.
$type  : int
Component type.
$divider  : bool
Whether the separator is a divider.
$spacing  : int
Spacing size for the separator.

Methods

getCustomId()  : string|null
Returns the custom ID of the button.
getSpacing()  : int
Returns the spacing size for the separator.
getType()  : int
Retrieves the type of the component.
isDivider()  : bool
Returns whether the separator is a divider.
jsonSerialize()  : array<string|int, mixed>
{@inheritDoc}
new()  : self
Creates a new separator.
setDivider()  : $this
Sets whether the separator is a divider.
setSpacing()  : $this
Sets the spacing size for the separator.
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.

Constants

SPACING_LARGE

public mixed SPACING_LARGE = 2

SPACING_SMALL

Spacing size constants.

public mixed SPACING_SMALL = 1

TYPE_ACTION_ROW

public mixed TYPE_ACTION_ROW = 1

TYPE_CHANNEL_SELECT

public mixed TYPE_CHANNEL_SELECT = 8

TYPE_CONTAINER

public mixed TYPE_CONTAINER = 17

TYPE_CONTENT_INVENTORY_ENTRY

public mixed TYPE_CONTENT_INVENTORY_ENTRY = 16

TYPE_MEDIA_GALLERY

public mixed TYPE_MEDIA_GALLERY = 12

TYPE_MENTIONABLE_SELECT

public mixed TYPE_MENTIONABLE_SELECT = 7

TYPE_ROLE_SELECT

public mixed TYPE_ROLE_SELECT = 6

TYPE_SELECT_MENU

Use Component::TYPE_STRING_SELECT

public mixed TYPE_SELECT_MENU = 3

TYPE_SEPARATOR

public mixed TYPE_SEPARATOR = 14

TYPE_STRING_SELECT

public mixed TYPE_STRING_SELECT = 3

TYPE_TEXT_DISPLAY

public mixed TYPE_TEXT_DISPLAY = 10

TYPE_TEXT_INPUT

public mixed TYPE_TEXT_INPUT = 4

TYPE_THUMBNAIL

public mixed TYPE_THUMBNAIL = 11

TYPE_USER_SELECT

public mixed TYPE_USER_SELECT = 5

Properties

$id

32 bit integer used as an optional identifier for component.

protected int|null $id

$type

Component type.

protected int $type = \Discord\Builders\Components\Component::TYPE_SEPARATOR

$divider

Whether the separator is a divider.

private bool $divider = true

$spacing

Spacing size for the separator.

private int $spacing = self::SPACING_SMALL

Methods

getCustomId()

Returns the custom ID of the button.

public getCustomId() : string|null
Return values
string|null

getSpacing()

Returns the spacing size for the separator.

public getSpacing() : int
Return values
int

getType()

Retrieves the type of the component.

public getType() : int
Return values
int

isDivider()

Returns whether the separator is a divider.

public isDivider() : bool
Return values
bool

jsonSerialize()

{@inheritDoc}

public jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>

new()

Creates a new separator.

public static new() : self
Return values
self

setDivider()

Sets whether the separator is a divider.

public setDivider([bool $divider = true ]) : $this
Parameters
$divider : bool = true

Whether the separator is a divider.

Return values
$this

setSpacing()

Sets the spacing size for the separator.

public setSpacing(int $spacing) : $this
Parameters
$spacing : int

Spacing size for the separator.

Tags
throws
InvalidArgumentException

Invalid spacing size.

Return values
$this

generateUuid()

Generates a UUID which can be used for component custom IDs.

protected static generateUuid() : string
Return values
string

getId()

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

protected getId() : int|null

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.

Return values
int|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results