""" The MIT License (MIT) Copyright (c) 2015-present Rapptz Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ from __future__ import annotations from typing import TYPE_CHECKING, Any, Dict, Literal, Optional, TypeVar, Union from .item import Item from ..enums import ComponentType from ..components import UnfurledMediaItem if TYPE_CHECKING: from typing_extensions import Self from .view import LayoutView from ..components import ThumbnailComponent V = TypeVar('V', bound='LayoutView', covariant=True) __all__ = ('Thumbnail',) class Thumbnail(Item[V]): """Represents a UI Thumbnail. .. versionadded:: 2.6 Parameters ---------- media: Union[:class:`str`, :class:`discord.UnfurledMediaItem`] The media of the thumbnail. This can be a URL or a reference to an attachment that matches the ``attachment://filename.extension`` structure. description: Optional[:class:`str`] The description of this thumbnail. Up to 256 characters. Defaults to ``None``. spoiler: :class:`bool` Whether to flag this thumbnail as a spoiler. Defaults to ``False``. row: Optional[:class:`int`] The relative row this thumbnail belongs to. By default items are arranged automatically into those rows. If you'd like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to ``None``, which is automatic ordering. The row number must be between 0 and 39 (i.e. zero indexed) id: Optional[:class:`int`] The ID of this component. This must be unique across the view. """ def __init__( self, media: Union[str, UnfurledMediaItem], *, description: Optional[str] = None, spoiler: bool = False, row: Optional[int] = None, id: Optional[int] = None, ) -> None: super().__init__() self.media: UnfurledMediaItem = UnfurledMediaItem(media) if isinstance(media, str) else media self.description: Optional[str] = description self.spoiler: bool = spoiler self.row = row self.id = id @property def width(self): return 5 @property def type(self) -> Literal[ComponentType.thumbnail]: return ComponentType.thumbnail def _is_v2(self) -> bool: return True def to_component_dict(self) -> Dict[str, Any]: base = { 'type': self.type.value, 'spoiler': self.spoiler, 'media': self.media.to_dict(), 'description': self.description, } if self.id is not None: base['id'] = self.id return base @classmethod def from_component(cls, component: ThumbnailComponent) -> Self: return cls( media=component.media.url, description=component.description, spoiler=component.spoiler, id=component.id, )