Skip to content

Commit d489638

Browse files
SpEcHiDeSpEcHiDe
committed
docs
1 parent 87a9cc2 commit d489638

File tree

1 file changed

+68
-36
lines changed

1 file changed

+68
-36
lines changed

‎pyrogram/types/messages_and_media/message.py‎

Lines changed: 68 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1605,6 +1605,7 @@ def link(self) -> str:
16051605
if self.chat.is_forum:
16061606
# If it's a forum but not a specific topic message, it defaults to topic 1 (General)
16071607
thread_id = self.message_thread_id if self.is_topic_message else 1
1608+
# https://t.me/c/1279877202/31475
16081609
return f"https://t.me/{chat_path}/{thread_id}/{self.id}"
16091610

16101611
# 4. Standard message link
@@ -1938,7 +1939,8 @@ async def reply_animation(
19381939
instead.
19391940
19401941
Raises:
1941-
RPCError: In case of a Telegram RPC error.
1942+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
1943+
19421944
"""
19431945

19441946
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -2125,7 +2127,8 @@ async def reply_audio(
21252127
instead.
21262128
21272129
Raises:
2128-
RPCError: In case of a Telegram RPC error.
2130+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
2131+
21292132
"""
21302133

21312134
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -2256,7 +2259,8 @@ async def reply_cached_media(
22562259
On success, the sent :obj:`~pyrogram.types.Message` is returned.
22572260
22582261
Raises:
2259-
RPCError: In case of a Telegram RPC error.
2262+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
2263+
22602264
"""
22612265

22622266
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -2338,8 +2342,9 @@ async def reply_chat_action(
23382342
``bool``: On success, True is returned.
23392343
23402344
Raises:
2341-
RPCError: In case of a Telegram RPC error.
23422345
ValueError: In case the provided string is not a valid chat action.
2346+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
2347+
23432348
"""
23442349
return await self._client.send_chat_action(
23452350
chat_id=self.chat.id,
@@ -2443,7 +2448,8 @@ async def reply_contact(
24432448
On success, the sent :obj:`~pyrogram.types.Message` is returned.
24442449
24452450
Raises:
2446-
RPCError: In case of a Telegram RPC error.
2451+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
2452+
24472453
"""
24482454

24492455
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -2619,7 +2625,8 @@ async def reply_document(
26192625
instead.
26202626
26212627
Raises:
2622-
RPCError: In case of a Telegram RPC error.
2628+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
2629+
26232630
"""
26242631

26252632
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -2732,7 +2739,8 @@ async def reply_game(
27322739
On success, the sent :obj:`~pyrogram.types.Message` is returned.
27332740
27342741
Raises:
2735-
RPCError: In case of a Telegram RPC error.
2742+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
2743+
27362744
"""
27372745

27382746
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -2817,7 +2825,8 @@ async def reply_inline_bot_result(
28172825
On success, the sent Message is returned.
28182826
28192827
Raises:
2820-
RPCError: In case of a Telegram RPC error.
2828+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
2829+
28212830
"""
28222831

28232832
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -2927,7 +2936,8 @@ async def reply_location(
29272936
On success, the sent :obj:`~pyrogram.types.Message` is returned.
29282937
29292938
Raises:
2930-
RPCError: In case of a Telegram RPC error.
2939+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
2940+
29312941
"""
29322942

29332943
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -3026,7 +3036,8 @@ async def reply_media_group(
30263036
List of :obj:`~pyrogram.types.Message`: On success, a list of the sent messages is returned.
30273037
30283038
Raises:
3029-
RPCError: In case of a Telegram RPC error.
3039+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
3040+
30303041
"""
30313042

30323043
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -3195,7 +3206,8 @@ async def reply_photo(
31953206
instead.
31963207
31973208
Raises:
3198-
RPCError: In case of a Telegram RPC error.
3209+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
3210+
31993211
"""
32003212

32013213
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -3389,7 +3401,8 @@ async def reply_poll(
33893401
On success, the sent :obj:`~pyrogram.types.Message` is returned.
33903402
33913403
Raises:
3392-
RPCError: In case of a Telegram RPC error.
3404+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
3405+
33933406
"""
33943407

33953408
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -3555,7 +3568,8 @@ async def reply_sticker(
35553568
instead.
35563569
35573570
Raises:
3558-
RPCError: In case of a Telegram RPC error.
3571+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
3572+
35593573
"""
35603574

35613575
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -3693,7 +3707,8 @@ async def reply_venue(
36933707
On success, the sent :obj:`~pyrogram.types.Message` is returned.
36943708
36953709
Raises:
3696-
RPCError: In case of a Telegram RPC error.
3710+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
3711+
36973712
"""
36983713

36993714
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -3905,7 +3920,8 @@ async def reply_video(
39053920
instead.
39063921
39073922
Raises:
3908-
RPCError: In case of a Telegram RPC error.
3923+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
3924+
39093925
"""
39103926

39113927
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -4096,7 +4112,8 @@ async def reply_video_note(
40964112
instead.
40974113
40984114
Raises:
4099-
RPCError: In case of a Telegram RPC error.
4115+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
4116+
41004117
"""
41014118

41024119
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -4272,7 +4289,8 @@ async def reply_voice(
42724289
instead.
42734290
42744291
Raises:
4275-
RPCError: In case of a Telegram RPC error.
4292+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
4293+
42764294
"""
42774295

42784296
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -4466,7 +4484,8 @@ async def reply_invoice(
44664484
On success, the sent :obj:`~pyrogram.types.Message` is returned.
44674485
44684486
Raises:
4469-
RPCError: In case of a Telegram RPC error.
4487+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
4488+
44704489
"""
44714490

44724491
reply_to_message_id, reply_parameters = utils._get_reply_to_message_quote_ids(
@@ -4564,7 +4583,8 @@ async def edit_text(
45644583
On success, the edited :obj:`~pyrogram.types.Message` is returned.
45654584
45664585
Raises:
4567-
RPCError: In case of a Telegram RPC error.
4586+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
4587+
45684588
"""
45694589
return await self._client.edit_message_text(
45704590
chat_id=self.chat.id,
@@ -4623,7 +4643,8 @@ async def edit_caption(
46234643
On success, the edited :obj:`~pyrogram.types.Message` is returned.
46244644
46254645
Raises:
4626-
RPCError: In case of a Telegram RPC error.
4646+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
4647+
46274648
"""
46284649
return await self._client.edit_message_caption(
46294650
chat_id=self.chat.id,
@@ -4673,7 +4694,8 @@ async def edit_media(
46734694
On success, the edited :obj:`~pyrogram.types.Message` is returned.
46744695
46754696
Raises:
4676-
RPCError: In case of a Telegram RPC error.
4697+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
4698+
46774699
"""
46784700
return await self._client.edit_message_media(
46794701
chat_id=self.chat.id,
@@ -4712,7 +4734,8 @@ async def edit_reply_markup(self, reply_markup: "types.InlineKeyboardMarkup" = N
47124734
:obj:`~pyrogram.types.Message` is returned, otherwise True is returned.
47134735
47144736
Raises:
4715-
RPCError: In case of a Telegram RPC error.
4737+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
4738+
47164739
"""
47174740
return await self._client.edit_message_reply_markup(
47184741
chat_id=self.chat.id,
@@ -4863,7 +4886,8 @@ async def forward(
48634886
On success, the forwarded Message is returned.
48644887
48654888
Raises:
4866-
RPCError: In case of a Telegram RPC error.
4889+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
4890+
48674891
"""
48684892
return await self._client.forward_messages(
48694893
from_chat_id=self.chat.id,
@@ -4994,8 +5018,8 @@ async def copy(
49945018
:obj:`~pyrogram.types.Message`: On success, the copied message is returned.
49955019
49965020
Raises:
4997-
RPCError: In case of a Telegram RPC error.
49985021
ValueError: In case if an invalid message was provided.
5022+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
49995023
50005024
"""
50015025
if self.service:
@@ -5237,7 +5261,8 @@ async def delete(self, revoke: bool = True):
52375261
``int``: Amount of affected messages
52385262
52395263
Raises:
5240-
RPCError: In case of a Telegram RPC error.
5264+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
5265+
52415266
"""
52425267
return await self._client.delete_messages(
52435268
chat_id=self.chat.id,
@@ -5325,9 +5350,10 @@ async def click(
53255350
- A :obj:`~pyrogram.types.User` object in case of a ``KeyboardButtonUserProfile`` button.
53265351
53275352
Raises:
5328-
RPCError: In case of a Telegram RPC error.
53295353
ValueError: In case the provided index or position is out of range or the button label was not found.
53305354
TimeoutError: In case, after clicking an inline button, the bot fails to answer within the timeout.
5355+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
5356+
53315357
"""
53325358

53335359
if isinstance(self.reply_markup, types.ReplyKeyboardMarkup):
@@ -5509,7 +5535,8 @@ async def react(
55095535
On success, :obj:`~pyrogram.types.MessageReactions`: is returned.
55105536
55115537
Raises:
5512-
RPCError: In case of a Telegram RPC error.
5538+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
5539+
55135540
"""
55145541
sr = None
55155542

@@ -5572,7 +5599,8 @@ async def retract_vote(
55725599
:obj:`~pyrogram.types.Poll`: On success, the poll with the retracted vote is returned.
55735600
55745601
Raises:
5575-
RPCError: In case of a Telegram RPC error.
5602+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
5603+
55765604
"""
55775605

55785606
return await self._client.retract_vote(
@@ -5651,9 +5679,9 @@ async def download(
56515679
If the message is a :obj:`~pyrogram.types.PaidMediaInfo` with more than one ``paid_media`` containing ``minithumbnail`` and ``idx`` is not specified, then a list of paths or binary file-like objects is returned.
56525680
56535681
Raises:
5654-
RPCError: In case of a Telegram RPC error.
56555682
IndexError: In case of wrong value of ``idx``.
56565683
ValueError: If the message doesn't contain any downloadable media.
5684+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
56575685
56585686
"""
56595687
return await self._client.download_media(
@@ -5695,7 +5723,8 @@ async def vote(
56955723
:obj:`~pyrogram.types.Poll`: On success, the poll with the chosen option is returned.
56965724
56975725
Raises:
5698-
RPCError: In case of a Telegram RPC error.
5726+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
5727+
56995728
"""
57005729

57015730
return await self._client.vote_poll(
@@ -5735,7 +5764,8 @@ async def pin(self, disable_notification: bool = False, both_sides: bool = False
57355764
otherwise, in case a message object couldn't be returned, True is returned.
57365765
57375766
Raises:
5738-
RPCError: In case of a Telegram RPC error.
5767+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
5768+
57395769
"""
57405770
return await self._client.pin_chat_message(
57415771
chat_id=self.chat.id,
@@ -5765,7 +5795,8 @@ async def unpin(self) -> bool:
57655795
True on success.
57665796
57675797
Raises:
5768-
RPCError: In case of a Telegram RPC error.
5798+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
5799+
57695800
"""
57705801
return await self._client.unpin_chat_message(
57715802
chat_id=self.chat.id,
@@ -5854,7 +5885,7 @@ async def read(self) -> bool:
58545885
True on success.
58555886
58565887
Raises:
5857-
RPCError: In case of a Telegram RPC error.
5888+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
58585889
58595890
"""
58605891
return await self._client.read_chat_history(
@@ -5887,7 +5918,7 @@ async def view(self, force_read: bool = True) -> bool:
58875918
True on success.
58885919
58895920
Raises:
5890-
RPCError: In case of a Telegram RPC error.
5921+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
58915922
58925923
"""
58935924
return await self._client.view_messages(
@@ -5926,7 +5957,7 @@ async def translate(
59265957
:obj:`~pyrogram.types.TranslatedText`: The translated result is returned.
59275958
59285959
Raises:
5929-
RPCError: In case of a Telegram RPC error.
5960+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
59305961
59315962
"""
59325963
return await self._client.translate_message_text(
@@ -6003,7 +6034,8 @@ async def star(
60036034
On success, :obj:`~pyrogram.types.MessageReactions`: is returned.
60046035
60056036
Raises:
6006-
RPCError: In case of a Telegram RPC error.
6037+
:obj:`~pyrogram.errors.RPCError`: In case of a Telegram RPC error.
6038+
60076039
"""
60086040
return await self._client.add_paid_message_reaction(
60096041
chat_id=self.chat.id,

0 commit comments

Comments
 (0)