BanChatMember class final
Bans a member in a chat; requires can_restrict_members administrator right. Members can't be banned in private or secret chats. In supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first
Returns Ok.
- Inheritance
-
- Object
- TdFunction<
Ok> - BanChatMember
Constructors
- BanChatMember({required int chatId, required MessageSender memberId, required int bannedUntilDate, required bool revokeMessages})
-
Bans a member in a chat; requires can_restrict_members administrator right. Members can't be banned in private or secret chats. In supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first
const
Properties
- bannedUntilDate → int
-
Point in time (Unix timestamp) when the user will be unbanned; 0 if never. If the user is banned for more than 366 days or for less than 30 seconds from the current time, the user is considered to be banned forever. Ignored in basic groups and if a chat is banned
final
- canBeCalledSynchronously → bool
-
Whether TDLib documents this request as callable through
td_execute.no setterinherited - chatId → int
-
Chat identifier
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- memberId → MessageSender
-
Member identifier
final
- revokeMessages → bool
-
Pass true to delete all messages in the chat for the user that is being removed. Always true for supergroups and channels
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
copyWith(
{int? chatId, MessageSender? memberId, int? bannedUntilDate, bool? revokeMessages}) → BanChatMember -
Returns a copy with the given fields replaced. For a nullable
field pass a function, e.g.
field: () => nullto clear it. -
getConstructor(
) → String -
TDLib function name, e.g.
getMe.override -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
[dynamic extra]) → Map< String, dynamic> -
Converts this request to TDLib JSON, tagged with
extraif given.override -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- CONSTRUCTOR → const String
- TDLib type name.