aiogram.api.methods.export_chat_invite_link

aiogram/api/methods/export_chat_invite_link.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
from __future__ import annotations

from typing import TYPE_CHECKING, Any, Dict, Union

from .base import Request, TelegramMethod

if TYPE_CHECKING:  # pragma: no cover
    from ..client.bot import Bot


class ExportChatInviteLink(TelegramMethod[str]):
    """
    Use this method to generate a new invite link for a chat; any previously generated link is
    revoked. The bot must be an administrator in the chat for this to work and must have the
    appropriate admin rights. Returns the new invite link as String on success.
    Note: Each administrator in a chat generates their own invite links. Bots can't use invite
    links generated by other administrators. If you want your bot to work with invite links, it
    will need to generate its own link using exportChatInviteLink — after this the link will
    become available to the bot via the getChat method. If your bot needs to generate a new invite
    link replacing its previous one, use exportChatInviteLink again.

    Source: https://core.telegram.org/bots/api#exportchatinvitelink
    """

    __returning__ = str

    chat_id: Union[int, str]
    """Unique identifier for the target chat or username of the target channel (in the format
    @channelusername)"""

    def build_request(self, bot: Bot) -> Request:
        data: Dict[str, Any] = self.dict()

        return Request(method="exportChatInviteLink", data=data)