Thumbnail
extends Content
in package
implements
ComponentV2
Thumbnail components allow you to add a thumbnail image to a section.
Tags
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.
- $description : string|null
- Description for the thumbnail.
- $media : UnfurledMediaItem
- Media item for the thumbnail.
- $spoiler : bool
- Whether the thumbnail is a spoiler.
Methods
- getCustomId() : string|null
- Returns the custom ID of the button.
- getDescription() : string|null
- Returns the description for the thumbnail.
- getMedia() : UnfurledMediaItem
- 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>
- {@inheritDoc}
- 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.
Constants
TYPE_ACTION_ROW
public
mixed
TYPE_ACTION_ROW
= 1
TYPE_BUTTON
public
mixed
TYPE_BUTTON
= 2
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_FILE
public
mixed
TYPE_FILE
= 13
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_SECTION
public
mixed
TYPE_SECTION
= 9
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_THUMBNAIL
$description
Description for the thumbnail.
private
string|null
$description
$media
Media item for the thumbnail.
private
UnfurledMediaItem
$media
$spoiler
Whether the thumbnail is a spoiler.
private
bool
$spoiler
= false
Methods
getCustomId()
Returns the custom ID of the button.
public
getCustomId() : string|null
Return values
string|nullgetDescription()
Returns the description for the thumbnail.
public
getDescription() : string|null
Return values
string|nullgetMedia()
Returns the media item for the thumbnail.
public
getMedia() : UnfurledMediaItem
Return values
UnfurledMediaItemgetType()
Retrieves the type of the component.
public
getType() : int
Return values
intisSpoiler()
Returns whether the thumbnail is a spoiler.
public
isSpoiler() : bool
Return values
booljsonSerialize()
{@inheritDoc}
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>new()
Creates a new thumbnail.
public
static new(string $url) : self
Parameters
- $url : string
-
URL of the media item.
Return values
selfsetDescription()
Sets the description for the thumbnail.
public
setDescription(string|null $description) : $this
Parameters
- $description : string|null
-
Description for the thumbnail (max 1024 characters).
Tags
Return values
$thissetMedia()
Sets the media item for the thumbnail.
public
setMedia(UnfurledMediaItem|string $media) : $this
Parameters
- $media : UnfurledMediaItem|string
Return values
$thissetSpoiler()
Sets whether the thumbnail is a spoiler.
public
setSpoiler([bool $spoiler = true ]) : $this
Parameters
- $spoiler : bool = true
-
Whether the thumbnail is a spoiler.
Return values
$thisgenerateUuid()
Generates a UUID which can be used for component custom IDs.
protected
static generateUuid() : string
Return values
stringgetId()
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.