1
0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-11-14 20:33:47 +00:00
Type-safe library for work with Telegram Bot API
Go to file
2021-09-21 21:36:52 +06:00
.github Update packages_publishing.yml 2021-05-30 01:20:25 +06:00
badges add link to bot template 2020-11-08 18:58:52 +06:00
docs Update gradle.properties 2021-09-16 10:09:28 +06:00
gradle/wrapper update gradle wrapper 2021-08-22 11:09:35 +06:00
resources update structure schema 2021-08-22 12:10:05 +06:00
tgbotapi buildable except of jvm tests 2021-05-29 15:34:14 +06:00
tgbotapi.core add kdocs to LocationContent 2021-09-21 18:57:12 +06:00
tgbotapi.extensions.api TelegramBot#answer 2021-09-14 15:51:05 +06:00
tgbotapi.extensions.behaviour_builder factory functions of BehaviourContextReceiver's, updates in kdocs and operations for these receivers filters 2021-09-21 21:36:52 +06:00
tgbotapi.extensions.utils Fix of #464 2021-09-21 20:50:59 +06:00
_config.yml Set theme jekyll-theme-cayman 2020-01-06 22:44:23 +06:00
.gitignore add publication of github release via changelog 2020-09-22 18:04:10 +06:00
.travis.yml update travis config 2020-10-22 19:19:55 +06:00
build.gradle fix of build 2021-04-17 14:36:23 +06:00
changelog_info_retriever update changelog parser 2020-10-04 17:43:25 +06:00
CHANGELOG.md factory functions of BehaviourContextReceiver's, updates in kdocs and operations for these receivers filters 2021-09-21 21:36:52 +06:00
CONTRIBUTING.md Create CONTRIBUTING.md 2020-10-02 13:10:01 +06:00
gradle.properties Update gradle.properties 2021-09-21 16:23:47 +06:00
gradlew init 2018-12-26 16:21:52 +08:00
gradlew.bat init 2018-12-26 16:21:52 +08:00
LICENSE Update LICENSE 2020-02-19 22:29:53 +06:00
README.md small updates in readmes 2021-08-22 10:59:01 +06:00
renovate.json Add renovate.json 2020-08-12 20:21:10 +00:00
settings.gradle fix dokka config 2021-03-16 22:33:53 +06:00
TelegramBotAPI.drawio update structure schema 2021-08-22 12:10:05 +06:00

Participate in our common survey ☺

TelegramBotAPI

Table of contents generated with markdown-toc

Hello! This is a set of libraries for working with Telegram Bot API.

Common info Awesome Kotlin Badge Build Status Small survey
Useful links Chat in Telegram Create bot KDocs Examples, Mini tutorial
TelegramBotAPI Core status Maven Central
TelegramBotAPI API Extensions status Maven Central
TelegramBotAPI Util Extensions status Maven Central
TelegramBotAPI Behaviour Builder Extensions status Maven Central
TelegramBotAPI All status Maven Central

Examples

There are several things you need to do to launch examples below:

  • Add mavenCentral() to your project repositories
  • Add dependency implementation "dev.inmo:tgbotapi:$tgbotapi_version"
    • Replace tgbotapi_version with exact version (see last one in the table above) or put variable with this name in project
    • Alternative variant for maven here

More including instructions available here. Other configuration examples:

Most common example

suspend fun main() {
  val bot = telegramBot(TOKEN)

  bot.buildBehaviour {
    println(getMe())
  
    onCommand("start") {
      reply(it, "Hi:)")
    }
  }.join()
}

In this example you will see information about this bot at the moment of starting and answer with Hi:) every time it gets message /start

Handling only last messages

suspend fun main() {
  val bot = telegramBot(TOKEN)

  val flowsUpdatesFilter = FlowsUpdatesFilter()
  bot.buildBehaviour(flowUpdatesFilter = flowsUpdatesFilter) {
    println(getMe())
  
    onCommand("start") {
      reply(it, "Hi:)")
    }

    retrieveAccumulatedUpdates(this).join()
  }
}

The main difference with the previous example is that bot will get only last updates (accumulated before bot launch and maybe some updates it got after launch)

Build a little bit more complex behaviour

suspend fun main() {
  val bot = telegramBot(TOKEN)

  bot.buildBehaviour {
    println(getMe())

    val nameReplyMarkup = ReplyKeyboardMarkup(
      matrix {
        row {
          +SimpleKeyboardButton("nope")
        }
      }
    )
    onCommand("start") {
      val photo = waitPhoto(
        SendTextMessage(it.chat.id, "Send me your photo please")
      ).first()

      val name = waitText(
        SendTextMessage(
          it.chat.id,
          "Send me your name or choose \"nope\"",
          replyMarkup = nameReplyMarkup
        )
      ).first().text.takeIf { it != "nope" }

      sendPhoto(
        it.chat,
        photo.mediaCollection,
        entities = buildEntities {
          if (name != null) regular(name) // may be collapsed up to name ?.let(::regular)
        }
      )
    }
  }.join()
}

More examples

You may find examples in this project. Besides, you are always welcome in our wiki and chat.