org.telegram.telegrambots.meta.api.methods.pinnedmessages

Class PinChatMessage

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.pinnedmessages.PinChatMessage

All Implemented Interfaces:

Validable

public class PinChatMessage
extends BotApiMethod<Boolean>

Version:

3.1 Use this method to pin a message in a supergroup or channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. 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.meta.api.methods.BotApiMethod

METHOD_FIELD

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

OBJECT_MAPPER

Constructor Summary

Constructors

Constructor and Description
PinChatMessage()
PinChatMessage(Long chatId, Integer messageId)
PinChatMessage(String chatId, Integer messageId)

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()
Boolean	getDisableNotification()
Integer	getMessageId()
String	getMethod() Getter for method path (that is the same as method name)
PinChatMessage	setChatId(Long chatId)
PinChatMessage	setChatId(String chatId)
PinChatMessage	setDisableNotification(Boolean disableNotification)
PinChatMessage	setMessageId(Integer messageId)
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

PinChatMessage

public PinChatMessage()

PinChatMessage

public PinChatMessage(String chatId,
                      Integer messageId)

PinChatMessage

public PinChatMessage(Long chatId,
                      Integer messageId)

Method Detail

getChatId

public String getChatId()

setChatId

public PinChatMessage setChatId(String chatId)

setChatId

public PinChatMessage setChatId(Long chatId)

getMessageId

public Integer getMessageId()

setMessageId

public PinChatMessage setMessageId(Integer messageId)

getDisableNotification

public Boolean getDisableNotification()

setDisableNotification

public PinChatMessage setDisableNotification(Boolean disableNotification)

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