org.telegram.telegrambots.meta.api.methods.polls

Class StopPoll

java.lang.Object

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

org.telegram.telegrambots.meta.api.methods.BotApiMethod<Poll>

org.telegram.telegrambots.meta.api.methods.polls.StopPoll

All Implemented Interfaces:

Validable

public class StopPoll
extends BotApiMethod<Poll>

Version:

1.0 Use this method to stop a poll which was sent by the bot. On success, the stopped Poll with the final results is returned.

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
StopPoll()
StopPoll(Long chatId, Integer messageId)
StopPoll(String chatId, Integer messageId)

Method Summary

Modifier and Type	Method and Description
Poll	deserializeResponse(String answer) Deserialize a json answer to the response type to a method
boolean	equals(Object o)
String	getChatId()
Integer	getMessageId()
String	getMethod() Getter for method path (that is the same as method name)
int	hashCode()
StopPoll	setChatId(Long chatId)
StopPoll	setChatId(String chatId)
StopPoll	setMessageId(Integer messageId)
String	toString()
void	validate() Validates that mandatory fields are filled and optional objects

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PATH

public static final String PATH

See Also:

Constant Field Values

Constructor Detail

StopPoll

public StopPoll()

StopPoll

public StopPoll(String chatId,
                Integer messageId)

StopPoll

public StopPoll(Long chatId,
                Integer messageId)

Method Detail

getChatId

public String getChatId()

setChatId

public StopPoll setChatId(String chatId)

setChatId

public StopPoll setChatId(Long chatId)

getMessageId

public Integer getMessageId()

setMessageId

public StopPoll setMessageId(Integer messageId)

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<Poll>

Returns:

Method path

deserializeResponse

public Poll 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<Poll>

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object