Package org.telegram.telegrambots.meta.api.methods.groupadministration

Class KickChatMember

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.groupadministration.KickChatMember

All Implemented Interfaces:

Validable

public class KickChatMember
extends BotApiMethod<Boolean>

Version:

1.0 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

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
KickChatMember()
KickChatMember(Long chatId, Integer userId)
KickChatMember(String chatId, Integer userId)

Method Summary

Modifier and Type	Method	Description
Boolean	deserializeResponse(String answer)	Deserialize a json answer to the response type to a method
KickChatMember	forTimePeriod(Duration duration)
String	getChatId()
String	getMethod()	Getter for method path (that is the same as method name)
Integer	getUntilDate()
Integer	getUserId()
KickChatMember	setChatId(Long chatId)
KickChatMember	setChatId(String chatId)
KickChatMember	setUntilDate(Integer untilDateInSeconds)
KickChatMember	setUntilDate(Instant instant)
KickChatMember	setUntilDate(ZonedDateTime date)
KickChatMember	setUserId(Integer userId)
String	toString()
void	validate()	Validates that mandatory fields are filled and optional objects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PATH

public static final String PATH

See Also:

Constant Field Values

Constructor Detail

KickChatMember

public KickChatMember()

KickChatMember

public KickChatMember(String chatId,
                      Integer userId)

KickChatMember

public KickChatMember(Long chatId,
                      Integer userId)

Method Detail

getChatId

public String getChatId()

setChatId

public KickChatMember setChatId(String chatId)

setChatId

public KickChatMember setChatId(Long chatId)

getUserId

public Integer getUserId()

setUserId

public KickChatMember setUserId(Integer userId)

getUntilDate

public Integer getUntilDate()

setUntilDate

public KickChatMember setUntilDate(Integer untilDateInSeconds)

setUntilDate

public KickChatMember setUntilDate(Instant instant)

setUntilDate

public KickChatMember setUntilDate(ZonedDateTime date)

forTimePeriod

public KickChatMember forTimePeriod(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

deserializeResponse

public Boolean deserializeResponse(String answer)
                            throws TelegramApiRequestException

Description copied from class: PartialBotApiMethod

Deserialize a json answer to the response type to a method

Specified by:

deserializeResponse in class PartialBotApiMethod<Boolean>

Parameters:

answer - Json answer received

Returns:

Answer for the method

Throws:

TelegramApiRequestException

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

toString

public String toString()

Overrides:

toString in class Object