DiscordPHP Documentation

File extends Content
in package
implements ComponentV2

File components allow you to send a file. You can also spoiler it.

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

Table of Contents

Interfaces

ComponentV2
This interface is a contract for V2 components.

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.
$file  : array<string|int, mixed>
The file to be displayed.
$spoiler  : bool
Whether the file is a spoiler.

Methods

getCustomId()  : string|null
Returns the custom ID of the button.
getFile()  : array<string|int, mixed>
Returns the file reference.
getType()  : int
Retrieves the type of the component.
isSpoiler()  : bool
Returns whether the file is a spoiler.
jsonSerialize()  : array<string|int, mixed>
{@inheritDoc}
new()  : self
Creates a new file component.
setFile()  : $this
Sets the file to be displayed.
setSpoiler()  : $this
Sets whether the file is a spoiler.
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

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

USAGE

public mixed USAGE = ['Message']

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_FILE

$file

The file to be displayed.

private array<string|int, mixed> $file

$spoiler

Whether the file is a spoiler.

private bool $spoiler = false

Methods

getCustomId()

Returns the custom ID of the button.

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

getFile()

Returns the file reference.

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

getType()

Retrieves the type of the component.

public getType() : int
Return values
int

isSpoiler()

Returns whether the file is a spoiler.

public isSpoiler() : bool
Return values
bool

jsonSerialize()

{@inheritDoc}

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

new()

Creates a new file component.

public static new([string|Attachment|null $filename = null ]) : self
Parameters
$filename : string|Attachment|null = null

The filename or attachment to reference.

Return values
self

setFile()

Sets the file to be displayed.

public setFile(string|Attachment $filename) : $this
Parameters
$filename : string|Attachment

The filename or attachment to reference.

Return values
$this

setSpoiler()

Sets whether the file is a spoiler.

public setSpoiler([bool $spoiler = true ]) : $this
Parameters
$spoiler : bool = true

Whether the file is a spoiler.

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