Package 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 add a message to the list of pinned messages in a chat. 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
PinChatMessage()

Method Summary

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

Field Detail

PATH

public static final String PATH

See Also:

Constant Field Values

Constructor Detail

PinChatMessage

public PinChatMessage()

Method Detail

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