• Home
• io.sgr.telegram
• telegram-bot.api
• 1.1.1
• source code
• BotApi.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.sgr.telegram.bot.api.BotApi Maven / Gradle / Ivy

/*
 * 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;

import static io.sgr.telegram.bot.api.utils.TelegramUtils.verifyToken;

import io.sgr.telegram.bot.api.http.DefaultCallAdapterFactory;
import io.sgr.telegram.bot.api.models.Chat;
import io.sgr.telegram.bot.api.models.ChatMember;
import io.sgr.telegram.bot.api.models.Message;
import io.sgr.telegram.bot.api.models.Update;
import io.sgr.telegram.bot.api.models.User;
import io.sgr.telegram.bot.api.models.WebhookInfo;
import io.sgr.telegram.bot.api.models.game.GameHighScore;
import io.sgr.telegram.bot.api.models.game.http.GetGameScorePayload;
import io.sgr.telegram.bot.api.models.game.http.SendGamePayload;
import io.sgr.telegram.bot.api.models.game.http.SetGameScorePayload;
import io.sgr.telegram.bot.api.models.http.AnswerCallbackQueryPayload;
import io.sgr.telegram.bot.api.models.http.AnswerInlineQueryPayload;
import io.sgr.telegram.bot.api.models.http.DeleteMessagePayload;
import io.sgr.telegram.bot.api.models.http.EditMessageCaptionPayload;
import io.sgr.telegram.bot.api.models.http.EditMessageReplyMarkupPayload;
import io.sgr.telegram.bot.api.models.http.EditMessageTextPayload;
import io.sgr.telegram.bot.api.models.http.ForwardMessagePayload;
import io.sgr.telegram.bot.api.models.http.GetUpdatesPayload;
import io.sgr.telegram.bot.api.models.http.SendMessagePayload;
import io.sgr.telegram.bot.api.utils.JsonUtil;
import okhttp3.OkHttpClient;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import retrofit2.Retrofit;
import retrofit2.converter.jackson.JacksonConverterFactory;
import retrofit2.converter.scalars.ScalarsConverterFactory;
import retrofit2.http.Body;
import retrofit2.http.Field;
import retrofit2.http.FormUrlEncoded;
import retrofit2.http.POST;

import java.util.List;
import java.util.Locale;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;

/**
 * @author SgrAlpha
 */
public interface BotApi {

    @POST("getMe")
    CompletableFuture getMe();

    @POST("getWebhookInfo")
    CompletableFuture getWebhookInfo();

    @POST("getUpdates")
    CompletableFuture> getUpdates(@Body GetUpdatesPayload payload);

    @POST("sendMessage")
    CompletableFuture sendMessage(@Body SendMessagePayload payload);

    @POST("forwardMessage")
    CompletableFuture forwardMessage(@Body ForwardMessagePayload payload);

    @POST("editMessageText")
    CompletableFuture editMessageText(@Body EditMessageTextPayload payload);

    @POST("editMessageCaption")
    CompletableFuture editMessageCaption(@Body EditMessageCaptionPayload payload);

    @POST("editMessageReplyMarkup")
    CompletableFuture editMessageReplyMarkup(@Body EditMessageReplyMarkupPayload payload);

    @POST("deleteMessage")
    CompletableFuture deleteMessage(@Body DeleteMessagePayload payload);

    @POST("answerInlineQuery")
    CompletableFuture answerInlineQuery(@Body AnswerInlineQueryPayload payload);

    @FormUrlEncoded
    @POST("kickChatMember")
    CompletableFuture kickChatMember(@Field("chat_id") String chatId, @Field("user_id") long userId);

    @FormUrlEncoded
    @POST("kickChatMember")
    CompletableFuture kickChatMember(@Field("chat_id") long chatId, @Field("user_id") long userId);

    @FormUrlEncoded
    @POST("unbanChatMember")
    CompletableFuture unbanChatMember(@Field("chat_id") String chatId, @Field("user_id") long userId);

    @FormUrlEncoded
    @POST("unbanChatMember")
    CompletableFuture unbanChatMember(@Field("chat_id") long chatId, @Field("user_id") long userId);

    @FormUrlEncoded
    @POST("restrictChatMember")
    CompletableFuture restrictChatMember(@Field("chat_id") String chatId, @Field("user_id") long userId, @Field("until_date") long untilDate,
            @Field("can_send_messages") Boolean canSendMessage, @Field("can_send_media_messages") Boolean canSendMediaMessage,
            @Field("can_send_other_messages") Boolean canSendOtherMessage, @Field("can_add_web_page_previews") Boolean canAddWebPagePreviews);

    @FormUrlEncoded
    @POST("restrictChatMember")
    CompletableFuture restrictChatMember(@Field("chat_id") long chatId, @Field("user_id") long userId, @Field("until_date") long untilDate,
            @Field("can_send_messages") Boolean canSendMessage, @Field("can_send_media_messages") Boolean canSendMediaMessage,
            @Field("can_send_other_messages") Boolean canSendOtherMessage, @Field("can_add_web_page_previews") Boolean canAddWebPagePreviews);

    @FormUrlEncoded
    @POST("promoteChatMember")
    CompletableFuture promoteChatMember(@Field("chat_id") String chatId, @Field("user_id") long userId,
            @Field("can_change_info") Boolean canChangeInfo, @Field("can_post_messages") Boolean canPostMessage,
            @Field("can_edit_messages") Boolean canEditMessage, @Field("can_delete_messages") Boolean canDeleteMessage,
            @Field("can_invite_users") Boolean canInviteUsers, @Field("can_restrict_members") Boolean canRestrictMembers,
            @Field("can_pin_messages") Boolean canPinMessage, @Field("can_promote_members") Boolean canPromoteMembers);

    @FormUrlEncoded
    @POST("promoteChatMember")
    CompletableFuture promoteChatMember(@Field("chat_id") long chatId, @Field("user_id") long userId,
            @Field("can_change_info") Boolean canChangeInfo, @Field("can_post_messages") Boolean canPostMessage,
            @Field("can_edit_messages") Boolean canEditMessage, @Field("can_delete_messages") Boolean canDeleteMessage,
            @Field("can_invite_users") Boolean canInviteUsers, @Field("can_restrict_members") Boolean canRestrictMembers,
            @Field("can_pin_messages") Boolean canPinMessage, @Field("can_promote_members") Boolean canPromoteMembers);

    @FormUrlEncoded
    @POST("exportChatInviteLink")
    CompletableFuture exportChatInviteLink(@Field("chat_id") String chatId);

    @FormUrlEncoded
    @POST("exportChatInviteLink")
    CompletableFuture exportChatInviteLink(@Field("chat_id") long chatId);

    @FormUrlEncoded
    @POST("deleteChatPhoto")
    CompletableFuture deleteChatPhoto(@Field("chat_id") String chatId);

    @FormUrlEncoded
    @POST("deleteChatPhoto")
    CompletableFuture deleteChatPhoto(@Field("chat_id") long chatId);

    @FormUrlEncoded
    @POST("setChatTitle")
    CompletableFuture setChatTitle(@Field("chat_id") String chatId, @Field("title") String title);

    @FormUrlEncoded
    @POST("setChatTitle")
    CompletableFuture setChatTitle(@Field("chat_id") long chatId, @Field("title") String title);

    @FormUrlEncoded
    @POST("setChatDescription")
    CompletableFuture setChatDescription(@Field("chat_id") String chatId, @Field("description") String description);

    @FormUrlEncoded
    @POST("setChatDescription")
    CompletableFuture setChatDescription(@Field("chat_id") long chatId, @Field("description") String description);

    @FormUrlEncoded
    @POST("pinChatMessage")
    CompletableFuture pinChatMessage(@Field("chat_id") String chatId, @Field("message_id") long messageId);

    @FormUrlEncoded
    @POST("pinChatMessage")
    CompletableFuture pinChatMessage(@Field("chat_id") long chatId, @Field("message_id") long messageId);

    @FormUrlEncoded
    @POST("unpinChatMessage")
    CompletableFuture unpinChatMessage(@Field("chat_id") String chatId);

    @FormUrlEncoded
    @POST("unpinChatMessage")
    CompletableFuture unpinChatMessage(@Field("chat_id") long chatId);

    @FormUrlEncoded
    @POST("leaveChat")
    CompletableFuture leaveChat(@Field("chat_id") String chatId);

    @FormUrlEncoded
    @POST("leaveChat")
    CompletableFuture leaveChat(@Field("chat_id") long chatId);

    @FormUrlEncoded
    @POST("getChat")
    CompletableFuture getChat(@Field("chat_id") String chatId);

    @FormUrlEncoded
    @POST("getChat")
    CompletableFuture getChat(@Field("chat_id") long chatId);

    @FormUrlEncoded
    @POST("getChatAdministrators")
    CompletableFuture> getChatAdministrators(@Field("chat_id") String chatId);

    @FormUrlEncoded
    @POST("getChatAdministrators")
    CompletableFuture> getChatAdministrators(@Field("chat_id") long chatId);

    @FormUrlEncoded
    @POST("getChatMembersCount")
    CompletableFuture getChatMembersCount(@Field("chat_id") String chatId);

    @FormUrlEncoded
    @POST("getChatMembersCount")
    CompletableFuture getChatMembersCount(@Field("chat_id") long chatId);

    @FormUrlEncoded
    @POST("getChatMember")
    CompletableFuture getChatMember(@Field("chat_id") String chatId, @Field("user_id") long userId);

    @FormUrlEncoded
    @POST("getChatMember")
    CompletableFuture getChatMember(@Field("chat_id") long chatId, @Field("user_id") long userId);

    @POST("answerCallbackQuery")
    CompletableFuture answerCallbackQuery(@Body AnswerCallbackQueryPayload payload);

    @POST("sendGame")
    CompletableFuture sendGame(@Body SendGamePayload payload);

    @POST("setGameScore")
    CompletableFuture setGameScoreByBot(@Body SetGameScorePayload payload);

    @POST("setGameScore")
    CompletableFuture setGameScore(@Body SetGameScorePayload payload);

    @POST("getGameHighScores")
    CompletableFuture> getGameHighScores(@Body GetGameScorePayload payload);

    static BotApiBuilder newBuilder(String botApiToken) {
        return new BotApiBuilder(botApiToken);
    }

    /**
     * @author SgrAlpha
     */
    class BotApiBuilder {

        private static final String BASE_URL_FORMAT = "https://api.telegram.org/bot%s/";

        private final String botApiToken;
        private boolean retry = false;
        private Logger logger;

        BotApiBuilder(final String botApiToken) {
            verifyToken(botApiToken);
            this.botApiToken = botApiToken;
        }

        /**
         * Enable retry
         *
         * @return the builder
         */
        public BotApiBuilder enableRetry() {
            this.retry = true;
            return this;
        }

        /**
         * @param logger the logger
         *
         * @return the builder
         */
        public BotApiBuilder setLogger(final Logger logger) {
            this.logger = logger;
            return this;
        }

        /**
         * @return the bot API client
         */
        public BotApi build() {
            Retrofit.Builder retrofitBuilder = new Retrofit.Builder()
                    .baseUrl(String.format(Locale.ENGLISH, BASE_URL_FORMAT, botApiToken))
                    .addConverterFactory(ScalarsConverterFactory.create())
                    .addConverterFactory(JacksonConverterFactory.create(JsonUtil.getObjectMapper()))
                    .addCallAdapterFactory(new DefaultCallAdapterFactory(retry, Optional.ofNullable(logger).orElse(LoggerFactory.getLogger(BotApi.class))));
            OkHttpClient.Builder clientBuilder = new OkHttpClient().newBuilder()
                    .retryOnConnectionFailure(true)
                    .connectTimeout(5, TimeUnit.MINUTES)
                    .readTimeout(5, TimeUnit.MINUTES)
                    .writeTimeout(5, TimeUnit.MINUTES);
            retrofitBuilder.client(clientBuilder.build());
            return retrofitBuilder.build().create(BotApi.class);
        }

    }

}