BanChatMember (Telegram Bots Meta 6.1.0 API)

java.lang.Object
- org.telegram.telegrambots.meta.api.methods.PartialBotApiMethod<T>
- - org.telegram.telegrambots.meta.api.methods.BotApiMethod<Boolean>
  - - org.telegram.telegrambots.meta.api.methods.botapimethods.BotApiMethodBoolean
    - - org.telegram.telegrambots.meta.api.methods.groupadministration.BanChatMember

All Implemented Interfaces:

Validable
```
public class BanChatMember
extends BotApiMethodBoolean
```
Version:

5.3 Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the group for this to work. Returns True on success.

Author:

Ruben Bermudez

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class BanChatMember.BanChatMemberBuilder

Field Summary

Fields
Modifier and Type Field Description

static String PATH
- Fields inherited from class org.telegram.telegrambots.meta.api.methods.BotApiMethod
  METHOD_FIELD
- Fields inherited from class org.telegram.telegrambots.meta.api.methods.PartialBotApiMethod
  OBJECT_MAPPER

Constructor Summary

Constructors
Constructor Description

BanChatMember()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`forTimePeriodDuration(Duration duration)`
`String`	`getMethod()`	Getter for method path (that is the same as method name)
`void`	`setChatId(@NonNull Long chatId)`
`void`	`setUntilDateDateTime(ZonedDateTime date)`
`void`	`setUntilDateInstant(Instant instant)`
`void`	`validate()`	Validates that mandatory fields are filled and optional objects

Methods inherited from class org.telegram.telegrambots.meta.api.methods.botapimethods.BotApiMethodBoolean
deserializeResponse

Methods inherited from class org.telegram.telegrambots.meta.api.methods.PartialBotApiMethod
deserializeResponse, deserializeResponseArray, deserializeResponseSerializable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PATH
```
public static final String PATH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BanChatMember
```
public BanChatMember()
```
- Method Detail
  - setChatId
```
public void setChatId(@NonNull
                      @NonNull Long chatId)
```
  - setUntilDateInstant
```
public void setUntilDateInstant(Instant instant)
```
  - setUntilDateDateTime
```
public void setUntilDateDateTime(ZonedDateTime date)
```
  - forTimePeriodDuration
```
public void forTimePeriodDuration(Duration duration)
```
  - getMethod
```
public String getMethod()
```
    Description copied from class: BotApiMethod
    
    Getter for method path (that is the same as method name)
    
    Specified by:
    
    getMethod in class BotApiMethod<Boolean>
    
    Returns:
    
    Method path
  - validate
```
public void validate()
              throws TelegramApiValidationException
```
    Description copied from interface: Validable
    
    Validates that mandatory fields are filled and optional objects
    
    Throws:
    
    TelegramApiValidationException - If any mandatory field is empty