Documentation

InlineQueryResultDocument extends InlineEntity
in package
implements InlineQueryResult

Class InlineQueryResultDocument

Tags
link
$data = [ 'id' => '', 'title' => '', 'caption' => '', 'document_url' => '', 'mime_type' => '', 'description' => '', 'reply_markup' => , 'input_message_content' => , 'thumb_url' => '', 'thumb_width' => 30, 'thumb_height' => 30, ];

Interfaces, Classes and Traits

InlineQueryResult

Table of Contents

__call()  : mixed|null
Return the variable for the called getter or magically set properties dynamically.
__construct()  : mixed
InlineQueryResultDocument constructor
__toString()  : string
Perform to string
escapeMarkdown()  : string
Escape markdown special characters
getBotUsername()  :
getCaption()  :
getDescription()  :
getDocumentUrl()  :
getId()  :
getInputMessageContent()  :
getMimeType()  :
getProperty()  : mixed
Get a property from the current Entity
getRawData()  :
getReplyMarkup()  :
getThumbHeight()  :
getThumbUrl()  :
getThumbWidth()  :
getTitle()  :
getType()  :
setCaption()  :
setDescription()  :
setDocumentUrl()  :
setId()  :
setInputMessageContent()  :
setMimeType()  :
setReplyMarkup()  :
setThumbHeight()  :
setThumbUrl()  :
setThumbWidth()  :
setTitle()  :
toJson()  : string
Perform to json
tryMention()  : string|null
Try to mention the user
assignMemberVariables()  : mixed
Helper to set member variables
makePrettyObjectArray()  : array<string|int, mixed>
Return an array of nice objects from an array of object arrays
subEntities()  : array<string|int, mixed>
Get the list of the properties that are themselves Entities
validate()  : mixed
Perform any special entity validation

Methods

__call()

Return the variable for the called getter or magically set properties dynamically.

public __call( $method,  $args) : mixed|null
Parameters
$method :
$args :
Return values
mixed|null —

__construct()

InlineQueryResultDocument constructor

public __construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
$data : array<string|int, mixed> = []
Tags
throws
TelegramException
Return values
mixed —

__toString()

Perform to string

public __toString() : string
Return values
string —

escapeMarkdown()

Escape markdown special characters

public escapeMarkdown(string $string) : string
Parameters
$string : string
Return values
string —

getBotUsername()

public getBotUsername() :

Return the bot name passed to this entity

Return values
—

getCaption()

public getCaption() :

Optional. Caption of the document to be sent, 0-200 characters

Return values
—

getInputMessageContent()

public getInputMessageContent() :

Optional. Content of the message to be sent instead of the file

Return values
—

getMimeType()

public getMimeType() :

Mime type of the content of the file, either “application/pdf” or “application/zip”

Return values
—

getProperty()

Get a property from the current Entity

public getProperty(mixed $property[, mixed $default = null ]) : mixed
Parameters
$property : mixed
$default : mixed = null
Return values
mixed —

getRawData()

public getRawData() :

Get the raw data passed to this entity

Return values
—

getReplyMarkup()

public getReplyMarkup() :

Optional. Inline keyboard attached to the message

Return values
—

getThumbUrl()

public getThumbUrl() :

Optional. URL of the thumbnail (jpeg only) for the file

Return values
—

setCaption()

public setCaption(string $caption) :

Optional. Caption of the document to be sent, 0-200 characters

Parameters
$caption : string
Return values
—

setDescription()

public setDescription(string $description) :

Optional. Short description of the result

Parameters
$description : string
Return values
—

setDocumentUrl()

public setDocumentUrl(string $document_url) :

A valid URL for the file

Parameters
$document_url : string
Return values
—

setId()

public setId(string $id) :

Unique identifier for this result, 1-64 bytes

Parameters
$id : string
Return values
—

setMimeType()

public setMimeType(string $mime_type) :

Mime type of the content of the file, either “application/pdf” or “application/zip”

Parameters
$mime_type : string
Return values
—

setThumbHeight()

public setThumbHeight(int $thumb_height) :

Optional. Thumbnail height

Parameters
$thumb_height : int
Return values
—

setThumbUrl()

public setThumbUrl(string $thumb_url) :

Optional. URL of the thumbnail (jpeg only) for the file

Parameters
$thumb_url : string
Return values
—

setThumbWidth()

public setThumbWidth(int $thumb_width) :

Optional. Thumbnail width

Parameters
$thumb_width : int
Return values
—

setTitle()

public setTitle(string $title) :

Title for the result

Parameters
$title : string
Return values
—

toJson()

Perform to json

public toJson() : string
Return values
string —

tryMention()

Try to mention the user

public tryMention([bool $escape_markdown = false ]) : string|null

Mention the user with the username otherwise print first and last name if the $escape_markdown argument is true special characters are escaped from the output

Parameters
$escape_markdown : bool = false
Return values
string|null —

assignMemberVariables()

Helper to set member variables

protected assignMemberVariables(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Return values
mixed —

makePrettyObjectArray()

Return an array of nice objects from an array of object arrays

protected makePrettyObjectArray(string $class, string $property) : array<string|int, mixed>

This method is used to generate pretty object arrays mainly for PhotoSize and Entities object arrays.

Parameters
$class : string
$property : string
Return values
array<string|int, mixed> —

subEntities()

Get the list of the properties that are themselves Entities

protected subEntities() : array<string|int, mixed>
Return values
array<string|int, mixed> —

validate()

Perform any special entity validation

protected validate() : mixed
Tags
throws
TelegramException
Return values
mixed —

Search results