org.isuper.telegram.api

Interface TelegramBotApi

public interface TelegramBotApi

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<ApiResponse<Boolean>>	answerInlineQuery(String apiToken, AnswerInlineQueryPayload payload)
retrofit2.Call<ApiResponse<Message>>	editMessageCaption(String apiToken, EditMessageCaptionPayload payload)
retrofit2.Call<ApiResponse<Message>>	editMessageReplyMarkup(String apiToken, EditMessageReplyMarkupPayload payload)
retrofit2.Call<ApiResponse<Message>>	editMessageText(String apiToken, EditMessageTextPayload payload)
retrofit2.Call<ApiResponse<Message>>	forwardMessage(String apiToken, ForwardMessagePayload payload)
retrofit2.Call<ApiResponse<Chat>>	getChat(String apiToken, long chatId)
retrofit2.Call<ApiResponse<Chat>>	getChat(String apiToken, String chatId)
retrofit2.Call<ApiResponse<List<ChatMember>>>	getChatAdministrators(String apiToken, long chatId)
retrofit2.Call<ApiResponse<List<ChatMember>>>	getChatAdministrators(String apiToken, String chatId)
retrofit2.Call<ApiResponse<ChatMember>>	getChatMember(String apiToken, long chatId, long userId)
retrofit2.Call<ApiResponse<ChatMember>>	getChatMember(String apiToken, String chatId, long userId)
retrofit2.Call<ApiResponse<Integer>>	getChatMembersCount(String apiToken, long chatId)
retrofit2.Call<ApiResponse<Integer>>	getChatMembersCount(String apiToken, String chatId)
retrofit2.Call<ApiResponse<User>>	getMe(String apiToken)
retrofit2.Call<ApiResponse<List<Update>>>	getUpdates(String apiToken, GetUpdatesPayload payload)
retrofit2.Call<ApiResponse<Boolean>>	kickChatMember(String apiToken, long chatId, long userId)
retrofit2.Call<ApiResponse<Boolean>>	kickChatMember(String apiToken, String chatId, long userId)
retrofit2.Call<ApiResponse<Message>>	sendMessage(String apiToken, SendMessagePayload payload)
retrofit2.Call<ApiResponse<Boolean>>	unbanChatMember(String apiToken, long chatId, long userId)
retrofit2.Call<ApiResponse<Boolean>>	unbanChatMember(String apiToken, String chatId, long userId)

Method Detail

getMe

@POST(value="/bot{apiToken}/getMe")
retrofit2.Call<ApiResponse<User>> getMe(@Path(value="apiToken")
                                                                            String apiToken)

getUpdates

@POST(value="/bot{apiToken}/getUpdates")
retrofit2.Call<ApiResponse<List<Update>>> getUpdates(@Path(value="apiToken")
                                                                                              String apiToken,
                                                                                              @Body
                                                                                              GetUpdatesPayload payload)

sendMessage

@POST(value="/bot{apiToken}/sendMessage")
retrofit2.Call<ApiResponse<Message>> sendMessage(@Path(value="apiToken")
                                                                                           String apiToken,
                                                                                           @Body
                                                                                           SendMessagePayload payload)

forwardMessage

@POST(value="/bot{apiToken}/forwardMessage")
retrofit2.Call<ApiResponse<Message>> forwardMessage(@Path(value="apiToken")
                                                                                                 String apiToken,
                                                                                                 @Body
                                                                                                 ForwardMessagePayload payload)

editMessageText

@POST(value="/bot{apiToken}/editMessageText")
retrofit2.Call<ApiResponse<Message>> editMessageText(@Path(value="apiToken")
                                                                                                   String apiToken,
                                                                                                   @Body
                                                                                                   EditMessageTextPayload payload)

editMessageCaption

@POST(value="/bot{apiToken}/editMessageCaption")
retrofit2.Call<ApiResponse<Message>> editMessageCaption(@Path(value="apiToken")
                                                                                                         String apiToken,
                                                                                                         @Body
                                                                                                         EditMessageCaptionPayload payload)

editMessageReplyMarkup

@POST(value="/bot{apiToken}/editMessageReplyMarkup")
retrofit2.Call<ApiResponse<Message>> editMessageReplyMarkup(@Path(value="apiToken")
                                                                                                                 String apiToken,
                                                                                                                 @Body
                                                                                                                 EditMessageReplyMarkupPayload payload)

answerInlineQuery

@POST(value="/bot{apiToken}/answerInlineQuery")
retrofit2.Call<ApiResponse<Boolean>> answerInlineQuery(@Path(value="apiToken")
                                                                                                       String apiToken,
                                                                                                       @Body
                                                                                                       AnswerInlineQueryPayload payload)

kickChatMember

@FormUrlEncoded
 @POST(value="/bot{apiToken}/kickChatMember")
retrofit2.Call<ApiResponse<Boolean>> kickChatMember(@Path(value="apiToken")
                                                                                                                  String apiToken,
                                                                                                                  @Field(value="chat_id")
                                                                                                                  String chatId,
                                                                                                                  @Field(value="user_id")
                                                                                                                  long userId)

kickChatMember

@FormUrlEncoded
 @POST(value="/bot{apiToken}/kickChatMember")
retrofit2.Call<ApiResponse<Boolean>> kickChatMember(@Path(value="apiToken")
                                                                                                                  String apiToken,
                                                                                                                  @Field(value="chat_id")
                                                                                                                  long chatId,
                                                                                                                  @Field(value="user_id")
                                                                                                                  long userId)

unbanChatMember

@FormUrlEncoded
 @POST(value="/bot{apiToken}/unbanChatMember")
retrofit2.Call<ApiResponse<Boolean>> unbanChatMember(@Path(value="apiToken")
                                                                                                                    String apiToken,
                                                                                                                    @Field(value="chat_id")
                                                                                                                    String chatId,
                                                                                                                    @Field(value="user_id")
                                                                                                                    long userId)

unbanChatMember

@FormUrlEncoded
 @POST(value="/bot{apiToken}/unbanChatMember")
retrofit2.Call<ApiResponse<Boolean>> unbanChatMember(@Path(value="apiToken")
                                                                                                                    String apiToken,
                                                                                                                    @Field(value="chat_id")
                                                                                                                    long chatId,
                                                                                                                    @Field(value="user_id")
                                                                                                                    long userId)

getChat

@FormUrlEncoded
 @POST(value="/bot{apiToken}/getChat")
retrofit2.Call<ApiResponse<Chat>> getChat(@Path(value="apiToken")
                                                                                                 String apiToken,
                                                                                                 @Field(value="chat_id")
                                                                                                 String chatId)

getChat

@FormUrlEncoded
 @POST(value="/bot{apiToken}/getChat")
retrofit2.Call<ApiResponse<Chat>> getChat(@Path(value="apiToken")
                                                                                                 String apiToken,
                                                                                                 @Field(value="chat_id")
                                                                                                 long chatId)

getChatAdministrators

@FormUrlEncoded
 @POST(value="/bot{apiToken}/getChatAdministrators")
retrofit2.Call<ApiResponse<List<ChatMember>>> getChatAdministrators(@Path(value="apiToken")
                                                                                                                                         String apiToken,
                                                                                                                                         @Field(value="chat_id")
                                                                                                                                         String chatId)

getChatAdministrators

@FormUrlEncoded
 @POST(value="/bot{apiToken}/getChatAdministrators")
retrofit2.Call<ApiResponse<List<ChatMember>>> getChatAdministrators(@Path(value="apiToken")
                                                                                                                                         String apiToken,
                                                                                                                                         @Field(value="chat_id")
                                                                                                                                         long chatId)

getChatMembersCount

@FormUrlEncoded
 @POST(value="/bot{apiToken}/getChatMembersCount")
retrofit2.Call<ApiResponse<Integer>> getChatMembersCount(@Path(value="apiToken")
                                                                                                                            String apiToken,
                                                                                                                            @Field(value="chat_id")
                                                                                                                            String chatId)

getChatMembersCount

@FormUrlEncoded
 @POST(value="/bot{apiToken}/getChatMembersCount")
retrofit2.Call<ApiResponse<Integer>> getChatMembersCount(@Path(value="apiToken")
                                                                                                                            String apiToken,
                                                                                                                            @Field(value="chat_id")
                                                                                                                            long chatId)

getChatMember

@FormUrlEncoded
 @POST(value="/bot{apiToken}/getChatMember")
retrofit2.Call<ApiResponse<ChatMember>> getChatMember(@Path(value="apiToken")
                                                                                                                   String apiToken,
                                                                                                                   @Field(value="chat_id")
                                                                                                                   String chatId,
                                                                                                                   @Field(value="user_id")
                                                                                                                   long userId)

getChatMember

@FormUrlEncoded
 @POST(value="/bot{apiToken}/getChatMember")
retrofit2.Call<ApiResponse<ChatMember>> getChatMember(@Path(value="apiToken")
                                                                                                                   String apiToken,
                                                                                                                   @Field(value="chat_id")
                                                                                                                   long chatId,
                                                                                                                   @Field(value="user_id")
                                                                                                                   long userId)