phpbotgram

UnbanChatMember extends TelegramMethod

in package

• Application

Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.

Tags

extends

Table of Contents

Constants

ApiMethod  : string = 'unbanChatMember'

ReturnsType  : string = 'bool'

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

$bot  : Bot|null

$chatId  : int|string

$onlyIfBanned  : bool|null

$userId  : int

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.