Module tdlight.api

Class TdApi.BanChatMember

Enclosing class:
TdApi

public static final class TdApi.BanChatMember extends TdApi.Function<TdApi.Ok>
Bans a member in a chat; requires canRestrictMembers 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

  • Field Details

    • chatId

      public long chatId
      Chat identifier.
    • memberId

      public TdApi.MessageSender memberId
      Member identifier.
    • bannedUntilDate

      public int bannedUntilDate
      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.
    • revokeMessages

      public boolean revokeMessages
      Pass true to delete all messages in the chat for the user that is being removed. Always true for supergroups and channels.
    • CONSTRUCTOR

      public static final int CONSTRUCTOR
      Identifier uniquely determining type of the object.
      See Also:
  • Constructor Details

    • BanChatMember

      public BanChatMember()
      Bans a member in a chat; requires canRestrictMembers 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

    • BanChatMember

      public BanChatMember(long chatId, TdApi.MessageSender memberId, int bannedUntilDate, boolean revokeMessages)
      Bans a member in a chat; requires canRestrictMembers 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

      Parameters:
      chatId - Chat identifier.
      memberId - Member identifier.
      bannedUntilDate - 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.
      revokeMessages - Pass true to delete all messages in the chat for the user that is being removed. Always true for supergroups and channels.

      Returns Ok

    • BanChatMember

      public BanChatMember(DataInput input) throws IOException
      Bans a member in a chat; requires canRestrictMembers 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

      Parameters:
      input - Serialized input
      Throws:
      IOException - the deserialization failed
  • Method Details

    • getConstructor

      public int getConstructor()
      Description copied from class: TdApi.Object
      Returns an identifier uniquely determining type of the object.
      Specified by:
      getConstructor in class TdApi.Object
      Returns:
      this.CONSTRUCTOR
    • serialize

      public void serialize(DataOutput output) throws IOException
      Serialize the TDLib class
      Specified by:
      serialize in class TdApi.Object
      Parameters:
      output - output data stream
      Throws:
      IOException - the serialization failed
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object