io.sgr.telegram.bot.api.models.http.EditMessageCaptionPayload Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of telegram-bot.api Show documentation
The newest version!
/*
 * Copyright 2017-2019 SgrAlpha
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package io.sgr.telegram.bot.api.models.http;

import static io.sgr.telegram.bot.api.utils.Preconditions.notEmptyString;
import static io.sgr.telegram.bot.api.utils.Preconditions.notNull;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.JsonProcessingException;
import io.sgr.telegram.bot.api.models.markups.ReplyMarkup;
import io.sgr.telegram.bot.api.utils.JsonUtil;

/**
 * @author SgrAlpha
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
public class EditMessageCaptionPayload {

    private final String chatId;
    private final Long messageId;
    private final String inlineMessageId;
    private final String caption;
    private final ReplyMarkup replyMarkup;

    /**
     * @param chatId      Unique identifier for the target chat or username of the target channel (in the
     *                    format @channelusername)
     * @param messageId   Identifier of the sent message.
     * @param caption     Optional. New caption of the message
     * @param replyMarkup Optional. A JSON-serialized object for an inline keyboard.
     */
    public EditMessageCaptionPayload(String chatId, Long messageId, String caption, ReplyMarkup replyMarkup) {
        notEmptyString(chatId, "Chat ID should be provided");
        this.chatId = chatId;
        notNull(messageId, "Message ID should be provided");
        this.messageId = messageId;
        this.inlineMessageId = null;
        this.caption = caption;
        this.replyMarkup = replyMarkup;
    }

    /**
     * @param inlineMessageId Identifier of the inline message.
     * @param caption         Optional. New caption of the message
     * @param replyMarkup     Optional. A JSON-serialized object for an inline keyboard.
     */
    public EditMessageCaptionPayload(String inlineMessageId, String caption, ReplyMarkup replyMarkup) {
        this.chatId = null;
        this.messageId = null;
        notNull(inlineMessageId, "Inline message ID should be provided");
        this.inlineMessageId = inlineMessageId;
        this.caption = caption;
        this.replyMarkup = replyMarkup;
    }

    /**
     * @return the chatId
     */
    @JsonProperty("chat_id")
    public String getChatId() {
        return this.chatId;
    }

    /**
     * @return the messageId
     */
    @JsonProperty("message_id")
    public Long getMessageId() {
        return this.messageId;
    }

    /**
     * @return the inlineMessageId
     */
    @JsonProperty("inline_message_id")
    public String getInlineMessageId() {
        return this.inlineMessageId;
    }

    /**
     * @return the caption
     */
    @JsonProperty("caption")
    public String getCaption() {
        return this.caption;
    }

    @JsonProperty("reply_markup")
    public String getReplyMarkupJson() throws JsonProcessingException {
        if (this.replyMarkup == null) {
            return null;
        }
        return JsonUtil.getObjectMapper().writeValueAsString(this.replyMarkup);
    }

    /**
     * @return the replyMarkup
     */
    @JsonIgnore
    public ReplyMarkup getReplyMarkup() {
        return this.replyMarkup;
    }

}