org.telegram.telegrambots.api.methods.groupadministration

Class RestrictChatMember

java.lang.Object

org.telegram.telegrambots.api.methods.PartialBotApiMethod<T>

org.telegram.telegrambots.api.methods.BotApiMethod<Boolean>

org.telegram.telegrambots.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 and Description
static String	PATH

Fields inherited from class org.telegram.telegrambots.api.methods.BotApiMethod

METHOD_FIELD

Fields inherited from class org.telegram.telegrambots.api.methods.PartialBotApiMethod

OBJECT_MAPPER

Constructor Summary

Constructors

Constructor and Description
RestrictChatMember()
RestrictChatMember(Long chatId, Integer userId)
RestrictChatMember(String chatId, Integer userId)

Method Summary

Modifier and Type	Method and Description
Boolean	deserializeResponse(String answer) Deserialize a json answer to the response type to a method
Boolean	getCanAddWebPagePreviews()
Boolean	getCanSendMediaMessages()
Boolean	getCanSendMessages()
Boolean	getCanSendOtherMessages()
String	getChatId()
String	getMethod() Getter for method path (that is the same as method name)
Integer	getUntilDate()
Integer	getUserId()
RestrictChatMember	setCanAddWebPagePreviews(Boolean canAddWebPagePreviews)
RestrictChatMember	setCanSendMediaMessages(Boolean canSendMediaMessages)
RestrictChatMember	setCanSendMessages(Boolean canSendMessages)
RestrictChatMember	setCanSendOtherMessages(Boolean canSendOtherMessages)
RestrictChatMember	setChatId(Long chatId)
RestrictChatMember	setChatId(String chatId)
RestrictChatMember	setUntilDate(Integer untilDate)
RestrictChatMember	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

RestrictChatMember

public RestrictChatMember()

RestrictChatMember

public RestrictChatMember(String chatId,
                          Integer userId)

RestrictChatMember

public RestrictChatMember(Long chatId,
                          Integer userId)

Method Detail

getChatId

public String getChatId()

setChatId

public RestrictChatMember setChatId(String chatId)

setChatId

public RestrictChatMember setChatId(Long chatId)

getUserId

public Integer getUserId()

setUserId

public RestrictChatMember setUserId(Integer userId)

getUntilDate

public Integer getUntilDate()

setUntilDate

public RestrictChatMember setUntilDate(Integer untilDate)

getCanSendMessages

public Boolean getCanSendMessages()

setCanSendMessages

public RestrictChatMember setCanSendMessages(Boolean canSendMessages)

getCanSendMediaMessages

public Boolean getCanSendMediaMessages()

setCanSendMediaMessages

public RestrictChatMember setCanSendMediaMessages(Boolean canSendMediaMessages)

getCanSendOtherMessages

public Boolean getCanSendOtherMessages()

setCanSendOtherMessages

public RestrictChatMember setCanSendOtherMessages(Boolean canSendOtherMessages)

getCanAddWebPagePreviews

public Boolean getCanAddWebPagePreviews()

setCanAddWebPagePreviews

public RestrictChatMember setCanAddWebPagePreviews(Boolean canAddWebPagePreviews)

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