phpbotgram

SendPoll extends TelegramMethod
in package

FinalYes

Use this method to send a native poll. On success, the sent Message is returned.

Source: https://core.telegram.org/bots/api#sendpoll

Tags
extends

Table of Contents

Constants

ApiMethod  : string = 'sendPoll'
ReturnsType  : string = \Gruven\PhpBotGram\Types\Message::class
Subclasses override with either: - a `class-string<TelegramObject>` (e.g. Message::class) for object returns - a scalar type name ('bool', 'int', 'string') for primitive returns - 'list:<inner>' for array returns

Properties

$allowAddingOptions  : bool|null
$allowPaidBroadcast  : bool|null
$allowsMultipleAnswers  : bool|null
$allowsRevoting  : bool|null
$bot  : Bot|null
$businessConnectionId  : string|null
$chatId  : int|string
$closeDate  : DateInterval|DateTime|int|null
$correctOptionIds  : array<int, int>
$countryCodes  : array<int, string>
$description  : string|null
$descriptionEntities  : array<int, MessageEntity>
$descriptionParseMode  : BotDefault|string|null
$disableNotification  : bool|null
$explanation  : string|null
$explanationEntities  : array<int, MessageEntity>
$explanationMedia  : InputPollMediaInterface|null
$explanationParseMode  : BotDefault|string|null
$hideResultsUntilCloses  : bool|null
$isAnonymous  : bool|null
$isClosed  : bool|null
$media  : InputPollMediaInterface|null
$membersOnly  : bool|null
$messageEffectId  : string|null
$messageThreadId  : int|null
$openPeriod  : int|null
$options  : array<int, InputPollOption|string>
$protectContent  : bool|BotDefault|null
$question  : string
$questionEntities  : array<int, MessageEntity>
$questionParseMode  : BotDefault|string|null
$replyMarkup  : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null
$replyParameters  : ReplyParameters|null
$shuffleOptions  : bool|null
$type  : string|null

Methods

__construct()  : mixed
as_()  : static
Alias of withBot() for grep-translating aiogram code that uses obj.as_(bot).
bindBot()  : static
Returns a clone bound to $bot. Used by hand-authored shortcut methods (Message::answer, etc.) so the chained ->emit() picks up the bot without an explicit argument.
emit()  : TReturn
Emit this method via the bound bot (or the explicitly-passed bot).
withBot()  : static
Returns a clone of $this with $bot rebound recursively. Walks every public property; nested `BotContextController` instances are rebound via their own `withBot`, arrays (including nested arrays of arbitrary depth — e.g.

Constants

ApiMethod

public string ApiMethod = 'sendPoll'

ReturnsType

Subclasses override with either: - a `class-string<TelegramObject>` (e.g. Message::class) for object returns - a scalar type name ('bool', 'int', 'string') for primitive returns - 'list:<inner>' for array returns

public string ReturnsType = \Gruven\PhpBotGram\Types\Message::class

Stays '' on the abstract base — Phase 2 codegen sets it per concrete method.

Properties

$allowAddingOptions read-only

public bool|null $allowAddingOptions = null

$allowPaidBroadcast read-only

public bool|null $allowPaidBroadcast = null

$allowsMultipleAnswers read-only

public bool|null $allowsMultipleAnswers = null

$allowsRevoting read-only

public bool|null $allowsRevoting = null

$businessConnectionId read-only

public string|null $businessConnectionId = null

$chatId read-only

public int|string $chatId

$correctOptionIds read-only

public array<int, int> $correctOptionIds = null

$countryCodes read-only

public array<int, string> $countryCodes = null

$description read-only

public string|null $description = null

$descriptionParseMode read-only

public BotDefault|string|null $descriptionParseMode = new BotDefault('parse_mode')

$disableNotification read-only

public bool|null $disableNotification = null

$explanation read-only

public string|null $explanation = null

$explanationParseMode read-only

public BotDefault|string|null $explanationParseMode = new BotDefault('parse_mode')

$hideResultsUntilCloses read-only

public bool|null $hideResultsUntilCloses = null

$isAnonymous read-only

public bool|null $isAnonymous = null

$isClosed read-only

public bool|null $isClosed = null

$membersOnly read-only

public bool|null $membersOnly = null

$messageEffectId read-only

public string|null $messageEffectId = null

$messageThreadId read-only

public int|null $messageThreadId = null

$openPeriod read-only

public int|null $openPeriod = null

$protectContent read-only

public bool|BotDefault|null $protectContent = new BotDefault('protect_content')

$question read-only

public string $question

$questionParseMode read-only

public BotDefault|string|null $questionParseMode = new BotDefault('parse_mode')

$shuffleOptions read-only

public bool|null $shuffleOptions = null

$type read-only

public string|null $type = null

Methods

__construct()

public __construct(int|string $chatId, string $question, array<string|int, mixed> $options[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, BotDefault|string|null $questionParseMode = new BotDefault('parse_mode') ][, array<string|int, mixed>|null $questionEntities = null ][, bool|null $isAnonymous = null ][, string|null $type = null ][, bool|null $allowsMultipleAnswers = null ][, bool|null $allowsRevoting = null ][, bool|null $shuffleOptions = null ][, bool|null $allowAddingOptions = null ][, bool|null $hideResultsUntilCloses = null ][, bool|null $membersOnly = null ][, array<string|int, mixed>|null $countryCodes = null ][, array<string|int, mixed>|null $correctOptionIds = null ][, string|null $explanation = null ][, BotDefault|string|null $explanationParseMode = new BotDefault('parse_mode') ][, array<string|int, mixed>|null $explanationEntities = null ][, InputPollMediaInterface|null $explanationMedia = null ][, int|null $openPeriod = null ][, DateInterval|DateTime|int|null $closeDate = null ][, bool|null $isClosed = null ][, string|null $description = null ][, BotDefault|string|null $descriptionParseMode = new BotDefault('parse_mode') ][, array<string|int, mixed>|null $descriptionEntities = null ][, InputPollMediaInterface|null $media = null ][, bool|null $disableNotification = null ][, bool|BotDefault|null $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ][, Bot|null $bot = null ]) : mixed
Parameters
$chatId : int|string
$question : string
$options : array<string|int, mixed>
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$questionParseMode : BotDefault|string|null = new BotDefault('parse_mode')
$questionEntities : array<string|int, mixed>|null = null
$isAnonymous : bool|null = null
$type : string|null = null
$allowsMultipleAnswers : bool|null = null
$allowsRevoting : bool|null = null
$shuffleOptions : bool|null = null
$allowAddingOptions : bool|null = null
$hideResultsUntilCloses : bool|null = null
$membersOnly : bool|null = null
$countryCodes : array<string|int, mixed>|null = null
$correctOptionIds : array<string|int, mixed>|null = null
$explanation : string|null = null
$explanationParseMode : BotDefault|string|null = new BotDefault('parse_mode')
$explanationEntities : array<string|int, mixed>|null = null
$explanationMedia : InputPollMediaInterface|null = null
$openPeriod : int|null = null
$closeDate : DateInterval|DateTime|int|null = null
$isClosed : bool|null = null
$description : string|null = null
$descriptionParseMode : BotDefault|string|null = new BotDefault('parse_mode')
$descriptionEntities : array<string|int, mixed>|null = null
$media : InputPollMediaInterface|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault|null = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
$bot : Bot|null = null

as_()

Alias of withBot() for grep-translating aiogram code that uses obj.as_(bot).

public as_(Bot|null $bot) : static

IMPORTANT: behaves DIFFERENTLY from upstream — upstream mutates self.bot in place and returns self. The PHP port can't mutate readonly, so this returns a clone. Callers must reassign: $msg = $msg->as($bot).

Parameters
$bot : Bot|null
Return values
static

bindBot()

Returns a clone bound to $bot. Used by hand-authored shortcut methods (Message::answer, etc.) so the chained ->emit() picks up the bot without an explicit argument.

public bindBot(Bot|null $bot) : static
Parameters
$bot : Bot|null
Return values
static

emit()

Emit this method via the bound bot (or the explicitly-passed bot).

public emit([Bot|null $bot = null ]) : TReturn

Mirrors upstream methods/base.py:81-93 (await + emit).

Parameters
$bot : Bot|null = null
Return values
TReturn

withBot()

Returns a clone of $this with $bot rebound recursively. Walks every public property; nested `BotContextController` instances are rebound via their own `withBot`, arrays (including nested arrays of arbitrary depth — e.g.

public withBot(Bot|null $bot) : static

list<list<KeyboardButton>>) are walked element-wise. Plain values (scalars, DateTime, enums, InputFile etc.) pass through untouched.

Mirrors upstream pydantic model_validate(context={"bot": bot}) (aiogram ContextController.as_/model_dump_json+model_validate).

Scope note: PHP 8.5 treats public readonly as effectively public protected(set) readonly for clone-with — only code running with a scope in the property's declaring class hierarchy (declaring class plus its ancestors and descendants) can use clone($obj, ['x' => ...]) against it. Because this method lives on BotContextController and every TelegramObject/TelegramMethod subclass extends it, the walker's clone($this, [...]) call legally rewrites subclass-declared readonly slots like Message::$chat. External callers cannot use the same syntax — they must funnel through this method.

Parameters
$bot : Bot|null
Return values
static
On this page

Search results