TDLightTelegramBots/telegrambots-meta/src/main/java/org/telegram/telegrambots/meta/api/methods/polls/StopPoll.java

80 lines
2.4 KiB
Java
Raw Normal View History

2019-04-08 02:43:46 +02:00
package org.telegram.telegrambots.meta.api.methods.polls;
import com.fasterxml.jackson.annotation.JsonProperty;
2020-11-01 23:46:36 +01:00
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.NonNull;
import lombok.Setter;
import lombok.ToString;
2022-06-14 22:20:22 +02:00
import lombok.experimental.Tolerate;
2019-04-08 02:43:46 +02:00
import org.telegram.telegrambots.meta.api.methods.BotApiMethod;
2020-11-01 23:46:36 +01:00
import org.telegram.telegrambots.meta.api.objects.polls.Poll;
2019-04-08 02:43:46 +02:00
import org.telegram.telegrambots.meta.exceptions.TelegramApiRequestException;
import org.telegram.telegrambots.meta.exceptions.TelegramApiValidationException;
/**
* @author Ruben Bermudez
* @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.
*/
2020-11-01 23:46:36 +01:00
@EqualsAndHashCode(callSuper = false)
@Getter
@Setter
@ToString
2023-05-30 03:33:18 +02:00
@NoArgsConstructor(force = true)
2020-11-01 23:46:36 +01:00
@AllArgsConstructor
@Builder
2019-04-08 02:43:46 +02:00
public class StopPoll extends BotApiMethod<Poll> {
public static final String PATH = "stopPoll";
private static final String CHATID_FIELD = "chat_id";
private static final String MESSAGEID_FIELD = "message_id";
@JsonProperty(CHATID_FIELD)
2020-11-01 23:46:36 +01:00
@NonNull
2019-04-08 02:43:46 +02:00
private String chatId; ///< Unique identifier for the target chat or username of the target channel (in the format @channelusername)
@JsonProperty(MESSAGEID_FIELD)
2020-11-01 23:46:36 +01:00
@NonNull
2019-04-08 02:43:46 +02:00
private Integer messageId; ///< Identifier of the original message with the poll
2022-06-14 22:20:22 +02:00
@Tolerate
public void setChatId(@NonNull Long chatId) {
this.chatId = chatId.toString();
}
2019-04-08 02:43:46 +02:00
@Override
public String getMethod() {
return PATH;
}
@Override
public Poll deserializeResponse(String answer) throws TelegramApiRequestException {
2022-06-16 19:36:20 +02:00
return deserializeResponse(answer, Poll.class);
2019-04-08 02:43:46 +02:00
}
@Override
public void validate() throws TelegramApiValidationException {
2022-06-14 22:20:22 +02:00
if (chatId.isEmpty()) {
2019-04-08 02:43:46 +02:00
throw new TelegramApiValidationException("ChatId parameter can't be empty", this);
}
2022-06-14 22:20:22 +02:00
if (messageId == 0) {
2019-04-08 02:43:46 +02:00
throw new TelegramApiValidationException("Message Id parameter can't be empty", this);
}
}
2022-06-14 22:20:22 +02:00
public static class StopPollBuilder {
@Tolerate
public StopPollBuilder chatId(@NonNull Long chatId) {
this.chatId = chatId.toString();
return this;
}
}
2019-04-08 02:43:46 +02:00
}