PHP Class TelegramBot\Api\Types\Inline\QueryResult\Gif

By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can provide InputMessageContent to send it instead of the animation.
Inheritance: extends AbstractInlineQueryResult
Show file Open project: TelegramBot/Api

Protected Properties

Property Type Description
$caption string Optional. Caption of the GIF file to be sent, 0-200 characters
$gifHeight integer Optional. Height of the GIF
$gifUrl string A valid URL for the GIF file. File size must not exceed 1MB
$gifWidth integer Optional. Width of the GIF
$map array
$requiredParams array
$thumbUrl string URL of the static thumbnail for the result (jpeg or gif)
$type string

Public Methods

Method Description
__construct ( string $id, string $gifUrl, string $thumbUrl = null, string | null $title = null, string | null $caption = null, integer | null $gifWidth = null, integer | null $gifHeight = null, TelegramBot\Api\Types\Inline\InputMessageContent $inputMessageContent = null, TelegramBot\Api\Types\Inline\InlineKeyboardMarkup | null $inlineKeyboardMarkup = null ) InlineQueryResultGif constructor.
getCaption ( ) : string
getGifHeight ( ) : integer
getGifUrl ( ) : string
getGifWidth ( ) : integer
getThumbUrl ( ) : string
setCaption ( string $caption )
setGifHeight ( integer $gifHeight )
setGifUrl ( string $gifUrl )
setGifWidth ( integer $gifWidth )
setThumbUrl ( string $thumbUrl )

Method Details

__construct() public method

InlineQueryResultGif constructor.
public __construct ( string $id, string $gifUrl, string $thumbUrl = null, string | null $title = null, string | null $caption = null, integer | null $gifWidth = null, integer | null $gifHeight = null, TelegramBot\Api\Types\Inline\InputMessageContent $inputMessageContent = null, TelegramBot\Api\Types\Inline\InlineKeyboardMarkup | null $inlineKeyboardMarkup = null )
$id string
$gifUrl string
$thumbUrl string
$title string | null
$caption string | null
$gifWidth integer | null
$gifHeight integer | null
$inputMessageContent TelegramBot\Api\Types\Inline\InputMessageContent
$inlineKeyboardMarkup TelegramBot\Api\Types\Inline\InlineKeyboardMarkup | null

getCaption() public method

public getCaption ( ) : string
return string

getGifHeight() public method

public getGifHeight ( ) : integer
return integer

getGifUrl() public method

public getGifUrl ( ) : string
return string

getGifWidth() public method

public getGifWidth ( ) : integer
return integer

getThumbUrl() public method

public getThumbUrl ( ) : string
return string

setCaption() public method

public setCaption ( string $caption )
$caption string

setGifHeight() public method

public setGifHeight ( integer $gifHeight )
$gifHeight integer

setGifUrl() public method

public setGifUrl ( string $gifUrl )
$gifUrl string

setGifWidth() public method

public setGifWidth ( integer $gifWidth )
$gifWidth integer

setThumbUrl() public method

public setThumbUrl ( string $thumbUrl )
$thumbUrl string

Property Details

$caption protected property

Optional. Caption of the GIF file to be sent, 0-200 characters
protected string $caption
return string

$gifHeight protected property

Optional. Height of the GIF
protected int $gifHeight
return integer

$gifUrl protected property

A valid URL for the GIF file. File size must not exceed 1MB
protected string $gifUrl
return string

$gifWidth protected property

Optional. Width of the GIF
protected int $gifWidth
return integer

$map protected static property

protected static array $map
return array

$requiredParams protected static property

protected static array $requiredParams
return array

$thumbUrl protected property

URL of the static thumbnail for the result (jpeg or gif)
protected string $thumbUrl
return string

$type protected property

protected string $type
return string