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

Class UnpinAllChatMessages

Object

PartialBotApiMethod<T>

BotApiMethod<Boolean>

BotApiMethodBoolean

UnpinAllChatMessages

All Implemented Interfaces:

Validable

public class UnpinAllChatMessages
extends BotApiMethodBoolean

Version:

3.1 Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns True on success.

Author:

Ruben Bermudez

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UnpinAllChatMessages.UnpinAllChatMessagesBuilder<C extends UnpinAllChatMessages,B extends UnpinAllChatMessages.UnpinAllChatMessagesBuilder<C,B>>

Nested classes/interfaces inherited from class BotApiMethodBoolean

BotApiMethodBoolean.BotApiMethodBooleanBuilder<C extends BotApiMethodBoolean,B extends BotApiMethodBoolean.BotApiMethodBooleanBuilder<C,B>>

Nested classes/interfaces inherited from class BotApiMethod

BotApiMethod.BotApiMethodBuilder<T extends Serializable,C extends BotApiMethod<T>,B extends BotApiMethod.BotApiMethodBuilder<T,C,B>>

Nested classes/interfaces inherited from class PartialBotApiMethod

PartialBotApiMethod.PartialBotApiMethodBuilder<T extends Serializable,C extends PartialBotApiMethod<T>,B extends PartialBotApiMethod.PartialBotApiMethodBuilder<T,C,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH

Fields inherited from class BotApiMethod

METHOD_FIELD

Fields inherited from class PartialBotApiMethod

OBJECT_MAPPER

Constructor Summary

Constructors

Constructor	Description
UnpinAllChatMessages()

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 BotApiMethodBoolean

deserializeResponse

Methods inherited from class PartialBotApiMethod

deserializeResponse, deserializeResponseArray, deserializeResponseSerializable

Methods inherited from class 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

UnpinAllChatMessages

public UnpinAllChatMessages()

Method Details

setChatId

public void setChatId(@NonNull
 @NonNull Long chatId)

getMethod

public String getMethod()

Description copied from class: PartialBotApiMethod

Getter for method path (that is the same as method name)

Specified by:

getMethod in class PartialBotApiMethod<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