Update the reference with even more types and other docs

This commit is contained in:
Lonami Exo
2019-05-07 21:25:55 +02:00
parent 8bd9dd66ab
commit c6691dc6a8
7 changed files with 339 additions and 92 deletions

View File

@@ -127,7 +127,7 @@ class AdminLogEvent:
@property
def changed_about(self):
"""
Whether the channel's about was changed in this event or not.
Whether the channel's about was changed or not.
If ``True``, `old` and `new` will be present as ``str``.
"""
@@ -137,7 +137,7 @@ class AdminLogEvent:
@property
def changed_title(self):
"""
Whether the channel's title was changed in this event or not.
Whether the channel's title was changed or not.
If ``True``, `old` and `new` will be present as ``str``.
"""
@@ -147,7 +147,7 @@ class AdminLogEvent:
@property
def changed_username(self):
"""
Whether the channel's username was changed in this event or not.
Whether the channel's username was changed or not.
If ``True``, `old` and `new` will be present as ``str``.
"""
@@ -157,7 +157,7 @@ class AdminLogEvent:
@property
def changed_photo(self):
"""
Whether the channel's photo was changed in this event or not.
Whether the channel's photo was changed or not.
If ``True``, `old` and `new` will be present as :tl:`Photo`.
"""
@@ -167,7 +167,7 @@ class AdminLogEvent:
@property
def changed_sticker_set(self):
"""
Whether the channel's sticker set was changed in this event or not.
Whether the channel's sticker set was changed or not.
If ``True``, `old` and `new` will be present as :tl:`InputStickerSet`.
"""
@@ -177,7 +177,7 @@ class AdminLogEvent:
@property
def changed_message(self):
"""
Whether a message in this channel was edited in this event or not.
Whether a message in this channel was edited or not.
If ``True``, `old` and `new` will be present as
`Message <telethon.tl.custom.message.Message>`.
@@ -188,7 +188,7 @@ class AdminLogEvent:
@property
def deleted_message(self):
"""
Whether a message in this channel was deleted in this event or not.
Whether a message in this channel was deleted or not.
If ``True``, `old` will be present as
`Message <telethon.tl.custom.message.Message>`.
@@ -200,7 +200,7 @@ class AdminLogEvent:
def changed_admin(self):
"""
Whether the permissions for an admin in this channel
changed in this event or not.
changed or not.
If ``True``, `old` and `new` will be present as
:tl:`ChannelParticipant`.
@@ -212,7 +212,7 @@ class AdminLogEvent:
@property
def changed_restrictions(self):
"""
Whether a message in this channel was edited in this event or not.
Whether a message in this channel was edited or not.
If ``True``, `old` and `new` will be present as
:tl:`ChannelParticipant`.
@@ -224,7 +224,7 @@ class AdminLogEvent:
@property
def changed_invites(self):
"""
Whether the invites in the channel were toggled in this event or not.
Whether the invites in the channel were toggled or not.
If ``True``, `old` and `new` will be present as ``bool``.
"""
@@ -235,7 +235,7 @@ class AdminLogEvent:
def joined(self):
"""
Whether `user` joined through the channel's
public username in this event or not.
public username or not.
"""
return isinstance(self.original.action,
types.ChannelAdminLogEventActionParticipantJoin)
@@ -244,7 +244,7 @@ class AdminLogEvent:
def joined_invite(self):
"""
Whether a new user joined through an invite
link to the channel in this event or not.
link to the channel or not.
If ``True``, `new` will be present as
:tl:`ChannelParticipant`.
@@ -255,7 +255,7 @@ class AdminLogEvent:
@property
def left(self):
"""
Whether `user` left the channel in this event or not.
Whether `user` left the channel or not.
"""
return isinstance(self.original.action,
types.ChannelAdminLogEventActionParticipantLeave)
@@ -264,7 +264,7 @@ class AdminLogEvent:
def changed_hide_history(self):
"""
Whether hiding the previous message history for new members
in the channel were toggled in this event or not.
in the channel was toggled or not.
If ``True``, `old` and `new` will be present as ``bool``.
"""
@@ -275,7 +275,7 @@ class AdminLogEvent:
def changed_signatures(self):
"""
Whether the message signatures in the channel were toggled
in this event or not.
or not.
If ``True``, `old` and `new` will be present as ``bool``.
"""
@@ -285,7 +285,7 @@ class AdminLogEvent:
@property
def changed_pin(self):
"""
Whether a new message in this channel was pinned in this event or not.
Whether a new message in this channel was pinned or not.
If ``True``, `new` will be present as
`Message <telethon.tl.custom.message.Message>`.
@@ -296,7 +296,7 @@ class AdminLogEvent:
@property
def changed_default_banned_rights(self):
"""
Whether the default banned rights were changed in this event or not.
Whether the default banned rights were changed or not.
If ``True``, `old` and `new` will
be present as :tl:`ChatBannedRights`.
@@ -307,7 +307,7 @@ class AdminLogEvent:
@property
def stopped_poll(self):
"""
Whether a poll was stopped in this event or not.
Whether a poll was stopped or not.
If ``True``, `new` will be present as
`Message <telethon.tl.custom.message.Message>`.