DiscordPHP Documentation

Thumbnail extends Content

in package

• Application

implements ComponentV2

Thumbnail components allow you to add a thumbnail image to a section.

Tags

link

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

since

10.5.0

@property

?int|null $id Optional identifier for component.

@property

?string|null $description Alt text for the media, max 1024 characters.

@property

?bool|null $spoiler Whether the thumbnail should be a spoiler (or blurred out). Defaults to false.

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_LABEL  = 18

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

$description  : string|null

Description for the thumbnail.

$id  : int|null

32 bit integer used as an optional identifier for component.

$media  : UnfurledMediaItem

Media item for the thumbnail.

$spoiler  : bool|null

Whether the thumbnail is a spoiler.

$type  : int

Component type.

Methods

getCustomId()  : string|null

Returns the custom ID of the button.

getDescription()  : string|null

Returns the description for the thumbnail.

getMedia()  : UnfurledMediaItem|null

Returns the media item for the thumbnail.

getType()  : int

Retrieves the type of the component.

isSpoiler()  : bool

Returns whether the thumbnail is a spoiler.

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

new()  : self

Creates a new thumbnail.

setDescription()  : $this

Sets the description for the thumbnail.

setMedia()  : $this

Sets the media item for the thumbnail.

setSpoiler()  : $this

Sets whether the thumbnail 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.

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.