119 lines
4.6 KiB
Java
119 lines
4.6 KiB
Java
/*
|
|
* This file is part of TelegramBots.
|
|
*
|
|
* TelegramBots is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* TelegramBots is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with TelegramBots. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
package org.telegram.telegrambots.meta.api.methods.games;
|
|
|
|
import com.fasterxml.jackson.annotation.JsonProperty;
|
|
import lombok.AllArgsConstructor;
|
|
import lombok.Builder;
|
|
import lombok.EqualsAndHashCode;
|
|
import lombok.Getter;
|
|
import lombok.NoArgsConstructor;
|
|
import lombok.NonNull;
|
|
import lombok.RequiredArgsConstructor;
|
|
import lombok.Setter;
|
|
import lombok.ToString;
|
|
import lombok.experimental.Tolerate;
|
|
import org.telegram.telegrambots.meta.api.methods.BotApiMethod;
|
|
import org.telegram.telegrambots.meta.api.objects.games.GameHighScore;
|
|
import org.telegram.telegrambots.meta.exceptions.TelegramApiRequestException;
|
|
import org.telegram.telegrambots.meta.exceptions.TelegramApiValidationException;
|
|
|
|
import java.util.ArrayList;
|
|
|
|
/**
|
|
* @author Ruben Bermudez
|
|
* @version 2.4
|
|
* Use this method to get data for high score tables.
|
|
* Will return the score of the specified user and several of his neighbors in a game.
|
|
* On success, returns an Array of GameHighScore objects.
|
|
*
|
|
* @apiNote This method will currently return scores for the target user,
|
|
* plus two of his closest neighbors on each side. Will also return the top three users
|
|
* if the user and his neighbors are not among them.
|
|
* Please note that this behavior is subject to change.
|
|
*
|
|
*/
|
|
@EqualsAndHashCode(callSuper = false)
|
|
@Getter
|
|
@Setter
|
|
@ToString
|
|
@NoArgsConstructor(force = true)
|
|
@RequiredArgsConstructor
|
|
@AllArgsConstructor
|
|
@Builder
|
|
public class GetGameHighScores extends BotApiMethod<ArrayList<GameHighScore>> {
|
|
public static final String PATH = "getGameHighScores";
|
|
|
|
private static final String CHATID_FIELD = "chat_id";
|
|
private static final String MESSAGEID_FIELD = "message_id";
|
|
private static final String INLINE_MESSAGE_ID_FIELD = "inline_message_id";
|
|
private static final String USER_ID_FIELD = "user_id";
|
|
|
|
@JsonProperty(CHATID_FIELD)
|
|
private String chatId; ///< Optional. Required if inline_message_id is not specified. Unique identifier for the target chat (or username of the target channel in the format @channelusername)
|
|
@JsonProperty(MESSAGEID_FIELD)
|
|
private Integer messageId; ///< Optional. Required if inline_message_id is not specified. Unique identifier of the sent message
|
|
@JsonProperty(INLINE_MESSAGE_ID_FIELD)
|
|
private String inlineMessageId; ///< Optional. Required if chat_id and message_id are not specified. Identifier of the inline message
|
|
@JsonProperty(USER_ID_FIELD)
|
|
@NonNull
|
|
private Long userId; ///<Target user id
|
|
|
|
@Tolerate
|
|
public void setChatId(Long chatId) {
|
|
this.chatId = chatId == null ? null : chatId.toString();
|
|
}
|
|
|
|
@Override
|
|
public String getMethod() {
|
|
return PATH;
|
|
}
|
|
|
|
@Override
|
|
public ArrayList<GameHighScore> deserializeResponse(String answer) throws TelegramApiRequestException {
|
|
return deserializeResponseArray(answer, GameHighScore.class);
|
|
}
|
|
|
|
@Override
|
|
public void validate() throws TelegramApiValidationException {
|
|
if (inlineMessageId == null) {
|
|
if (chatId == null || chatId.isEmpty()) {
|
|
throw new TelegramApiValidationException("ChatId parameter can't be empty if inlineMessageId is not present", this);
|
|
}
|
|
if (messageId == null) {
|
|
throw new TelegramApiValidationException("MessageId parameter can't be empty if inlineMessageId is not present", this);
|
|
}
|
|
} else {
|
|
if (chatId != null) {
|
|
throw new TelegramApiValidationException("ChatId parameter must be empty if inlineMessageId is provided", this);
|
|
}
|
|
if (messageId != null) {
|
|
throw new TelegramApiValidationException("MessageId parameter must be empty if inlineMessageId is provided", this);
|
|
}
|
|
}
|
|
}
|
|
|
|
public static class GetGameHighScoresBuilder {
|
|
|
|
@Tolerate
|
|
public GetGameHighScoresBuilder chatId(Long chatId) {
|
|
this.chatId = chatId == null ? null : chatId.toString();
|
|
return this;
|
|
}
|
|
}
|
|
}
|