Class RestrictChatMember
- 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.RestrictChatMember
-
- All Implemented Interfaces:
Validable
public class RestrictChatMember extends BotApiMethod<Boolean>
- Version:
- 3.1 Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all boolean parameters to lift restrictions from a user. 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 RestrictChatMember()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Boolean
deserializeResponse(String answer)
Deserialize a json answer to the response type to a methodvoid
forTimePeriodDuration(Duration duration)
String
getMethod()
Getter for method path (that is the same as method name)void
setUntilDateDateTime(ZonedDateTime date)
void
setUntilDateInstant(Instant instant)
void
validate()
Validates that mandatory fields are filled and optional objects
-
-
-
Field Detail
-
PATH
public static final String PATH
- See Also:
- Constant Field Values
-
-
Method Detail
-
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 classBotApiMethod<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 classPartialBotApiMethod<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
-
-