org.telegram.telegrambots.api.methods.pinnedmessages

Class UnpinChatMessage

java.lang.Object

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

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

org.telegram.telegrambots.api.methods.pinnedmessages.UnpinChatMessage

All Implemented Interfaces:

Validable

public class UnpinChatMessage
extends BotApiMethod<Boolean>

Version:

3.1 Use this method to unpin a message in a supergroup or channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. 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
UnpinChatMessage()
UnpinChatMessage(Long chatId)
UnpinChatMessage(String chatId)

Method Summary

Modifier and Type	Method and Description
Boolean	deserializeResponse(String answer) Deserialize a json answer to the response type to a method
String	getChatId()
String	getMethod() Getter for method path (that is the same as method name)
UnpinChatMessage	setChatId(Long chatId)
UnpinChatMessage	setChatId(String chatId)
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

UnpinChatMessage

public UnpinChatMessage()

UnpinChatMessage

public UnpinChatMessage(String chatId)

UnpinChatMessage

public UnpinChatMessage(Long chatId)

Method Detail

getChatId

public String getChatId()

setChatId

public UnpinChatMessage setChatId(String chatId)

setChatId

public UnpinChatMessage setChatId(Long chatId)

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