Document drop_author and add drop_media_captions

drop_author is already supported but is undocumented. drop_media_captions for consistency with drop_author being implemented.
This commit is contained in:
Nick80835 2025-01-17 09:28:05 -05:00 committed by Lonami
parent b9aafa3441
commit 5a0e69693b

View File

@ -936,6 +936,7 @@ class MessageMethods:
as_album: bool = None,
schedule: 'hints.DateLike' = None,
drop_author: bool = None,
drop_media_captions: bool = None,
) -> 'typing.Sequence[types.Message]':
"""
Forwards the given messages to the specified entity.
@ -979,6 +980,12 @@ class MessageMethods:
instead they will be scheduled to be automatically sent
at a later time.
drop_author (`bool`, optional):
Whether to forward messages without quoting the original author.
drop_media_captions (`bool`, optional):
Whether to strip captions from media. Setting this to `True` requires that `drop_author` also be set to `True`.
Returns
The list of forwarded `Message <telethon.tl.custom.message.Message>`,
or a single one if a list wasn't provided as input.
@ -1048,7 +1055,8 @@ class MessageMethods:
background=background,
with_my_score=with_my_score,
schedule_date=schedule,
drop_author=drop_author
drop_author=drop_author,
drop_media_captions=drop_media_captions
)
result = await self(req)
sent.extend(self._get_response_message(req, result, entity))