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

Inheritance: extends AbstractInlineQueryResult
Mostrar archivo Open project: TelegramBot/Api

Protected Properties

Property Type Description
$caption string Optional. Short description of the result
$description string Optional. Short description of the result
$map array
$mimeType string Mime type of the content of video url, “text/html” or “video/mp4”
$requiredParams array
$thumbUrl string URL of the thumbnail (jpeg only) for the video
$type string
$videoDuration integer Optional. Video duration in seconds
$videoHeight integer Optional. Video height
$videoUrl string A valid URL for the embedded video player or video file
$videoWidth integer Optional. Video width

Public Methods

Method Description
__construct ( string $id, string $videoUrl, string $thumbUrl, string $mimeType, string $title, string | null $caption = null, string | null $description = null, integer | null $videoWidth = null, integer | null $videoHeight = null, integer | null $videoDuration = null, TelegramBot\Api\Types\Inline\InputMessageContent | null $inputMessageContent = null, TelegramBot\Api\Types\Inline\InlineKeyboardMarkup | null $inlineKeyboardMarkup = null ) Video constructor
getCaption ( ) : string
getDescription ( ) : string
getMimeType ( ) : string
getThumbUrl ( ) : mixed
getVideoDuration ( ) : integer
getVideoHeight ( ) : integer
getVideoUrl ( ) : string
getVideoWidth ( ) : integer
setCaption ( string $caption )
setDescription ( string $description )
setMimeType ( string $mimeType )
setThumbUrl ( mixed $thumbUrl )
setVideoDuration ( integer $videoDuration )
setVideoHeight ( integer $videoHeight )
setVideoUrl ( string $videoUrl )
setVideoWidth ( integer $videoWidth )

Method Details

__construct() public method

Video constructor
public __construct ( string $id, string $videoUrl, string $thumbUrl, string $mimeType, string $title, string | null $caption = null, string | null $description = null, integer | null $videoWidth = null, integer | null $videoHeight = null, integer | null $videoDuration = null, TelegramBot\Api\Types\Inline\InputMessageContent | null $inputMessageContent = null, TelegramBot\Api\Types\Inline\InlineKeyboardMarkup | null $inlineKeyboardMarkup = null )
$id string
$videoUrl string
$thumbUrl string
$mimeType string
$title string
$caption string | null
$description string | null
$videoWidth integer | null
$videoHeight integer | null
$videoDuration integer | null
$inputMessageContent TelegramBot\Api\Types\Inline\InputMessageContent | null
$inlineKeyboardMarkup TelegramBot\Api\Types\Inline\InlineKeyboardMarkup | null

getCaption() public method

public getCaption ( ) : string
return string

getDescription() public method

public getDescription ( ) : string
return string

getMimeType() public method

public getMimeType ( ) : string
return string

getThumbUrl() public method

public getThumbUrl ( ) : mixed
return mixed

getVideoDuration() public method

public getVideoDuration ( ) : integer
return integer

getVideoHeight() public method

public getVideoHeight ( ) : integer
return integer

getVideoUrl() public method

public getVideoUrl ( ) : string
return string

getVideoWidth() public method

public getVideoWidth ( ) : integer
return integer

setCaption() public method

public setCaption ( string $caption )
$caption string

setDescription() public method

public setDescription ( string $description )
$description string

setMimeType() public method

public setMimeType ( string $mimeType )
$mimeType string

setThumbUrl() public method

public setThumbUrl ( mixed $thumbUrl )
$thumbUrl mixed

setVideoDuration() public method

public setVideoDuration ( integer $videoDuration )
$videoDuration integer

setVideoHeight() public method

public setVideoHeight ( integer $videoHeight )
$videoHeight integer

setVideoUrl() public method

public setVideoUrl ( string $videoUrl )
$videoUrl string

setVideoWidth() public method

public setVideoWidth ( integer $videoWidth )
$videoWidth integer

Property Details

$caption protected_oe property

Optional. Short description of the result
protected string $caption
return string

$description protected_oe property

Optional. Short description of the result
protected string $description
return string

$map protected_oe static_oe property

protected static array $map
return array

$mimeType protected_oe property

Mime type of the content of video url, “text/html” or “video/mp4”
protected string $mimeType
return string

$requiredParams protected_oe static_oe property

protected static array $requiredParams
return array

$thumbUrl protected_oe property

URL of the thumbnail (jpeg only) for the video
protected string $thumbUrl
return string

$type protected_oe property

protected string $type
return string

$videoDuration protected_oe property

Optional. Video duration in seconds
protected int $videoDuration
return integer

$videoHeight protected_oe property

Optional. Video height
protected int $videoHeight
return integer

$videoUrl protected_oe property

A valid URL for the embedded video player or video file
protected string $videoUrl
return string

$videoWidth protected_oe property

Optional. Video width
protected int $videoWidth
return integer