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.botapimethods.BotApiMethodBoolean

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

All Implemented Interfaces:

Validable

public class PinChatMessage
extends BotApiMethodBoolean

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PinChatMessage.PinChatMessageBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final 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
String	getMethod()	Getter for method path (that is the same as method name)
void	setChatId(@NonNull Long chatId)
void	validate()	Validates that mandatory fields are filled and optional objects

Methods inherited from class org.telegram.telegrambots.meta.api.methods.botapimethods.BotApiMethodBoolean

deserializeResponse

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

deserializeResponse, deserializeResponseArray, deserializeResponseSerializable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PATH

public static final String PATH

See Also:

• Constant Field Values

Constructor Details

PinChatMessage

public PinChatMessage()

Method Details

setChatId

public void setChatId(@NonNull
 @NonNull 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

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