Update documentation com

This commit is contained in:
netkas 2024-11-03 17:28:51 -05:00
parent 56c7fb04d2
commit f26f1c963f
7 changed files with 15 additions and 7 deletions

View file

@ -17,6 +17,8 @@
} }
/** /**
* A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates.
*
* @return ChatBoostUpdated The updated chat boost information. * @return ChatBoostUpdated The updated chat boost information.
*/ */
protected function getChatBoost(): ChatBoostUpdated protected function getChatBoost(): ChatBoostUpdated

View file

@ -9,13 +9,17 @@
abstract class ChatJoinRequestEvent extends UpdateEvent abstract class ChatJoinRequestEvent extends UpdateEvent
{ {
/**
* @inheritDoc
*/
public static function getEventType(): UpdateEventType public static function getEventType(): UpdateEventType
{ {
return UpdateEventType::CHAT_JOIN_REQUEST_EVENT; return UpdateEventType::CHAT_JOIN_REQUEST_EVENT;
} }
/** /**
* Retrieves the chat join request from the update. * A request to join the chat has been sent. The bot must have the can_invite_users
* administrator right in the chat to receive these updates.
* *
* @return ChatJoinRequest The chat join request data. * @return ChatJoinRequest The chat join request data.
*/ */

View file

@ -18,7 +18,8 @@
} }
/** /**
* Retrieves the updated chat member information from the update object. * A chat member's status was updated in a chat. The bot must be an administrator in the chat and must
* explicitly specify "chat_member" in the list of allowed_updates to receive these updates.
* *
* @return ChatMemberUpdated The updated chat member instance. * @return ChatMemberUpdated The updated chat member instance.
*/ */

View file

@ -18,7 +18,7 @@
} }
/** /**
* Retrieves the chosen inline result from the current update. * The result of an inline query that was chosen by a user and sent to their chat partner.
* *
* @return ChosenInlineResult The chosen inline result associated with the current update. * @return ChosenInlineResult The chosen inline result associated with the current update.
*/ */

View file

@ -17,7 +17,7 @@
return UpdateEventType::INLINE_QUERY; return UpdateEventType::INLINE_QUERY;
} }
/** /**C
* New incoming inline query * New incoming inline query
* *
* @return InlineQuery * @return InlineQuery

View file

@ -18,9 +18,10 @@
} }
/** /**
* New poll state. Bots receive only updates about manually stopped polls and polls, which are sent by the bot * A user changed their answer in a non-anonymous poll.
* Bots receive new votes only in polls that were sent by the bot itself.
* *
* @return Poll * @return Poll The poll.
*/ */
protected function getPoll(): Poll protected function getPoll(): Poll
{ {

View file

@ -17,7 +17,7 @@
} }
/** /**
* Retrieves the removed chat boost from the update. * A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates.
* *
* @return ChatBoostRemoved The chat boost that was removed. * @return ChatBoostRemoved The chat boost that was removed.
*/ */