MediaGallery
extends Content
in package
implements
ComponentV2
Media gallery components allow you to group images, videos or gifs into a gallery grid.
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.
- $items : array<string|int, MediaGalleryItem>
- Array of media gallery items.
Methods
- addItem() : $this
- Adds a media item to the gallery.
- getCustomId() : string|null
- Returns the custom ID of the button.
- getItems() : array<string|int, MediaGalleryItem>
- Returns all the media items in the gallery.
- getType() : int
- Retrieves the type of the component.
- jsonSerialize() : array<string|int, mixed>
- {@inheritDoc}
- new() : self
- Creates a new media gallery.
- 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_MEDIA_GALLERY
$items
Array of media gallery items.
private
array<string|int, MediaGalleryItem>
$items
= []
Methods
addItem()
Adds a media item to the gallery.
public
addItem(MediaGalleryItem|string $item[, string|null $description = null ][, bool $spoiler = false ]) : $this
Parameters
- $item : MediaGalleryItem|string
-
Media gallery item or URL of the media item.
- $description : string|null = null
-
Description for the media item (max 1024 characters).
- $spoiler : bool = false
-
Whether the media item is a spoiler.
Tags
Return values
$thisgetCustomId()
Returns the custom ID of the button.
public
getCustomId() : string|null
Return values
string|nullgetItems()
Returns all the media items in the gallery.
public
getItems() : array<string|int, MediaGalleryItem>
Return values
array<string|int, MediaGalleryItem>getType()
Retrieves the type of the component.
public
getType() : int
Return values
intjsonSerialize()
{@inheritDoc}
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>new()
Creates a new media gallery.
public
static new() : self
Return values
selfgenerateUuid()
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.