LinkMenu¶
-
class
pyrubrum.
LinkMenu
(name: str, menu_id: str, link: Union[str, Callable[[Handler, pyrogram.client.client.Client, Any, Dict[str, Any]], str]])¶ Implementation of a menu which represents a link to a website.
- Parameters
name (str) – The name you give to the menu, which will be used as the text of callback button, if needed. See
BaseMenu
for more information.menu_id (str) – The unique identifier given to the menu, which will refer unequivocally to this entity. The hash for this class is generated relying on the content of this field. Avoid using
0
as it is used for buttons whose purpose is only related to design (i.e. they do not point to any menu, see Null-pointer button). SeeBaseMenu
for more information.link (Types.Content) –
What will be displayed whenever a user accesses this menu. A function can be provided as well and must follow the following arguments pattern:
func(handler, client, context, parameters)
-
button
(handler: BaseHandler, client: Client, context: Any, parameters: Optional[Dict[str, Any]] = None) → pyrubrum.keyboard.button.Button¶ Create an inline button which redirects to a website retrieved from
LinkMenu.link
, usingname
as the content of the text field.- Parameters
handler (BaseHandler) – The handler which coordinates the management of the menus.
client (Client) – The client which is linked to the handler.
context (Union[CallbackQuery, Message]) – The context for which button is generated for.
parameters (Optional[Dict[str, Any]]) – The parameters which were passed to the handler. Defaults to
None
.
- Returns
The generated button.
- Return type