aiogram/.butcher/templates/methods/entity.rst.jinja2
Alex Root Junior 3ea73fbbbd
Add missing shortcuts, new enums, reworked old stuff (#1070)
* Render shortcuts

* Render docs

* Added enumerations

* Added docs

* Use enums, removed Helper

* Bump butcher

* Added InputMediaType enum

* Added MaskPositionPoint, InlineQueryResultType enums

* Update texts

* Added StickerType enum

* Cover tests

* Update docs

* Fixed imports

* Re-enabled all pre-commit hooks
2022-12-04 03:05:49 +02:00

54 lines
1.3 KiB
Django/Jinja
Executable file

{{ object.name|header('#') }}
{{ object.name }}
{{ object.name|header('#') }}
Returns: :obj:`{{ object.returning.parsed_type|type }}`
.. automodule:: aiogram.methods.{{ object.name|pythonize_name }}
:members:
:member-order: bysource
:undoc-members: True
Usage
=====
As bot method
-------------
.. code-block::
result: {{ object.returning.parsed_type|type }} = await bot.{{ object.name|pythonize_name }}(...)
Method as object
----------------
Imports:
- :code:`from aiogram.methods.{{ object.name|pythonize_name }} import {{ object.name|pythonize_class_name }}`
- alias: :code:`from aiogram.methods import {{ object.name|pythonize_class_name }}`
With specific bot
~~~~~~~~~~~~~~~~~
.. code-block:: python
result: {{ object.returning.parsed_type|type }} = await bot({{ object.name|pythonize_class_name }}(...))
{% if can_be_used_in_webhook -%}
As reply into Webhook in handler
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: python
return {{ object.name|pythonize_class_name }}(...)
{%- endif %}
{% if aliased %}
As shortcut from received object
--------------------------------
{% for alias in aliased %}
- :meth:`aiogram.types.{{ alias.type|pythonize_name }}.{{ alias.type|pythonize_class_name }}.{{ alias.name }}`
{%- endfor %}
{% endif %}