84 lines
2.8 KiB
Java
84 lines
2.8 KiB
Java
package org.telegram.telegrambots.meta.api.methods.pinnedmessages;
|
|
|
|
import com.fasterxml.jackson.annotation.JsonProperty;
|
|
import com.fasterxml.jackson.core.type.TypeReference;
|
|
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 org.telegram.telegrambots.meta.api.methods.BotApiMethod;
|
|
import org.telegram.telegrambots.meta.api.objects.ApiResponse;
|
|
import org.telegram.telegrambots.meta.exceptions.TelegramApiRequestException;
|
|
import org.telegram.telegrambots.meta.exceptions.TelegramApiValidationException;
|
|
|
|
import java.io.IOException;
|
|
|
|
/**
|
|
* @author Ruben Bermudez
|
|
* @version 3.1
|
|
* Use this method to remove a message from the list of pinned messages in a chat.
|
|
* Returns True on success.
|
|
*
|
|
* @apiNote If the chat is not a private chat, the bot must be an administrator in the chat for this to work
|
|
* and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages'
|
|
* admin right in a channel.
|
|
*/
|
|
@EqualsAndHashCode(callSuper = false)
|
|
@Getter
|
|
@Setter
|
|
@ToString
|
|
@RequiredArgsConstructor
|
|
@NoArgsConstructor
|
|
@AllArgsConstructor
|
|
@Builder
|
|
public class UnpinChatMessage extends BotApiMethod<Boolean> {
|
|
public static final String PATH = "unpinChatMessage";
|
|
|
|
private static final String CHATID_FIELD = "chat_id";
|
|
private static final String MESSAGEID_FIELD = "message_id";
|
|
|
|
@JsonProperty(CHATID_FIELD)
|
|
@NonNull
|
|
private String chatId; ///< Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
|
|
/**
|
|
* Optional.
|
|
* Identifier of a message to unpin.
|
|
*
|
|
* @apiNote If not specified, the most recent pinned message (by send date) will be unpinned.
|
|
*/
|
|
@JsonProperty(MESSAGEID_FIELD)
|
|
private Integer messageId;
|
|
|
|
@Override
|
|
public String getMethod() {
|
|
return PATH;
|
|
}
|
|
|
|
@Override
|
|
public Boolean deserializeResponse(String answer) throws TelegramApiRequestException {
|
|
try {
|
|
ApiResponse<Boolean> result = OBJECT_MAPPER.readValue(answer,
|
|
new TypeReference<ApiResponse<Boolean>>(){});
|
|
if (result.getOk()) {
|
|
return result.getResult();
|
|
} else {
|
|
throw new TelegramApiRequestException("Error unpinning chat message", result);
|
|
}
|
|
} catch (IOException e) {
|
|
throw new TelegramApiRequestException("Unable to deserialize response", e);
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public void validate() throws TelegramApiValidationException {
|
|
if (chatId == null || chatId.isEmpty()) {
|
|
throw new TelegramApiValidationException("ChatId parameter can't be empty", this);
|
|
}
|
|
}
|
|
}
|