MTPyroger/pyrogram/methods/messages/send_message.py

175 lines
7.0 KiB
Python
Raw Normal View History

2020-03-21 14:43:32 +00:00
# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2020 Dan <https://github.com/delivrance>
#
2020-03-21 14:43:32 +00:00
# This file is part of Pyrogram.
#
2020-03-21 14:43:32 +00:00
# Pyrogram is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
2020-03-21 14:43:32 +00:00
# Pyrogram is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
2020-03-21 14:43:32 +00:00
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from typing import Union, List, Optional
2020-11-29 14:48:29 +00:00
from pyrogram import raw, utils
from pyrogram import types
from pyrogram.scaffold import Scaffold
class SendMessage(Scaffold):
async def send_message(
2019-03-16 18:23:23 +00:00
self,
chat_id: Union[int, str],
text: str,
parse_mode: Optional[str] = object,
2020-11-29 14:48:29 +00:00
entities: List["types.MessageEntity"] = None,
2019-03-16 18:23:23 +00:00
disable_web_page_preview: bool = None,
disable_notification: bool = None,
reply_to_message_id: int = None,
2019-09-07 13:56:37 +00:00
schedule_date: int = None,
2019-03-16 18:23:23 +00:00
reply_markup: Union[
"types.InlineKeyboardMarkup",
"types.ReplyKeyboardMarkup",
"types.ReplyKeyboardRemove",
"types.ForceReply"
2019-03-16 18:23:23 +00:00
] = None
) -> "types.Message":
"""Send text messages.
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
For your personal cloud (Saved Messages) you can simply use "me" or "self".
For a contact that exists in your Telegram address book you can use his phone number (str).
text (``str``):
Text of the message to be sent.
2018-05-09 11:04:02 +00:00
parse_mode (``str``, *optional*):
2019-06-26 14:36:24 +00:00
By default, texts are parsed using both Markdown and HTML styles.
You can combine both syntaxes together.
Pass "markdown" or "md" to enable Markdown-style parsing only.
2019-06-26 14:36:24 +00:00
Pass "html" to enable HTML-style parsing only.
Pass None to completely disable style parsing.
2020-11-29 14:48:29 +00:00
entities (List of :obj:`~pyrogram.types.MessageEntity`):
2020-12-26 12:08:40 +00:00
List of special entities that appear in message text, which can be specified instead of *parse_mode*.
2020-11-29 14:48:29 +00:00
disable_web_page_preview (``bool``, *optional*):
Disables link previews for links in this message.
disable_notification (``bool``, *optional*):
Sends the message silently.
Users will receive a notification with no sound.
2018-05-09 11:04:02 +00:00
reply_to_message_id (``int``, *optional*):
If the message is a reply, ID of the original message.
2019-09-07 13:56:37 +00:00
schedule_date (``int``, *optional*):
Date when the message will be automatically sent. Unix time.
reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardRemove` | :obj:`~pyrogram.types.ForceReply`, *optional*):
Additional interface options. An object for an inline keyboard, custom reply keyboard,
instructions to remove reply keyboard or to force a reply from the user.
Returns:
:obj:`~pyrogram.types.Message`: On success, the sent text message is returned.
2019-07-25 09:22:14 +00:00
Example:
.. code-block:: python
2020-03-30 12:39:36 +00:00
:emphasize-lines: 2,5,8,11,21-23,26-32
2019-07-25 09:22:14 +00:00
# Simple example
app.send_message("haskell", "Thanks for creating **Pyrogram**!")
# Disable web page previews
app.send_message("me", "https://docs.pyrogram.org", disable_web_page_preview=True)
# Reply to a message using its id
app.send_message("me", "this is a reply", reply_to_message_id=12345)
# Force HTML-only styles for this request only
app.send_message("me", "**not bold**, <i>italic<i>", parse_mode="html")
##
# For bots only, send messages with keyboards attached
##
2020-10-31 18:29:39 +00:00
from pyrogram.types import (
2019-07-25 09:22:14 +00:00
ReplyKeyboardMarkup, InlineKeyboardMarkup, InlineKeyboardButton)
# Send a normal keyboard
app.send_message(
chat_id, "Look at that button!",
reply_markup=ReplyKeyboardMarkup([["Nice!"]]))
# Send an inline keyboard
app.send_message(
chat_id, "These are inline buttons",
reply_markup=InlineKeyboardMarkup(
[
[InlineKeyboardButton("Data", callback_data="hidden_callback_data")],
[InlineKeyboardButton("Docs", url="https://docs.pyrogram.org")]
]))
"""
2019-07-25 09:22:14 +00:00
2020-11-29 14:48:29 +00:00
message, entities = (await utils.parse_text_entities(self, text, parse_mode, entities)).values()
r = await self.send(
raw.functions.messages.SendMessage(
peer=await self.resolve_peer(chat_id),
no_webpage=disable_web_page_preview or None,
silent=disable_notification or None,
reply_to_msg_id=reply_to_message_id,
random_id=self.rnd_id(),
2019-09-07 13:56:37 +00:00
schedule_date=schedule_date,
reply_markup=reply_markup.write() if reply_markup else None,
message=message,
entities=entities
)
)
if isinstance(r, raw.types.UpdateShortSentMessage):
peer = await self.resolve_peer(chat_id)
peer_id = (
peer.user_id
if isinstance(peer, raw.types.InputPeerUser)
else -peer.chat_id
)
return types.Message(
message_id=r.id,
chat=types.Chat(
id=peer_id,
type="private",
client=self
),
text=message,
date=r.date,
outgoing=r.out,
entities=[
types.MessageEntity._parse(None, entity, {})
for entity in entities
],
client=self
)
for i in r.updates:
if isinstance(i, (raw.types.UpdateNewMessage,
raw.types.UpdateNewChannelMessage,
raw.types.UpdateNewScheduledMessage)):
return await types.Message._parse(
self, i.message,
{i.id: i for i in r.users},
2019-09-07 13:56:37 +00:00
{i.id: i for i in r.chats},
is_scheduled=isinstance(i, raw.types.UpdateNewScheduledMessage)
)