This way will be very useful for cases when you need to configure something via external configuration (from file on startup or via some parameter from requests, for example):
-val schedule = "5 * * * *"
-val scheduler = buildSchedule(schedule)
-
-scheduler.asFlow().onEach {
- // this block will be called every minute at 5 seconds
-}.launchIn(someCoroutineScope)
-val schedule = "5 * * * *"
+val scheduler = buildSchedule(schedule)
+
+scheduler.asFlow().onEach {
+ // this block will be called every minute at 5 seconds
+}.launchIn(someCoroutineScope)
+In case of usage builder (lets call it lambda way), you will be able to configure scheduler in more type-safe way:
val scheduler = buildSchedule {
- seconds {
- at(5)
- }
-}
-
-scheduler.asFlow().onEach {
- // this block will be called every minute at 5 seconds
-}.launchIn(someCoroutineScope)
-val scheduler = buildSchedule {
+ seconds {
+ at(5)
+ }
+}
+
+scheduler.asFlow().onEach {
+ // this block will be called every minute at 5 seconds
+}.launchIn(someCoroutineScope)
+You are always able to use your own realisation of scheduler. For example:
-class RandomScheduler : KronScheduler {
- override suspend fun next(relatively: DateTime): DateTime {
- return relatively + DateTimeSpan(seconds = Random.nextInt() % 60)
- }
-}
-class RandomScheduler : KronScheduler {
+ override suspend fun next(relatively: DateTime): DateTime {
+ return relatively + DateTimeSpan(seconds = Random.nextInt() % 60)
+ }
+}
+In the example above we have created RandomScheduler, which will return random next time in range 0-60 seconds since relatively argument.
Example with almost same description:
-/-------------------- (0-59) ············ Seconds
-| /------------------ (0-59) ············ Minutes
-| | /---------------- (0-23) ············ Hours
-| | | /-------------- (0-30) ············ Days of months
-| | | | /------------ (0-11) ············ Months
-| | | | | /---------- (optional, any int) Year
-| | | | | | /-------- (optional) ········ Timezone offset
-| | | | | | | /----- (optional, 0-6) ··· Week days
-| | | | | | | | /-- (optional, 0-999) · Milliseconds (0 by default)
-* * * * * * 0o *w 0ms
-/-------------------- (0-59) ············ Seconds
+| /------------------ (0-59) ············ Minutes
+| | /---------------- (0-23) ············ Hours
+| | | /-------------- (0-30) ············ Days of months
+| | | | /------------ (0-11) ············ Months
+| | | | | /---------- (optional, any int) Year
+| | | | | | /-------- (optional) ········ Timezone offset
+| | | | | | | /----- (optional, 0-6) ··· Week days
+| | | | | | | | /-- (optional, 0-999) · Milliseconds (0 by default)
+* * * * * * 0o *w 0ms
+Years, timezone, week days and milliseconds are optional settings. Next snippets are equal:
-*/15 * * * *
-*/15 * * * * * // with year
-*/15 * * * * * 0ms // with year and milliseconds
-Currently the library support next syntax for date/time elements:
Ranges are working like common rangeTo (or ..) in kotlin:
0-5 * * * *
-In the example above scheduler will trigger every second from the beginning of the minute up to fifth second of minute.
Start/step is a little bit more complicated syntax. It means start from the first element, repeat triggering every second element. Examples:
5/15 * * * *
-Means that each minute starting from fifth second it will repeat triggering every fifteenth second: 5, 20, 35, 50.
Every is more simple syntax and could be explained as a shortcut for 0/{int}. Example:
*/15 * * * *
-Means that each minute it will repeat triggering every fifteenth second: 0, 15, 30, 45.
The most simple syntax. It means, that scheduler will call triggering every time when element was reached:
-15 * * * *
-Means that each minute scheduler will call triggering at the fifteenth second.
All the previous elements can be combined with listing. Lets just see several examples:
-0,10 * * * *
-Will trigger every minute at the 0 and 10 seconds (see Just at the time)
0-5,10 * * * *
-Will trigger every minute from 0 to 5 seconds and at the 10 seconds (see Ranges)
First of all, this library will be useful for long uptime applications which have some tasks to do from time to time.
In two words, you should call buildSchedule or createSimpleScheduler:
buildSchedule("5 * * * *").asFlow().collect { /* do something */ }
-You can read more about syntax in String format section.
diff --git a/krontab/introduction/how-to-use.html b/krontab/introduction/how-to-use.html index 31921d7..18b13e7 100644 --- a/krontab/introduction/how-to-use.html +++ b/krontab/introduction/how-to-use.html @@ -1294,15 +1294,15 @@ You always able to create your own scheduler. In this section will be presented different ways and examples around standardCronDateTimeScheduler builders buildSchedule. You can read about schedulers in KrontabScheduler
Currently, buildSchedule is the recommended start point for every scheduler. Usually, it is look like:
val scheduler = buildSchedule("5 * * * *")
-Or:
-val scheduler = buildSchedule {
- seconds {
- at(5)
- }
-}
-On the top of any KronScheduler currently there are several groups of extensions:
To use this library, you will need to include MavenCentral repository in you project
mavenCentral()
-Next snippets must be placed into your dependencies part of build.gradle (for gradle) or pom.xml (for maven).
implementation "dev.inmo:krontab:$krontab_version"
-<dependency>
- <groupId>dev.inmo</groupId>
- <artifactId>krontab</artifactId>
- <version>${krontab_version}</version>
-</dependency>
-<dependency>
+ <groupId>dev.inmo</groupId>
+ <artifactId>krontab</artifactId>
+ <version>${krontab_version}</version>
+</dependency>
+String, but you m
So, when you want to log some expected exception, there are three common ways to do it:
-val logger = KSLog.default
-
-// with callback
-logger.info(tag, throwable) {
- "Some your message for this event"
-}
-
-// with suspendable callback
-logger.infoS(tag, throwable) {
- withContext(Dispatchers.Default) {
- "Some your message for this event"
- }
-}
-
-// Just with message
-logger.info("Some your message for this event", throwable)
-
-// With message and tag as strings
-logger.info(tag, "Some your message for this event", throwable)
-val logger = KSLog.default
+
+// with callback
+logger.info(tag, throwable) {
+ "Some your message for this event"
+}
+
+// with suspendable callback
+logger.infoS(tag, throwable) {
+ withContext(Dispatchers.Default) {
+ "Some your message for this event"
+ }
+}
+
+// Just with message
+logger.info("Some your message for this event", throwable)
+
+// With message and tag as strings
+logger.info(tag, "Some your message for this event", throwable)
+Of course, any of this calls can be shortenned:
-val logger = KSLog.default
-
-// with callback
-logger.i(tag, throwable) {
- "Some your message for this event"
-}
-
-// with suspendable callback
-logger.iS(tag, throwable) {
- withContext(Dispatchers.Default) {
- "Some your message for this event"
- }
-}
-
-// Just with message
-logger.i("Some your message for this event", throwable)
-
-// With message and tag as strings
-logger.i(tag, "Some your message for this event", throwable)
-val logger = KSLog.default
+
+// with callback
+logger.i(tag, throwable) {
+ "Some your message for this event"
+}
+
+// with suspendable callback
+logger.iS(tag, throwable) {
+ withContext(Dispatchers.Default) {
+ "Some your message for this event"
+ }
+}
+
+// Just with message
+logger.i("Some your message for this event", throwable)
+
+// With message and tag as strings
+logger.i(tag, "Some your message for this event", throwable)
+There is special shortcat - for base performLog. In that case the only change is that you will require to pass the LogLevel more obviously:
val logger = KSLog.default
-
-// with callback
-logger.log(LogLevel.INFO, tag, throwable) {
- "Some your message for this event"
-}
-
-// with suspendable callback
-logger.logS(LogLevel.INFO, tag, throwable) {
- withContext(Dispatchers.Default) {
- "Some your message for this event"
- }
-}
-
-// Just with message
-logger.log(LogLevel.INFO, "Some your message for this event", throwable)
-
-// With message and tag as strings
-logger.log(LogLevel.INFO, tag, "Some your message for this event", throwable)
-val logger = KSLog.default
+
+// with callback
+logger.log(LogLevel.INFO, tag, throwable) {
+ "Some your message for this event"
+}
+
+// with suspendable callback
+logger.logS(LogLevel.INFO, tag, throwable) {
+ withContext(Dispatchers.Default) {
+ "Some your message for this event"
+ }
+}
+
+// Just with message
+logger.log(LogLevel.INFO, "Some your message for this event", throwable)
+
+// With message and tag as strings
+logger.log(LogLevel.INFO, tag, "Some your message for this event", throwable)
+OR
-val logger = KSLog.default
-
-// with callback
-logger.l(LogLevel.INFO, tag, throwable) {
- "Some your message for this event"
-}
-
-// with suspendable callback
-logger.lS(LogLevel.INFO, tag, throwable) {
- withContext(Dispatchers.Default) {
- "Some your message for this event"
- }
-}
-
-// Just with message
-logger.l(LogLevel.INFO, "Some your message for this event", throwable)
-
-// With message and tag as strings
-logger.l(LogLevel.INFO, tag, "Some your message for this event", throwable)
-val logger = KSLog.default
+
+// with callback
+logger.l(LogLevel.INFO, tag, throwable) {
+ "Some your message for this event"
+}
+
+// with suspendable callback
+logger.lS(LogLevel.INFO, tag, throwable) {
+ withContext(Dispatchers.Default) {
+ "Some your message for this event"
+ }
+}
+
+// Just with message
+logger.l(LogLevel.INFO, "Some your message for this event", throwable)
+
+// With message and tag as strings
+logger.l(LogLevel.INFO, tag, "Some your message for this event", throwable)
+
implementation "dev.inmo:kslog:$kslog_version"
-implementation("dev.inmo:kslog:$kslog_version")
-<dependency>
- <groupId>dev.inmo</groupId>
- <artifactId>kslog</artifactId>
- <version>${kslog_version}</version>
-</dependency>
-<dependency>
+ <groupId>dev.inmo</groupId>
+ <artifactId>kslog</artifactId>
+ <version>${kslog_version}</version>
+</dependency>
+The main point in setup in your code is to setup default logger:
-KSLog.default = KSLog("defaultTag")
-You may use custom messageFormatter in any of KSLog factory to customize output of KSLog logging. For example:
KSLog(
- "loggingWithCustomFormat",
- messageFormatter = { level, tag, message, throwable ->
- println("[$level] $tag - $message: $throwable")
- }
-)
-KSLog(
+ "loggingWithCustomFormat",
+ messageFormatter = { level, tag, message, throwable ->
+ println("[$level] $tag - $message: $throwable")
+ }
+)
+Additionally you may use one of several different settings:
minLoggingLevel - minimal logging level for the log which will be logged. The order of log level is next:firstLevel,secondLevel,otherLevels - as levels, but vararg :)In case you are passing minLoggingLevel, the level and more important levels will be passed to logs. For example, when you are settings up your logger as in next snippet:
val logger = KSLog(
- "exampleTag",
- minLoggingLevel = LogLevel.INFO
-)
-The next levels will be logged with logger:
INFOIt is logger which will call incoming performLogCallback on each logging. This logger can be create simply with one callback:
KSLog { level, tag, message, throwable ->
- println("[$level] $tag - $message: $throwable")
-}
-It is simple value class which can be used for zero-cost usage of some tag and calling for KSLog.default. For example, if you will create tag logger with next code:
val logger = TagLogger("tagLoggerTag")
-The logger will call KSLog.default with the tag tagLoggerTag on each calling of logging.
This pretty simple logger will call its fallbackLogger only in cases when incoming messageFilter will return true for logging:
val baseLogger = KSLog("base") // log everything with the tag `base` if not set other
-val filtered = baseLogger.filtered { _, t, _ ->
- t == "base"
-}
-val baseLogger = KSLog("base") // log everything with the tag `base` if not set other
+val filtered = baseLogger.filtered { _, t, _ ->
+ t == "base"
+}
+In the example above baseLogger will perform logs in two ways: when it has been called directly or when we call log performing with the tag "base" or null. Besides, you can see there extension filtered which allow to create FilterKSLog logger with simple lambda.
This logger accepts map of types with the target loggers. You may build this logger with the special simple DSL:
-val baseLogger = KSLog("base") // log everything with the tag `base` if not set other
-val typed = buildTypedLogger {
- on<Int>(baseLogger) // log all ints to the baseLogger
- on<Float> { _, _, message, _ ->// log all floats to the passed logger
- println(message.toString()) // just print all floats
- }
- default { level, tag, message, throwable ->
- KSLog.performLog(level, tag, message, throwable)
- }
-}
-val baseLogger = KSLog("base") // log everything with the tag `base` if not set other
+val typed = buildTypedLogger {
+ on<Int>(baseLogger) // log all ints to the baseLogger
+ on<Float> { _, _, message, _ ->// log all floats to the passed logger
+ println(message.toString()) // just print all floats
+ }
+ default { level, tag, message, throwable ->
+ KSLog.performLog(level, tag, message, throwable)
+ }
+}
+There are two things which can be useful in your code: logger and logTag extensions. logTag is the autocalculated by your object classname tag. logger extension can be used with applying to any object like in the next snippet:
class SomeClass {
- init {
- logger.i("inited")
- }
-}
-The code above will trigger calling of logging in KSLog.default with level LogLevel.INFO using tag SomeClass and message "inited". As you could have guessed, logger is using TagLogger with logTag underhood and the most expensive operation here is automatical calculation of logTag.
loggerFor JVM you may setup additionally use java loggers as the second parameter of KSLog factory. For example:
KSLog(
- "yourTag"
- Logger.getLogger("YourJavaLoggerName")
-)
-Hello :) It is my libraries docs place and I glad to welcome you here. I hope, this documentation place will help you.
"},{"location":"index.html#projects","title":"Projects","text":"KronScheduler is the simple interface with only one function next. This function optionally get as a parameter DateTime which will be used as start point for the calculation of next trigger time. This function will return the next DateTime when something must happen.
Default realisation (CronDateTimeScheduler) can be created using several ways:
buildSchedule (or createSimpleScheduler) functions with crontab-like syntax parameterbuildSchedule (or SchedulerBuilder object), which using lambda to configure schedulerIn the examples below the result of created scheduler will be the same.
"},{"location":"krontab/describing/krontabscheduler.html#crontab-like-way","title":"Crontab-like way","text":"Crontab-like syntax
See String format for more info about the crontab-line syntax
This way will be very useful for cases when you need to configure something via external configuration (from file on startup or via some parameter from requests, for example):
val schedule = \"5 * * * *\"\nval scheduler = buildSchedule(schedule)\n\nscheduler.asFlow().onEach {\n // this block will be called every minute at 5 seconds\n}.launchIn(someCoroutineScope)\nIn case of usage builder (lets call it lambda way), you will be able to configure scheduler in more type-safe way:
val scheduler = buildSchedule {\n seconds {\n at(5)\n }\n}\n\nscheduler.asFlow().onEach {\n // this block will be called every minute at 5 seconds\n}.launchIn(someCoroutineScope)\nYou are always able to use your own realisation of scheduler. For example:
class RandomScheduler : KronScheduler {\n override suspend fun next(relatively: DateTime): DateTime {\n return relatively + DateTimeSpan(seconds = Random.nextInt() % 60)\n }\n}\nIn the example above we have created RandomScheduler, which will return random next time in range 0-60 seconds since relatively argument.
As in crontab util, this library have almost the same format of string:
Int Any Int 0..6 0..999 Suffix - - - - - - o w ms Optional \u274c \u274c \u274c \u274c \u274c \u2705 \u2705 \u2705 \u2705 Full syntax support \u2705 \u2705 \u2705 \u2705 \u2705 \u2705 \u274c \u2705 \u2705 Position 0 1 2 3 4 Any after months Any after months Any after months Any after months Examples 0, */15, 30 0, */15, 30 0, */15, 22 0, */15, 30 0, */5, 11 0, */15, 30 60o (UTC+1) 0w, */2w, 4w 0ms, */150ms, 300ms Example with almost same description:
/-------------------- (0-59) \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7 Seconds\n| /------------------ (0-59) \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7 Minutes\n| | /---------------- (0-23) \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7 Hours\n| | | /-------------- (0-30) \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7 Days of months\n| | | | /------------ (0-11) \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7 Months\n| | | | | /---------- (optional, any int) Year\n| | | | | | /-------- (optional) \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7 Timezone offset\n| | | | | | | /----- (optional, 0-6) \u00b7\u00b7\u00b7 Week days\n| | | | | | | | /-- (optional, 0-999) \u00b7 Milliseconds (0 by default)\n* * * * * * 0o *w 0ms\nYears, timezone, week days and milliseconds are optional settings. Next snippets are equal:
*/15 * * * *\n*/15 * * * * * // with year\n*/15 * * * * * 0ms // with year and milliseconds\nCurrently the library support next syntax for date/time elements:
{int}-{int} - ranges{int}/{int} - start/step*/{int} - every {int}{int} - just at the time{other_element},{other_element} - listingF or f - first possible valueL or l - last possible value (last day of month, for example)Ranges are working like common rangeTo (or ..) in kotlin:
0-5 * * * *\nIn the example above scheduler will trigger every second from the beginning of the minute up to fifth second of minute.
"},{"location":"krontab/describing/string-format.html#startstep","title":"Start/Step","text":"Start/step is a little bit more complicated syntax. It means start from the first element, repeat triggering every second element. Examples:
5/15 * * * *\nMeans that each minute starting from fifth second it will repeat triggering every fifteenth second: 5, 20, 35, 50.
Every is more simple syntax and could be explained as a shortcut for 0/{int}. Example:
*/15 * * * *\nMeans that each minute it will repeat triggering every fifteenth second: 0, 15, 30, 45.
The most simple syntax. It means, that scheduler will call triggering every time when element was reached:
15 * * * *\nMeans that each minute scheduler will call triggering at the fifteenth second.
"},{"location":"krontab/describing/string-format.html#listing","title":"Listing","text":"All the previous elements can be combined with listing. Lets just see several examples:
0,10 * * * *\nWill trigger every minute at the 0 and 10 seconds (see Just at the time)
0-5,10 * * * *\nWill trigger every minute from 0 to 5 seconds and at the 10 seconds (see Ranges)
0/5 * * * * for every five seconds triggering0/5,L * * * * for every five seconds triggering and on 59 second0/15 30 * * * for every 15th seconds in a half of each hour0/15 30 * * * 500ms for every 15th seconds in a half of each hour when milliseconds equal to 5001 2 3 F,4,L 5 for triggering in near first second of second minute of third hour of first, fifth and last days of may1 2 3 F,4,L 5 60o for triggering in near first second of second minute of third hour of first, fifth and last days of may with timezone UTC+01:001 2 3 F,4,L 5 60o 0-2w for triggering in near first second of second minute of third hour of first, fifth and last days of may in case if it will be in Sunday-Tuesday week days with timezone UTC+01:001 2 3 F,4,L 5 2021 for triggering in near first second of second minute of third hour of first, fifth and last days of may of 2021st year1 2 3 F,4,L 5 2021 60o for triggering in near first second of second minute of third hour of first, fifth and last days of may of 2021st year with timezone UTC+01:001 2 3 F,4,L 5 2021 60o 0-2w for triggering in near first second of second minute of third hour of first, fifth and last days of may of 2021st year if it will be in Sunday-Tuesday week days with timezone UTC+01:001 2 3 F,4,L 5 2021 60o 0-2w 500ms for triggering in near first second of second minute of third hour of first, fifth and last days of may of 2021st year if it will be in Sunday-Tuesday week days with timezone UTC+01:00 when milliseconds will be equal to 500Not very often. It depend on libraries (coroutines, korlibs/klock) updates and on some new awesome, but lightweight, features coming.
"},{"location":"krontab/introduction/faq.html#where-this-library-could-be-useful","title":"Where this library could be useful?","text":"First of all, this library will be useful for long uptime applications which have some tasks to do from time to time.
"},{"location":"krontab/introduction/faq.html#how-to-use-crontab-like-syntax","title":"How to use crontab-like syntax?","text":"In two words, you should call buildSchedule or createSimpleScheduler:
buildSchedule(\"5 * * * *\").asFlow().collect { /* do something */ }\nYou can read more about syntax in String format section.
"},{"location":"krontab/introduction/how-to-use.html","title":"How to use","text":""},{"location":"krontab/introduction/how-to-use.html#previous-pages","title":"Previous pages","text":"buildSchedule","text":"Custom KronScheduler
You always able to create your own scheduler. In this section will be presented different ways and examples around standard CronDateTimeScheduler builders buildSchedule. You can read about schedulers in KrontabScheduler
Currently, buildSchedule is the recommended start point for every scheduler. Usually, it is look like:
val scheduler = buildSchedule(\"5 * * * *\")\nOr:
val scheduler = buildSchedule {\n seconds {\n at(5)\n }\n}\nOn the top of any KronScheduler currently there are several groups of extensions:
All executes are look like do.... All executes are described below:
doOnce - will get the next time for executing, delay until that time and call block with returning of the block resultdoWhile - will call doOnce while it will return true (that means that block must return true if it expects that next call must happen). In two words: it will run while block returning truedoInfinity - will call the block using doWhile with predefined returning true. In two words: it will call block while it do not throw errorShortcuts are the constants that are initializing in a lazy way to provide preset KronSchedulers. For more info about KrontabScheduler you can read its own page.
AnyTimeScheduler - will always return incoming DateTime as nextEvery*Scheduler - return near * since the passed relatively:EverySecondSchedulerEveryMinuteSchedulerEveryHourSchedulerEveryDayOfMonthSchedulerEveryMonthSchedulerEveryYearSchedulerHere currently there is only one extension for KronScheduler: KronScheduler#asFlow. As a result you will get Flow<DateTime> (in fact SchedulerFlow) which will trigger next emit on each not null next DateTime
In two words, you must add dependency dev.inmo:krontab:$krontab_version to your project. The latest version presented by next badge:
To use this library, you will need to include MavenCentral repository in you project
mavenCentral()\nNext snippets must be placed into your dependencies part of build.gradle (for gradle) or pom.xml (for maven).
implementation \"dev.inmo:krontab:$krontab_version\"\n<dependency>\n <groupId>dev.inmo</groupId>\n <artifactId>krontab</artifactId>\n <version>${krontab_version}</version>\n</dependency>\nKSLog is a simple multiplatform tool for native logging.
"},{"location":"kslog/logging.html","title":"Logging","text":"Message type notice
On this page all the messages will be just simple String, but you may pass any object as the message
As has been said in the setup section, this library contains next levels of logging with their default representations on each platform:
Weight (by order) LogLevel name JS JVM Loggers Android 0 DEBUG console.log Level.FINEST Log.d 1 VERBOSE console.info Level.FINE Log.v 2 INFO console.info Level.INFO Log.i 3 WARNING console.warn Level.WARNING Log.w 4 ERROR console.error Level.SEVERE Log.e 5 ASSERT console.error Level.SEVERE Log.wtfEach of these levels have fullname and shortname shortcat extensions:
KSLog.debug/KSLog.d/KSLog.dSKSLog.verbose/KSLog.v/KSLog.vSKSLog.info/KSLog.i/KSLog.iSKSLog.warning/KSLog.w/KSLog.wSKSLog.error/KSLog.e/KSLog.eSKSLog.assert/KSLog.wtf/KSLog.wtfSAnd any of these shortcuts may accept one of several arguments combinations:
S suffix for suspendable messages creating, for exampleSo, when you want to log some expected exception, there are three common ways to do it:
val logger = KSLog.default\n\n// with callback\nlogger.info(tag, throwable) {\n \"Some your message for this event\"\n}\n\n// with suspendable callback\nlogger.infoS(tag, throwable) {\n withContext(Dispatchers.Default) {\n \"Some your message for this event\"\n }\n}\n\n// Just with message\nlogger.info(\"Some your message for this event\", throwable)\n\n// With message and tag as strings\nlogger.info(tag, \"Some your message for this event\", throwable)\nOf course, any of this calls can be shortenned:
val logger = KSLog.default\n\n// with callback\nlogger.i(tag, throwable) {\n \"Some your message for this event\"\n}\n\n// with suspendable callback\nlogger.iS(tag, throwable) {\n withContext(Dispatchers.Default) {\n \"Some your message for this event\"\n }\n}\n\n// Just with message\nlogger.i(\"Some your message for this event\", throwable)\n\n// With message and tag as strings\nlogger.i(tag, \"Some your message for this event\", throwable)\nThere is special shortcat - for base performLog. In that case the only change is that you will require to pass the LogLevel more obviously:
val logger = KSLog.default\n\n// with callback\nlogger.log(LogLevel.INFO, tag, throwable) {\n \"Some your message for this event\"\n}\n\n// with suspendable callback\nlogger.logS(LogLevel.INFO, tag, throwable) {\n withContext(Dispatchers.Default) {\n \"Some your message for this event\"\n }\n}\n\n// Just with message\nlogger.log(LogLevel.INFO, \"Some your message for this event\", throwable)\n\n// With message and tag as strings\nlogger.log(LogLevel.INFO, tag, \"Some your message for this event\", throwable)\nOR
val logger = KSLog.default\n\n// with callback\nlogger.l(LogLevel.INFO, tag, throwable) {\n \"Some your message for this event\"\n}\n\n// with suspendable callback\nlogger.lS(LogLevel.INFO, tag, throwable) {\n withContext(Dispatchers.Default) {\n \"Some your message for this event\"\n }\n}\n\n// Just with message\nlogger.l(LogLevel.INFO, \"Some your message for this event\", throwable)\n\n// With message and tag as strings\nlogger.l(LogLevel.INFO, tag, \"Some your message for this event\", throwable)\nimplementation \"dev.inmo:kslog:$kslog_version\"\nimplementation(\"dev.inmo:kslog:$kslog_version\")\n<dependency>\n <groupId>dev.inmo</groupId>\n <artifactId>kslog</artifactId>\n <version>${kslog_version}</version>\n</dependency>\nThe main point in setup in your code is to setup default logger:
KSLog.default = KSLog(\"defaultTag\")\nYou may use custom messageFormatter in any of KSLog factory to customize output of KSLog logging. For example:
KSLog(\n \"loggingWithCustomFormat\",\n messageFormatter = { level, tag, message, throwable ->\n println(\"[$level] $tag - $message: $throwable\")\n }\n)\nAdditionally you may use one of several different settings:
minLoggingLevel - minimal logging level for the log which will be logged. The order of log level is next:levels - and iterable with the levels which should be loggedfirstLevel,secondLevel,otherLevels - as levels, but vararg :)In case you are passing minLoggingLevel, the level and more important levels will be passed to logs. For example, when you are settings up your logger as in next snippet:
val logger = KSLog(\n \"exampleTag\",\n minLoggingLevel = LogLevel.INFO\n)\nThe next levels will be logged with logger:
INFOWARNINGERRORASSERTIt is logger which will call incoming performLogCallback on each logging. This logger can be create simply with one callback:
KSLog { level, tag, message, throwable ->\n println(\"[$level] $tag - $message: $throwable\")\n}\nIt is simple value class which can be used for zero-cost usage of some tag and calling for KSLog.default. For example, if you will create tag logger with next code:
val logger = TagLogger(\"tagLoggerTag\")\nThe logger will call KSLog.default with the tag tagLoggerTag on each calling of logging.
This pretty simple logger will call its fallbackLogger only in cases when incoming messageFilter will return true for logging:
val baseLogger = KSLog(\"base\") // log everything with the tag `base` if not set other\nval filtered = baseLogger.filtered { _, t, _ ->\n t == \"base\"\n}\nIn the example above baseLogger will perform logs in two ways: when it has been called directly or when we call log performing with the tag \"base\" or null. Besides, you can see there extension filtered which allow to create FilterKSLog logger with simple lambda.
This logger accepts map of types with the target loggers. You may build this logger with the special simple DSL:
val baseLogger = KSLog(\"base\") // log everything with the tag `base` if not set other\nval typed = buildTypedLogger {\n on<Int>(baseLogger) // log all ints to the baseLogger\n on<Float> { _, _, message, _ ->// log all floats to the passed logger\n println(message.toString()) // just print all floats\n }\n default { level, tag, message, throwable ->\n KSLog.performLog(level, tag, message, throwable)\n }\n}\nThere are two things which can be useful in your code: logger and logTag extensions. logTag is the autocalculated by your object classname tag. logger extension can be used with applying to any object like in the next snippet:
class SomeClass {\n init {\n logger.i(\"inited\")\n }\n}\nThe code above will trigger calling of logging in KSLog.default with level LogLevel.INFO using tag SomeClass and message \"inited\". As you could have guessed, logger is using TagLogger with logTag underhood and the most expensive operation here is automatical calculation of logTag.
loggerFor JVM you may setup additionally use java loggers as the second parameter of KSLog factory. For example:
KSLog(\n \"yourTag\"\n Logger.getLogger(\"YourJavaLoggerName\")\n)\nIn the telegram system there are two types of keyboards:
Reply Inline Keyboard for each user in the chat Keyboard linked to the certain messageLow-level way to create keyboard looks like in the next snippet:
ReplyKeyboardMarkup(\n matrix {\n row {\n add(SimpleKeyboardButton(\"Simple text\"))\n // ...\n }\n // ...\n }\n)\nIn case you wish to create inline keyboard, it will look like the same as for reply keyboard. But there is another way. The next snippet will create the same keyboard as on the screenshots above:
// reply keyboard\nreplyKeyboard {\n row {\n simpleButton(\"7\")\n simpleButton(\"8\")\n simpleButton(\"9\")\n simpleButton(\"*\")\n }\n row {\n simpleButton(\"4\")\n simpleButton(\"5\")\n simpleButton(\"6\")\n simpleButton(\"/\")\n }\n row {\n simpleButton(\"1\")\n simpleButton(\"2\")\n simpleButton(\"3\")\n simpleButton(\"-\")\n }\n row {\n simpleButton(\"0\")\n simpleButton(\".\")\n simpleButton(\"=\")\n simpleButton(\"+\")\n }\n}\n\n// inline keyboard\ninlineKeyboard {\n row {\n dataButton(\"Get random music\", \"random\")\n }\n row {\n urlButton(\"Send music to friends\", \"https://some.link\")\n }\n}\nBot API allows you to send live locations and update them during their lifetime. In this library there are several ways to use this API:
In the Bot API there is no independent sendLiveLocation method, instead it is suggested to use sendLocation with setting up live_period. In this library in difference with original Bot API live location is special request. It was required because of in fact live locations and static locations are different types of location info and you as bot developer may interact with them differently.
Anyway, in common case the logic looks like:
In difference with sendLiveLocation, startLiveLocation using LiveLocationProvider. With this provider you need not to handle chat and message ids and keep some other data for location changes. Instead, you workflow with provider will be next:
Besides, LiveLocationProvider contains different useful parameters about live location
This way of live locations handling is based on coroutines Flow and allow you to pass some external Flow with EditLiveLocationInfo. So, workflow:
flow {\n var i = 0\n while (isActive) {\n val newInfo = EditLiveLocationInfo(\n latitude = i.toDouble(),\n longitude = i.toDouble(),\n replyMarkup = flatInlineKeyboard {\n dataButton(\"Cancel\", \"cancel\")\n }\n )\n emit(newInfo)\n i++\n delay(10000L) // 10 seconds\n }\n}\nval currentMessageState = MutableStateFlow<ContentMessage<LocationContent>?>(null)\nhandleLiveLocation(\n it.chat.id,\n locationsFlow,\n sentMessageFlow = FlowCollector { currentMessageState.emit(it) }\n)\n// this code will be called after `locationsFlow` will ends\nOR
scope.launch {\n handleLiveLocation(\n it.chat.id,\n locationsFlow,\n sentMessageFlow = FlowCollector { currentMessageState.emit(it) }\n )\n}\n// this code will be called right after launch will be completed\nSee our example to get more detailed sample
"},{"location":"tgbotapi/dsls/text.html","title":"Text","text":"For the text creating there are several tools. The most simple one is to concatenate several text sources to make list of text sources as a result:
val sources = \"Regular start of text \" + bold(\"with bold part\") + italic(\"and italic ending\")\nBut there is a little bit more useful way: entities builder:
val items = (0 until 10).map { it.toString() }\nbuildEntities(\" \") {// optional \" \" auto separator which will be pasted between text sources\n +\"It is regular start too\" + bold(\"it is bold as well\")\n items.forEachIndexed { i, item ->\n if (i % 2) {\n italic(item)\n } else {\n strikethrough(item)\n }\n }\n}\nIn the code above we are creating an items list just for demonstrating that inside of buildEntities body we may use any operations for cunstructing our result list of TextSources. As a result, will be created the list which will looks like in telegram as \u201cIt is regular start too it is bold as well 0 ~~1~~ 2 ~~3~~ 4 ~~5~~ 6 ~~7~~ 8 ~~9~~\u201d.
There are several places you need to visit for starting work with any Telegram Bot framework on any language:
Anyway, the most important link is How do I create a bot? inside of Telegram Bot API
"},{"location":"tgbotapi/introduction/before-any-bot-project.html#next-steps","title":"Next steps","text":"Examples info
A lot of examples with using of Telegram Bot API you can find in this github repository
"},{"location":"tgbotapi/introduction/first-bot.html#the-most-simple-bot","title":"The most simple bot","text":"The most simple bot will just print information about itself. All source code you can find in this repository. Our interest here will be concentrated on the next example part:
suspend fun main(vararg args: String) {\n val botToken = args.first()\n val bot = telegramBot(botToken)\n println(bot.getMe())\n}\nSo, let\u2019s get understanding, about what is going on:
suspend fun main(vararg args: String):suspend required for making of requests inside of this function. For more info you can open official documentation for coroutins. In fact, suspend fun main is the same that fun main() = runBlocking {} from examplesval botToken = args.first(): here we are just getting the bot token from first arguments of command lineval bot = telegramBot(botToken) : inside of bot will be RequestsExecutor object which will be used for all requests in any project with this libraryprintln(bot.getMe()): here happens calling of getMe extensionAs a result, we will see in the command line something like
ExtendedBot(id=ChatId(chatId=123456789), username=Username(username=@first_test_ee17e8_bot), firstName=Your bot name, lastName=, canJoinGroups=false, canReadAllGroupMessages=false, supportsInlineQueries=false)\nThere are three projects:
TelegramBotAPI Core - project with base for all working with Telegram Bot APITelegramBotAPI API Extensions - extension of TelegramBotAPI with functions for more comfortable work with Telegram Bot APITelegramBotAPI Utils Extensions - extension of TelegramBotAPI with functions for extending of different things like retrieving of updatesTelegramBotAPI
Also, there is an aggregator-version tgbotapi, which will automatically include all projects above. It is most recommended version due to the fact that it is including all necessary tools around TelegramBotAPI Core, but it is optionally due to the possible restrictions on the result methods count (for android) or bundle size
Examples
You can find full examples info in this repository. In this repository there full codes which are working in normal situation. Currently, there is only one exception when these examples could work incorrectly: you are living in the location where Telegram Bot API is unavailable. For solving this problem you can read Proxy setup part
"},{"location":"tgbotapi/introduction/including-in-your-project.html#notice-about-repository","title":"Notice about repository","text":"To use this library, you will need to include Maven Central repository in your project
mavenCentral()\n<repository>\n <id>central</id>\n <name>mavenCentral</name>\n <url>https://repo1.maven.org/maven2</url>\n</repository>\nBesides, there is developer versions repo. To use it in your project, add the repo in repositories section:
maven {\n url \"https://git.inmo.dev/api/packages/InsanusMokrassar/maven\"\n}\n<repository>\n <id>dev.inmo</id>\n <name>InmoDev</name>\n <url>https://git.inmo.dev/api/packages/InsanusMokrassar/maven</url>\n</repository>\nAs tgbotapi_version variable in next snippets will be used variable with next last published version:
implementation \"dev.inmo:tgbotapi:$tgbotapi_version\"\n<dependency>\n <groupId>dev.inmo</groupId>\n <artifactId>tgbotapi</artifactId>\n <version>${tgbotapi_version}</version>\n</dependency>\nAs tgbotapi_version variable in next snippets will be used variable with next last published version:
implementation \"dev.inmo:tgbotapi.core:$tgbotapi_version\"\n<dependency>\n <groupId>dev.inmo</groupId>\n <artifactId>tgbotapi.core</artifactId>\n <version>${tgbotapi_version}</version>\n</dependency>\nAs tgbotapi_version variable in next snippets will be used variable with next last published version:
implementation \"dev.inmo:tgbotapi.api:$tgbotapi_version\"\n<dependency>\n <groupId>dev.inmo</groupId>\n <artifactId>tgbotapi.api</artifactId>\n <version>${tgbotapi_version}</version>\n</dependency>\nAs tgbotapi_version variable in next snippets will be used variable with next last published version:
implementation \"dev.inmo:tgbotapi.utils:$tgbotapi_version\"\n<dependency>\n <groupId>dev.inmo</groupId>\n <artifactId>tgbotapi.utils</artifactId>\n <version>${tgbotapi_version}</version>\n</dependency>\nIn some locations Telegram Bots API urls will be unavailable. In this case all examples will just throw exception like:
Exception in thread \"main\" java.net.ConnectException: Connection refused\n at sun.nio.ch.SocketChannelImpl.checkConnect(Native Method)\n at sun.nio.ch.SocketChannelImpl.finishConnect(SocketChannelImpl.java:717)\n at io.ktor.network.sockets.SocketImpl.connect$ktor_network(SocketImpl.kt:36)\n at io.ktor.network.sockets.SocketImpl$connect$1.invokeSuspend(SocketImpl.kt)\n at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)\n at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:56)\n at kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.kt:571)\n at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.kt:738)\n at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.runWorker(CoroutineScheduler.kt:678)\n at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.run(CoroutineScheduler.kt:665)\n\nProcess finished with exit code 1\nThere are several ways to solve this problem:
First of all, you will need to use one more library:
build.gradle:
implementation \"io.ktor:ktor-client-okhttp:2.0.1\"\nDependency note
In the snippet above was used version 2.0.1 which is actual for TelegramBotAPI at the moment of filling this documentation (May 22 2022, TelegramBotAPI version 2.0.0) and you can update version of this dependency in case if it is outdated.
For configuring proxy for your bot inside your program, you can use next snippet:
val botToken = \"HERE MUST BE YOUR TOKEN\"\nval bot = telegramBot(botToken) {\n ktorClientEngineFactory = OkHttp\n proxy = ProxyBuilder.socks(\"127.0.0.1\", 1080)\n}\nExplanation line by line:
val botToken = \"HERE MUST BE YOUR TOKEN\" - here we are just creating variable botTokenval bot = telegramBot(botToken) { - start creating botktorClientEngineFactory = OkHttp - setting up engine factory of our bot. On the time of documentation filling, OkHttp is one of the engines in Ktor system which supports socks proxy. More you can read on Ktor site in subparts about engines and proxyproxy = ProxyBuilder.socks(\"127.0.0.1\", 1080) - here we are setting up our proxy. Here was used local server which (as assumed) will connect to server like shadowsocksAPI extensions is a module which you may include in your project in addition to core part. In most cases this module will allow just use syntax like bot.getUpdates() instead of bot.execute(GetUpdates()), but there are several other things you will achieve with that syntax.
This functionality allow you to build bot in more unified and comfortable way than standard creating with telegramBot function
buildBot(\n \"TOKEN\"\n) {\n proxy = ProxyBuilder.socks(host = \"127.0.0.1\", port = 4001) // just an example, more info on https://ktor.io/docs/proxy.html\n ktorClientConfig = {\n // configuring of ktor client\n }\n ktorClientEngineFactory = {\n // configuring of ktor client engine \n }\n}\nIn standard library requests there are no way to download some file retrieved in updates or after requests. You may use syntax like bot.downloadFile(file) where file is TelegramMediaFile from telegram, FileId or even PathedFile from GetFile request (sources).
By default, you should handle updates of Live location by your code. But with extension bot#startLiveLocation you may provide all necessary startup parameters and handle updates with just calling updateLocation for retrieved LiveLocationProvider.
There are several things you may read next:
Behaviour builder with FSM is based on the MicroUtils FSM. There are several important things in FSM:
State - any object which implements State interfaceStateHandler (or CheckableHandlerHolder) - the handler of statesStatesMachine have two methods:
start which will start work of machinestartChain which will add new state for handlingThe most based way to create StatesMachine and register StateHandlers looks like in the next snippet:
buildFSM<TrafficLightState> {\n strictlyOn<SomeState> {\n // state handling\n }\n}.start(CoroutineScope(...)).join()\nFull example
You may find full example of FSM usage in the tests of FSM in MicroUtils
So, you must do next steps before you will launch your bot with FSM:
There are several extensions for TelegramBot to create your bot with FSM:
All of them will take as an callback some object with type CustomBehaviourContextReceiver and will looks like in the next snippet:
telegramBotWithBehaviourAndFSMAndStartLongPolling<YourStateType>(\"BOT_TOKEN\") {\n // here you may use any operations from BehaviourBuilder\n // here you may use any operations from BehaviourContextWithFSMBuilder like strictlyOn and others\n}\nIn the previous pages about updates handling and was mentioned that currently in the most cases you should use Flows. So, there is an improvement for that system which hide direct work with flows and allow you to create more declarative logic of your bot.
"},{"location":"tgbotapi/logic/behaviour-builder.html#main-parts-of-behaviour-builder","title":"Main parts of Behaviour Builder","text":"There are several things you should know for better understanding of behaviour builder:
on* extensions for BehaviourContext which allow you to create reaction on some updatewait* extensions which you may use in buildBehaviour function, but it is recommended to use it in bodies of triggersAs was said above, there is buildBehaviour function which allow you set up your bot logic. Let\u2019s see an example:
val bot = telegramBot(\"TOKEN\")\n\nbot.buildBehaviour {\n onCommand(\"start\") { // creating of trigger\n val message = it\n val content = message.content\n\n reply(message, \"Ok, send me one photo\") // send text message with replying on incoming message\n\n val photoContent = waitPhoto().first() // waitPhoto will return List, so, get first element\n\n val photo = downloadFile(photoContent) // ByteArray of photo\n\n // some logic with saving of photos\n }\n}\nIn most cases there are opportunity to filter some of messages before starting of main logic. Let\u2019s look at this using the example above:
val bot = telegramBot(\"TOKEN\")\n\nbot.buildBehaviour {\n onCommand(\n \"start\",\n initialFilter = {\n it.content.textSources.size == 1 // make sure that user has sent /start without any additions\n }\n ) {\n // ...\n }\n}\nOR
val bot = telegramBot(\"TOKEN\")\n\nbot.buildBehaviour {\n onCommand(\n \"start\",\n requireOnlyCommandInMessage = true // it is default, but you can overwrite it with `requireOnlyCommandInMessage = false`\n ) {\n // ...\n }\n}\nUnfortunatelly, exceptions handling in this library is a bit difficult in some places, but that have at least two reasons: flexibility and usability.
"},{"location":"tgbotapi/logic/exceptions-handling.html#in-place-handling","title":"\u201cIn place\u201d handling","text":"In case you know, where exceptions are happening, you may use several tools for exceptions catching:
If you prefer to receive Result objects instead of some weird callbacks, you may use the next syntax:
safelyWithResult {\n // do something\n}.onSuccess { // will be called if everything is right\n // handle success\n}.onFailure { // will be called if something went wrong\n // handle error\n it.printStackTrace()\n}.getOrThrow() // will return value or throw exception\nAlso there is more simple (in some cases) way to handle exceptions with callbacks:
safely(\n {\n // handle error\n it.printStackTrace()\n null // return value\n }\n) {\n // do something\n}\nThere are two types of handling:
safely(\n {\n it.printStackTrace()\n \"error\"\n }\n) {\n error(\"Hi :)\") // emulate exception throwing\n \"ok\"\n} // result will be with type String\nsafely, but this type by default allow to return nullable value (when exception was thrown) instead of just throwing (as with safely):safelyWithouExceptions {\n // do something\n} // will returns nullable result type\nThe most simple way to configure exceptions handling is to change CoroutineContext when you are creating your CoroutineScope for bot processing:
val bot = telegramBot(\"TOKEN\")\n\nbot.buildBehaviour (\n scope = scope,\n defaultExceptionsHandler = {\n it.printStackTrace()\n }\n) {\n // ...\n}\nOR
val bot = telegramBotWithBehaviour (\n \"TOKEN\",\n scope = scope,\n defaultExceptionsHandler = {\n it.printStackTrace()\n }\n) {\n // ...\n}\nHere we have used ContextSafelyExceptionHandler class. It will pass default handling of exceptions and will call the block in most cases when something inside of your bot logic has thrown exception.
According to the documentation there are several ways to work with files:
typealias for the FileId)There are several cases you may need in your app to work with files:
FileId (for sending in future)The most simple way to send some file is to get file id and send it. You may get file id from any message with media. For example, if you have received some Message, you may use asCommonMessage conversation to be able to get its content and then convert it to some content with media. Full code here:
val message: Message;\n\nval fileId = message.asCommonMessage() ?.withContent<MediaContent>() ?.content ?.media ?.fileId;\nWAT? O.o
In the code above we get some message, safely converted it to CommonMessage with asCommonMessage, then safely took its content via withContent<MediaContent>() ?.content and then just get its media file id.
There are three ways to download files:
ByteArrayByteReadChannelAllocator which allow to retrieve ByteReadChannel and do whatever you want with it[JVM Only] Download it directly to file or temporal fileAPI extensions","text":""},{"location":"tgbotapi/logic/files-handling.html#files-jvmandroid","title":"Files (JVM/Android)","text":"val bot: TelegramBot;\nval fileId: FileId;\nval outputFile: File;\n\nbot.downloadFile(fileId, outputFile)\nSee downloadFile extension docs in the JVM tab to get more available options
There is also way with saving of data into temporal file. That will allow you to do with data whatever you want without high requirements to memory or network connection:
val bot: TelegramBot;\nval fileId: FileId;\n\nval tempFile: File = bot.downloadFileToTemp(fileId)\nSee downloadFileToTemp extension docs to get more available options
"},{"location":"tgbotapi/logic/files-handling.html#byte-read-channel","title":"Byte read channel","text":"val bot: TelegramBot;\nval fileId: FileId;\n\nval bytes: ByteReadChannelAllocator = bot.downloadFileStream(fileId)\nSee downloadFileStream extension docs to get more available options
"},{"location":"tgbotapi/logic/files-handling.html#byte-read-channel-allocator","title":"Byte read channel allocator","text":"val bot: TelegramBot;\nval fileId: FileId;\n\nval bytes: ByteReadChannelAllocator = bot.downloadFileStreamAllocator(fileId)\nSee downloadFileStreamAllocator extension docs to get more available options
"},{"location":"tgbotapi/logic/files-handling.html#byte-arrays","title":"Byte arrays","text":"val bot: TelegramBot;\nval fileId: FileId;\n\nval bytes: ByteArray = bot.downloadFile(fileId)\nSee downloadFile extension docs to get more available options
"},{"location":"tgbotapi/logic/files-handling.html#low-level-or-how-does-it-work","title":"Low level orhow does it work?","text":"You may download file with streams or with downloading into the memory first. On low level you should do several things. They are presented in next snippet:
val bot: TelegramBot;\nval fileId: FileId;\n\nval pathedFile: PathedFile = bot.execute(GetFile(fileId))\n\nval downloadedBytes: ByteArray = bot.execute(DownloadFile(pathedFile.filePath))\nIn the snippet above we are getting file PathedFile by its FileId and use it to download file bytes into memory using DownloadFile request.
You may use almost the same way but with byte read channel allocator:
val bot: TelegramBot;\nval fileId: FileId;\n\nval pathedFile: PathedFile = bot.execute(GetFile(fileId))\n\nval channelAllocator: ByteReadChannelAllocator = bot.execute(DownloadFileStream(pathedFile.filePath))\n\nval byteReadChannel: ByteReadChannel = channelAllocator()\nAnd then you may look into ByteReadChannel docs to get more info about what you can do with that.
Several useful links
Of course, in most cases you must be sure that file have correct type.
"},{"location":"tgbotapi/logic/files-handling.html#fileid-and-fileurl","title":"FileId and FileUrl","text":"It is the most simple way to send any media in Telegram, but this way have several restrictions:
FileId which has retrieved for file should not (and probably will not too) equal to the FileId retrieved by some other botJS Restrictions
Sending via file is accessible from all supported platforms, but there is small note about JS - due to restrictions of work with streams and stream-like data (JS have no native support of files streaming) on this platform all the files will be loaded inside of RAM before the sending to the telegram services.
Sending via file is available throw the MultipartFile. There are several wayt to get it:
MultipartFile(\"filename.jpg\") { /* here Input allocation */ }ByteArray, ByteReadChannel, ByteReadChannelAllocator or File (on any platform)In most cases, sending via files looks like in the next snippet:
val file: File;\n\nbot.sendDocument(chatId, file.asMultipartFile())\nThe base version of library was done a lot of time ago and just got several additions related to improvements, updates in Telegram Bot API or some requests from our community.
"},{"location":"tgbotapi/logic/low-level-work-with-bots.html#base-things","title":"Base things","text":"There are several important things in context of this library:
TelegramBot)So, in most cases all your request calls with simplified api of this library (like bot.getMe()) will looks like bot.execute(GetMe). Result of these calls is defined in type of any request (for example, for GetMe request the result type is ExtendedBot). As a result, you can avoid any extension api (like special API extensions) and use low level request with full controlling of the whole logic flow.
As was written above, it will require some request:
val updates = bot.execute(GetUpdates())\nResult type of GetUpdates request is Update. You may find inheritors of this interface in Update kdocs.
"},{"location":"tgbotapi/logic/low-level-work-with-bots.html#what-is-next","title":"What is next?","text":"As was said above, you may look into our API extensions in case you wish to use more high-level functions instead of bot.execute(SomeRequest()). Besides, it will be very useful to know more about updates retrieving.
As you know, Telegram have the feature named Media Groups. Media groups have several differences with the common messages:
Row updates
In tgbotapi there is no any additional handling of media groups by default and in case you will use simple bot.getUpdates, you will get the list of row updates and media groups will be included in this list as separated messages with MediaGroupPartContent. In that case you may use convertWithMediaGroupUpdates to be able to work with media groups as will be described below
In case you are using standard long polling (one of alternatives is telegramBotWithBehaviourAndLongPolling) or webhooks updates will be converted uner the hood and as a result, you will take media groups as a content in one message:
telegramBotWithBehaviourAndLongPolling(\n \"token\"\n) {\n onVisualGallery { // it: CommonMessage<MediaGroupContent<VisualMediaGroupPartContent>>\n it.content // MediaGroupContent<VisualMediaGroupPartContent>\n it.content.group // List<MediaGroupCollectionContent.PartWrapper<VisualMediaGroupPartContent>>\n it.content.group.forEach { // it: MediaGroupCollectionContent.PartWrapper<VisualMediaGroupPartContent>\n it.messageId // source message id for current media group part\n it.sourceMessage // source message for current media group part\n it.content // VisualMediaGroupPartContent\n println(it.content) // will print current content part info\n }\n }\n}\nKDocs:
In two words, in difference with row Telegram Bot API, you will take media groups in one message instead of messages list.
"},{"location":"tgbotapi/logic/types-conversations.html","title":"Types conversations","text":"One of the most important topics in context of tgbotapi is types conversations. This library is very strong-typed and a lot of things are based on types hierarchy. Lets look into the hierarchy of classes for the Message in 0.35.8:
As you may see, it is a little bit complex and require several tools for types conversation.
"},{"location":"tgbotapi/logic/types-conversations.html#as","title":"As","text":"as conversations will return new type in case if it is possible. For example, when you got Message, you may use asContentMessage conversation to get message with content:
val message: Message;\nprintln(message.asContentMessage() ?.content)\nThis code will print null in case when message is not ContentMessage, and content when is.
require works like as, but instead of returning nullable type, it will always return object with required type OR throw ClassCastException:
val message: Message;\nprintln(message.requireContentMessage().content)\nThis code will throw exception when message is not ContentMessage and print content when is.
when extensions will call passed block when type is correct. For example:
val message: Message;\nmessage.whenContentMessage {\n println(it.content)\n}\nCode placed above will print content when message is ContentMessage and do nothing when not
Of course, in most cases here we will look up the way of using utils extnsions, but you may read deeper about updates retrieving here.
"},{"location":"tgbotapi/logic/updates-with-flows.html#phylosophy-of-flow-updates-retrieving","title":"Phylosophy ofFlow updates retrieving","text":"In most updates retrieving processes there are two components: UpdatesFiler and its inheritor FlowsUpdatesFilter. It is assumed, that you will do several things in your app to handle updates:
UpdatesFilter (for example, with flowsUpdatesFilter factory)flowsUpdatesFilter you will set up updates handling in the lambda passed to this factory)Let\u2019s look how it works with the factory above:
// Step 1 - create filter\nval filter = flowsUpdatesFilter {\n // Step 2 - set up handling. In this case we will print any message from group or user in console\n messageFlow.onEach {\n println(it)\n }.launchIn(someCoroutineScope)\n}\n\n// Step 3 - passing updates to filter\nbot.getUpdates().forEach {\n filter.asUpdatesReceiver(it)\n}\nSome example with long polling has been described above. But it is more useful to use some factories for it. In this page we will look for simple variant with TelegramBot#longPolling. So, with this function, your handling of updates will looks like:
val bot = telegramBot(\"TOKEN\")\n\nbot.longPolling {\n messageFlow.onEach {\n println(it)\n }.launchIn(someCoroutineScope)\n}.join()\nThis example looks like the example above with three steps, but there are several important things here:
.join() will suspend your function \ud83d\ude0a longPolling function returns Job and you may use it to:cancel working of long polling (just call job.cancel())join and wait while the work of longPolling will not be completed (it will works infinity if you will not cancel it anywhere)longPolling functionWhat is next?","text":"As a result you can start listen updates and react on it. Next recommended articles:
Preview reading
It is recommended to visit our pages about UpdatesFilters and Webhooks to have more clear understanding about what is happening in this examples page
Heroku is a popular place for bots hosting. In common case you will need to configure webhooks for your server to include getting updates without problems. There are several things related to heroku you should know:
https://<app name>.herokuapp.com/System.getenv(\"PORT\").toInt()Sat Aug 15 5:04:21 +00 2020) there is only one official server engine for ktor which is correctly working with Heroku: Tomcat server engineServer configuration alternatives
Here will be presented variants of configuration of webhooks and starting server. You always able to set webhook manualy, create your own ktor server and include webhooks handling in it or create and start server with only webhooks handling. More info you can get on page Webhooks
"},{"location":"tgbotapi/updates/heroku.html#short-example-with-behaviour-builder","title":"Short example with Behaviour Builder","text":"suspend fun main {\n // This subroute will be used as random webhook subroute to improve security according to the recommendations of Telegram\n val subroute = uuid4().toString()\n // Input/Output coroutines scope more info here: https://kotlinlang.org/docs/coroutines-guide.html\n val scope = CoroutineScope(Dispatchers.IO)\n // Here will be automatically created bot and available inside of lambda where you will setup your bot behaviour\n telegramBotWithBehaviour(\n // Pass TOKEN inside of your application environment variables\n System.getenv(\"TOKEN\"),\n scope = scope\n ) {\n // Set up webhooks and start to listen them\n setWebhookInfoAndStartListenWebhooks(\n // Automatic env which will be passed by heroku to the app\n System.getenv(\"PORT\").toInt(),\n // Server engine. More info here: https://ktor.io/docs/engines.html\n Tomcat,\n // Pass URL environment variable via settings of application. It must looks like https://<app name>.herokuapp.com\n SetWebhook(\"${System.getenv(\"URL\").removeSuffix(\"/\")}/$subroute\"),\n // Just callback which will be called when exceptions will happen inside of webhooks\n {\n it.printStackTrace()\n },\n // Set up listen requests from outside\n \"0.0.0.0\",\n // Set up subroute to listen webhooks to\n subroute,\n // BehaviourContext is the CoroutineScope and it is recommended to pass it inside of webhooks server\n scope = this,\n // BehaviourContext is the FlowsUpdatesFilter and it is recommended to pass its asUpdateReceiver as a block to retrieve all the updates\n block = asUpdateReceiver\n )\n // Test reaction on each command with reply and text `Got it`\n onUnhandledCommand {\n reply(it, \"Got it\")\n }\n }\n // Just potentially infinite await of bot completion\n scope.coroutineContext.job.join()\n}\n// This subroute will be used as random webhook subroute to improve security according to the recommendations of Telegram\nval subroute = uuid4().toString()\nval bot = telegramBot(TOKEN)\nval scope = CoroutineScope(Dispatchers.Default)\n\nval filter = flowsUpdatesFilter {\n messageFlow.onEach {\n println(it) // will be printed \n }.launchIn(scope)\n}\n\nval subroute = UUID.randomUUID().toString() // It will be used as subpath for security target as recommended by https://core.telegram.org/bots/api#setwebhook\n\nval server = bot.setWebhookInfoAndStartListenWebhooks(\n // Automatic env which will be passed by heroku to the app\n System.getenv(\"PORT\").toInt(),\n // Server engine. More info here: https://ktor.io/docs/engines.html\n Tomcat,\n // Pass URL environment variable via settings of application. It must looks like https://<app name>.herokuapp.com\n SetWebhook(\"${System.getenv(\"URL\").removeSuffix(\"/\")}/$subroute\"),\n // Just callback which will be called when exceptions will happen inside of webhooks\n {\n it.printStackTrace()\n },\n // Set up listen requests from outside\n \"0.0.0.0\",\n // Set up subroute to listen webhooks to\n subroute,\n scope = scope,\n block = filter.asUpdateReceiver\n)\n\nserver.environment.connectors.forEach {\n println(it)\n}\nserver.start(false)\nLong polling is a technology of getting updates for cases you do not have some dedicated server or you have no opportunity to receive updates via webhooks. More about this you can read in wiki.
"},{"location":"tgbotapi/updates/long-polling.html#related-topics","title":"Related topics","text":"There are a lot of ways to include work with long polling:
RequestsExecutor#longPollingFlow Is the base way to get all updates cold Flow. Remember, that this flow will not be launched automaticallyRequestsExecutor#startGettingOfUpdatesByLongPolling Old and almost deprecated wayRequestsExecutor#longPolling Works like startGettingOfUpdatesByLongPolling but shorted in a name :)RequestsExecutor#createAccumulatedUpdatesRetrieverFlow Works like longPollingFlow, but flow inside will return only the updates accumulated at the moment of calls (all new updates will not be passed throw this flow)RequestsExecutor#retrieveAccumulatedUpdates Use createAccumulatedUpdatesRetrieverFlow to perform all accumulated updatesRequestsExecutor#flushAccumulatedUpdates Works like retrieveAccumulatedUpdates but perform all updates directly in a place of callingGetUpdates request or RequestsExecutor#getUpdates extensionlongPolling is a simple way to start getting updates and work with bot:
val bot = telegramBot(token)\nbot.longPolling(\n textMessages().subscribe(scope) { // here \"scope\" is a CoroutineScope\n println(it) // will be printed each update from chats with messages\n }\n)\nThe main aim of startGettingOfUpdatesByLongPolling extension was to provide more simple way to get updates in automatic mode:
val bot = telegramBot(token)\nbot.startGettingOfUpdatesByLongPolling(\n {\n println(it) // will be printed each update from chats with messages\n }\n)\nThe other way is to use the most basic startGettingOfUpdatesByLongPolling extension:
val bot = telegramBot(token)\nbot.startGettingOfUpdatesByLongPolling {\n println(it) // will be printed each update\n}\nDue to the fact, that anyway you will get updates in one format (Update objects), some time ago was solved to create one point of updates filters for more usefull way of updates handling
UpdatesFilter currently have two properties:
asUpdateReceiver - required to represent this filter as common updates receiver which able to get any UpdateallowedUpdates - required to determine, which updates are usefull for this filterAnyway, this filter can\u2019t work with updates by itself. For retrieving updates you should pass this filter to some of getting updates functions (long polling or webhooks).
"},{"location":"tgbotapi/updates/updates-filters.html#simpleupdatesfilter","title":"SimpleUpdatesFilter","text":"SimpleUpdatesFilter is a simple variant of filters. It have a lot of UpdateReceiver properties which can be set up on creating of this object. For example, if you wish to get messages from chats (but not from channels), you can use next snippet:
SimpleUpdatesFilter {\n println(it)\n}\nA little bit more modern way is to use FlowsUpdatesFilter. It is very powerfull API of Kotlin Coroutines Flows, built-in support of additional extensions for FlowsUpdatesFilter and Flow<...> receivers and opportunity to split one filter for as much receivers as you want. Filter creating example:
val scope = CoroutineScope(Dispatchers.Default)\nflowsUpdatesFilter {\n messageFlow.onEach {\n println(it)\n }.launchIn(scope)\n}\nIn cases you need not separate logic for handling of messages from channels and chats there are three ways to combine different flows into one:
plus operation and handling of different flows:flowsUpdatesFilter {\n (messageFlow + channelPostFlow).onEach {\n println(it) // will be printed each message update from channels and chats both\n }.launchIn(scope)\n}\naggregateFlows:flowsUpdatesFilter {\n aggregateFlows(\n scope,\n messageFlow,\n channelPostFlow\n ).onEach {\n println(it) // will be printed each message update from channels and chats both\n }.launchIn(scope)\n}\nFlowsUpdatesFilter extensions:flowsUpdatesFilter {\n allSentMessagesFlow.onEach {\n println(it) // will be printed each message update from channels and chats both\n }.launchIn(scope)\n}\nFlowsUpdatesFilter have a lot of extensions for messages types filtering:
flowsUpdatesFilter {\n textMessages(scope).onEach {\n println(it) // will be printed each message from channels and chats both with content only `TextContent`\n }.launchIn(scope)\n}\nThe same things were created for media groups:
flowsUpdatesFilter {\n mediaGroupMessages(scope).onEach {\n println(it) // will be printed each media group messages list from both channels and chats without filtering of content\n }.launchIn(scope)\n\n mediaGroupPhotosMessages(scope).onEach {\n println(it) // will be printed each media group messages list from both channels and chats with PhotoContent only\n }.launchIn(scope)\n\n mediaGroupVideosMessages(scope).onEach {\n println(it) // will be printed each media group messages list from both channels and chats with VideoContent only\n }.launchIn(scope)\n}\nBesides, there is an opportunity to avoid separation on media groups and common messages and receive photos and videos content in one flow:
flowsUpdatesFilter {\n sentMessagesWithMediaGroups(scope).onEach {\n println(it) // will be printed each message including each separated media group message from both channels and chats without filtering of content\n }.launchIn(scope)\n\n photoMessagesWithMediaGroups(scope).onEach {\n println(it) // will be printed each message including each separated media group message from both channels and chats with PhotoContent only\n }.launchIn(scope)\n\n videoMessagesWithMediaGroups(scope).onEach {\n println(it) // will be printed each message including each separated media group message from both channels and chats with VideoContent only\n }.launchIn(scope)\n}\nIn telegram bot API there is an opportunity to get updates via webhooks. In this case you will be able to retrieve updates without making additional requests. Most of currently available methods for webhooks are working on ktor server for JVM. Currently, next ways are available for using for webhooks:
Route#includeWebhookHandlingInRoute for ktor serverRoute#includeWebhookHandlingInRouteWithFlows startListenWebhooksRequestsExecutor#setWebhookInfoAndStartListenWebhookssetWebhookInfoAndStartListenWebhooks","text":"It is the most common way to set updates webhooks and start listening of them. Example:
val bot = telegramBot(TOKEN)\n\nval filter = flowsUpdatesFilter {\n // ...\n}\n\nbot.setWebhookInfoAndStartListenWebhooks(\n 8080, // listening port. It is required for cases when your server hidden by some proxy or other system like Heroku\n CIO, // default ktor server engine. It is recommended to replace it with something like `Netty`. More info about engines here: https://ktor.io/servers/configuration.html\n SetWebhook(\n \"address.com/webhook_route\",\n File(\"/path/to/certificate\").toInputFile(), // certificate file. More info here: https://core.telegram.org/bots/webhooks#a-certificate-where-do-i-get-one-and-how\n 40, // max allowed updates, by default is null\n filter.allowedUpdates\n ),\n {\n it.printStackTrace() // optional handling of exceptions\n },\n \"0.0.0.0\", // listening host which will be used to bind by server\n \"subroute\", // Optional subroute, if null - will listen root of address\n WebhookPrivateKeyConfig( // optional config of private key. It will be installed in server to use TLS with custom certificate. More info here: https://core.telegram.org/bots/webhooks#a-certificate-where-do-i-get-one-and-how\n \"/path/to/keystore.jks\",\n \"KeystorePassword\",\n \"Keystore key alias name\",\n \"KeystoreAliasPassword\"\n ),\n scope, // Kotlin coroutine scope for internal transforming of media groups\n filter.asUpdateReceiver\n)\nIf you will use previous example, ktor server will bind and listen url 0.0.0.0:8080/subroute and telegram will send requests to address address.com/webhook_route with custom certificate. Alternative variant will use the other SetWebhook request variant:
SetWebhook(\n \"address.com/webhook_route\",\n \"some_file_bot_id\".toInputFile(),\n 40, // max allowed updates, by default is null\n filter.allowedUpdates\n)\nAs a result, request SetWebhook will be executed and after this server will start its working and handling of updates.
startListenWebhooks","text":"This function is working almost exactly like previous example, but this one will not set up webhook info in telegram:
val filter = flowsUpdatesFilter {\n // ...\n}\n\nstartListenWebhooks(\n 8080, // listening port. It is required for cases when your server hidden by some proxy or other system like Heroku\n CIO, // default ktor server engine. It is recommended to replace it with something like `Netty`. More info about engines here: https://ktor.io/servers/configuration.html\n {\n it.printStackTrace() // optional handling of exceptions\n },\n \"0.0.0.0\", // listening host which will be used to bind by server\n \"subroute\", // Optional subroute, if null - will listen root of address\n WebhookPrivateKeyConfig( // optional config of private key. It will be installed in server to use TLS with custom certificate. More info here: https://core.telegram.org/bots/webhooks#a-certificate-where-do-i-get-one-and-how\n \"/path/to/keystore.jks\",\n \"KeystorePassword\",\n \"Keystore key alias name\",\n \"KeystoreAliasPassword\"\n ),\n scope, // Kotlin coroutine scope for internal transforming of media groups\n filter.asUpdateReceiver\n)\nThe result will be the same as in previous example: server will start its working and handling of updates on 0.0.0.0:8080/subroute. The difference here is that in case if this bot must not answer or send some requiests - it will not be necessary to create bot for receiving of updates.
includeWebhookHandlingInRoute and includeWebhookHandlingInRouteWithFlows","text":"For these extensions you will need to start your server manualy. In common case it will look like:
val scope = CoroutineScope(Dispatchers.Default)\n\nval filter = flowsUpdatesFilter {\n // ...\n}\n\nval environment = applicationEngineEnvironment {\n module {\n routing {\n includeWebhookHandlingInRoute(\n scope,\n {\n it.printStackTrace()\n },\n filter.asUpdateReceiver\n )\n }\n }\n connector {\n host = \"0.0.0.0\"\n port = 8080\n }\n}\n\nembeddedServer(CIO, environment).start(true) // will start server and wait its stoping\nIn the example above server will started and binded for listening on 0.0.0.0:8080.
Hello :) It is my libraries docs place and I glad to welcome you here. I hope, this documentation place will help you.
"},{"location":"index.html#projects","title":"Projects","text":"KronScheduler is the simple interface with only one function next. This function optionally get as a parameter DateTime which will be used as start point for the calculation of next trigger time. This function will return the next DateTime when something must happen.
Default realisation (CronDateTimeScheduler) can be created using several ways:
buildSchedule (or createSimpleScheduler) functions with crontab-like syntax parameterbuildSchedule (or SchedulerBuilder object), which using lambda to configure schedulerIn the examples below the result of created scheduler will be the same.
"},{"location":"krontab/describing/krontabscheduler.html#crontab-like-way","title":"Crontab-like way","text":"Crontab-like syntax
See String format for more info about the crontab-line syntax
This way will be very useful for cases when you need to configure something via external configuration (from file on startup or via some parameter from requests, for example):
val schedule = \"5 * * * *\"\nval scheduler = buildSchedule(schedule)\nscheduler.asFlow().onEach {\n// this block will be called every minute at 5 seconds\n}.launchIn(someCoroutineScope)\nIn case of usage builder (lets call it lambda way), you will be able to configure scheduler in more type-safe way:
val scheduler = buildSchedule {\nseconds {\nat(5)\n}\n}\nscheduler.asFlow().onEach {\n// this block will be called every minute at 5 seconds\n}.launchIn(someCoroutineScope)\nYou are always able to use your own realisation of scheduler. For example:
class RandomScheduler : KronScheduler {\noverride suspend fun next(relatively: DateTime): DateTime {\nreturn relatively + DateTimeSpan(seconds = Random.nextInt() % 60)\n}\n}\nIn the example above we have created RandomScheduler, which will return random next time in range 0-60 seconds since relatively argument.
As in crontab util, this library have almost the same format of string:
Int Any Int 0..6 0..999 Suffix - - - - - - o w ms Optional \u274c \u274c \u274c \u274c \u274c \u2705 \u2705 \u2705 \u2705 Full syntax support \u2705 \u2705 \u2705 \u2705 \u2705 \u2705 \u274c \u2705 \u2705 Position 0 1 2 3 4 Any after months Any after months Any after months Any after months Examples 0, */15, 30 0, */15, 30 0, */15, 22 0, */15, 30 0, */5, 11 0, */15, 30 60o (UTC+1) 0w, */2w, 4w 0ms, */150ms, 300ms Example with almost same description:
/-------------------- (0-59) \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7 Seconds\n| /------------------ (0-59) \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7 Minutes\n| | /---------------- (0-23) \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7 Hours\n| | | /-------------- (0-30) \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7 Days of months\n| | | | /------------ (0-11) \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7 Months\n| | | | | /---------- (optional, any int) Year\n| | | | | | /-------- (optional) \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7 Timezone offset\n| | | | | | | /----- (optional, 0-6) \u00b7\u00b7\u00b7 Week days\n| | | | | | | | /-- (optional, 0-999) \u00b7 Milliseconds (0 by default)\n* * * * * * 0o *w 0ms\nYears, timezone, week days and milliseconds are optional settings. Next snippets are equal:
*/15 * * * *\n*/15 * * * * * // with year\n*/15 * * * * * 0ms // with year and milliseconds\nCurrently the library support next syntax for date/time elements:
{int}-{int} - ranges{int}/{int} - start/step*/{int} - every {int}{int} - just at the time{other_element},{other_element} - listingF or f - first possible valueL or l - last possible value (last day of month, for example)Ranges are working like common rangeTo (or ..) in kotlin:
0-5 * * * *\nIn the example above scheduler will trigger every second from the beginning of the minute up to fifth second of minute.
"},{"location":"krontab/describing/string-format.html#startstep","title":"Start/Step","text":"Start/step is a little bit more complicated syntax. It means start from the first element, repeat triggering every second element. Examples:
5/15 * * * *\nMeans that each minute starting from fifth second it will repeat triggering every fifteenth second: 5, 20, 35, 50.
Every is more simple syntax and could be explained as a shortcut for 0/{int}. Example:
*/15 * * * *\nMeans that each minute it will repeat triggering every fifteenth second: 0, 15, 30, 45.
The most simple syntax. It means, that scheduler will call triggering every time when element was reached:
15 * * * *\nMeans that each minute scheduler will call triggering at the fifteenth second.
"},{"location":"krontab/describing/string-format.html#listing","title":"Listing","text":"All the previous elements can be combined with listing. Lets just see several examples:
0,10 * * * *\nWill trigger every minute at the 0 and 10 seconds (see Just at the time)
0-5,10 * * * *\nWill trigger every minute from 0 to 5 seconds and at the 10 seconds (see Ranges)
0/5 * * * * for every five seconds triggering0/5,L * * * * for every five seconds triggering and on 59 second0/15 30 * * * for every 15th seconds in a half of each hour0/15 30 * * * 500ms for every 15th seconds in a half of each hour when milliseconds equal to 5001 2 3 F,4,L 5 for triggering in near first second of second minute of third hour of first, fifth and last days of may1 2 3 F,4,L 5 60o for triggering in near first second of second minute of third hour of first, fifth and last days of may with timezone UTC+01:001 2 3 F,4,L 5 60o 0-2w for triggering in near first second of second minute of third hour of first, fifth and last days of may in case if it will be in Sunday-Tuesday week days with timezone UTC+01:001 2 3 F,4,L 5 2021 for triggering in near first second of second minute of third hour of first, fifth and last days of may of 2021st year1 2 3 F,4,L 5 2021 60o for triggering in near first second of second minute of third hour of first, fifth and last days of may of 2021st year with timezone UTC+01:001 2 3 F,4,L 5 2021 60o 0-2w for triggering in near first second of second minute of third hour of first, fifth and last days of may of 2021st year if it will be in Sunday-Tuesday week days with timezone UTC+01:001 2 3 F,4,L 5 2021 60o 0-2w 500ms for triggering in near first second of second minute of third hour of first, fifth and last days of may of 2021st year if it will be in Sunday-Tuesday week days with timezone UTC+01:00 when milliseconds will be equal to 500Not very often. It depend on libraries (coroutines, korlibs/klock) updates and on some new awesome, but lightweight, features coming.
"},{"location":"krontab/introduction/faq.html#where-this-library-could-be-useful","title":"Where this library could be useful?","text":"First of all, this library will be useful for long uptime applications which have some tasks to do from time to time.
"},{"location":"krontab/introduction/faq.html#how-to-use-crontab-like-syntax","title":"How to use crontab-like syntax?","text":"In two words, you should call buildSchedule or createSimpleScheduler:
buildSchedule(\"5 * * * *\").asFlow().collect { /* do something */ }\nYou can read more about syntax in String format section.
"},{"location":"krontab/introduction/how-to-use.html","title":"How to use","text":""},{"location":"krontab/introduction/how-to-use.html#previous-pages","title":"Previous pages","text":"buildSchedule","text":"Custom KronScheduler
You always able to create your own scheduler. In this section will be presented different ways and examples around standard CronDateTimeScheduler builders buildSchedule. You can read about schedulers in KrontabScheduler
Currently, buildSchedule is the recommended start point for every scheduler. Usually, it is look like:
val scheduler = buildSchedule(\"5 * * * *\")\nOr:
val scheduler = buildSchedule {\nseconds {\nat(5)\n}\n}\nOn the top of any KronScheduler currently there are several groups of extensions:
All executes are look like do.... All executes are described below:
doOnce - will get the next time for executing, delay until that time and call block with returning of the block resultdoWhile - will call doOnce while it will return true (that means that block must return true if it expects that next call must happen). In two words: it will run while block returning truedoInfinity - will call the block using doWhile with predefined returning true. In two words: it will call block while it do not throw errorShortcuts are the constants that are initializing in a lazy way to provide preset KronSchedulers. For more info about KrontabScheduler you can read its own page.
AnyTimeScheduler - will always return incoming DateTime as nextEvery*Scheduler - return near * since the passed relatively:EverySecondSchedulerEveryMinuteSchedulerEveryHourSchedulerEveryDayOfMonthSchedulerEveryMonthSchedulerEveryYearSchedulerHere currently there is only one extension for KronScheduler: KronScheduler#asFlow. As a result you will get Flow<DateTime> (in fact SchedulerFlow) which will trigger next emit on each not null next DateTime
In two words, you must add dependency dev.inmo:krontab:$krontab_version to your project. The latest version presented by next badge:
To use this library, you will need to include MavenCentral repository in you project
mavenCentral()\nNext snippets must be placed into your dependencies part of build.gradle (for gradle) or pom.xml (for maven).
implementation \"dev.inmo:krontab:$krontab_version\"\n<dependency>\n<groupId>dev.inmo</groupId>\n<artifactId>krontab</artifactId>\n<version>${krontab_version}</version>\n</dependency>\nKSLog is a simple multiplatform tool for native logging.
"},{"location":"kslog/logging.html","title":"Logging","text":"Message type notice
On this page all the messages will be just simple String, but you may pass any object as the message
As has been said in the setup section, this library contains next levels of logging with their default representations on each platform:
Weight (by order) LogLevel name JS JVM Loggers Android 0 DEBUG console.log Level.FINEST Log.d 1 VERBOSE console.info Level.FINE Log.v 2 INFO console.info Level.INFO Log.i 3 WARNING console.warn Level.WARNING Log.w 4 ERROR console.error Level.SEVERE Log.e 5 ASSERT console.error Level.SEVERE Log.wtfEach of these levels have fullname and shortname shortcat extensions:
KSLog.debug/KSLog.d/KSLog.dSKSLog.verbose/KSLog.v/KSLog.vSKSLog.info/KSLog.i/KSLog.iSKSLog.warning/KSLog.w/KSLog.wSKSLog.error/KSLog.e/KSLog.eSKSLog.assert/KSLog.wtf/KSLog.wtfSAnd any of these shortcuts may accept one of several arguments combinations:
S suffix for suspendable messages creating, for exampleSo, when you want to log some expected exception, there are three common ways to do it:
val logger = KSLog.default\n// with callback\nlogger.info(tag, throwable) {\n\"Some your message for this event\"\n}\n// with suspendable callback\nlogger.infoS(tag, throwable) {\nwithContext(Dispatchers.Default) {\n\"Some your message for this event\"\n}\n}\n// Just with message\nlogger.info(\"Some your message for this event\", throwable)\n// With message and tag as strings\nlogger.info(tag, \"Some your message for this event\", throwable)\nOf course, any of this calls can be shortenned:
val logger = KSLog.default\n// with callback\nlogger.i(tag, throwable) {\n\"Some your message for this event\"\n}\n// with suspendable callback\nlogger.iS(tag, throwable) {\nwithContext(Dispatchers.Default) {\n\"Some your message for this event\"\n}\n}\n// Just with message\nlogger.i(\"Some your message for this event\", throwable)\n// With message and tag as strings\nlogger.i(tag, \"Some your message for this event\", throwable)\nThere is special shortcat - for base performLog. In that case the only change is that you will require to pass the LogLevel more obviously:
val logger = KSLog.default\n// with callback\nlogger.log(LogLevel.INFO, tag, throwable) {\n\"Some your message for this event\"\n}\n// with suspendable callback\nlogger.logS(LogLevel.INFO, tag, throwable) {\nwithContext(Dispatchers.Default) {\n\"Some your message for this event\"\n}\n}\n// Just with message\nlogger.log(LogLevel.INFO, \"Some your message for this event\", throwable)\n// With message and tag as strings\nlogger.log(LogLevel.INFO, tag, \"Some your message for this event\", throwable)\nOR
val logger = KSLog.default\n// with callback\nlogger.l(LogLevel.INFO, tag, throwable) {\n\"Some your message for this event\"\n}\n// with suspendable callback\nlogger.lS(LogLevel.INFO, tag, throwable) {\nwithContext(Dispatchers.Default) {\n\"Some your message for this event\"\n}\n}\n// Just with message\nlogger.l(LogLevel.INFO, \"Some your message for this event\", throwable)\n// With message and tag as strings\nlogger.l(LogLevel.INFO, tag, \"Some your message for this event\", throwable)\nimplementation \"dev.inmo:kslog:$kslog_version\"\nimplementation(\"dev.inmo:kslog:$kslog_version\")\n<dependency>\n<groupId>dev.inmo</groupId>\n<artifactId>kslog</artifactId>\n<version>${kslog_version}</version>\n</dependency>\nThe main point in setup in your code is to setup default logger:
KSLog.default = KSLog(\"defaultTag\")\nYou may use custom messageFormatter in any of KSLog factory to customize output of KSLog logging. For example:
KSLog(\n\"loggingWithCustomFormat\",\nmessageFormatter = { level, tag, message, throwable ->\nprintln(\"[$level] $tag - $message: $throwable\")\n}\n)\nAdditionally you may use one of several different settings:
minLoggingLevel - minimal logging level for the log which will be logged. The order of log level is next:levels - and iterable with the levels which should be loggedfirstLevel,secondLevel,otherLevels - as levels, but vararg :)In case you are passing minLoggingLevel, the level and more important levels will be passed to logs. For example, when you are settings up your logger as in next snippet:
val logger = KSLog(\n\"exampleTag\",\nminLoggingLevel = LogLevel.INFO\n)\nThe next levels will be logged with logger:
INFOWARNINGERRORASSERTIt is logger which will call incoming performLogCallback on each logging. This logger can be create simply with one callback:
KSLog { level, tag, message, throwable ->\nprintln(\"[$level] $tag - $message: $throwable\")\n}\nIt is simple value class which can be used for zero-cost usage of some tag and calling for KSLog.default. For example, if you will create tag logger with next code:
val logger = TagLogger(\"tagLoggerTag\")\nThe logger will call KSLog.default with the tag tagLoggerTag on each calling of logging.
This pretty simple logger will call its fallbackLogger only in cases when incoming messageFilter will return true for logging:
val baseLogger = KSLog(\"base\") // log everything with the tag `base` if not set other\nval filtered = baseLogger.filtered { _, t, _ ->\nt == \"base\"\n}\nIn the example above baseLogger will perform logs in two ways: when it has been called directly or when we call log performing with the tag \"base\" or null. Besides, you can see there extension filtered which allow to create FilterKSLog logger with simple lambda.
This logger accepts map of types with the target loggers. You may build this logger with the special simple DSL:
val baseLogger = KSLog(\"base\") // log everything with the tag `base` if not set other\nval typed = buildTypedLogger {\non<Int>(baseLogger) // log all ints to the baseLogger\non<Float> { _, _, message, _ ->// log all floats to the passed logger\nprintln(message.toString()) // just print all floats\n}\ndefault { level, tag, message, throwable ->\nKSLog.performLog(level, tag, message, throwable)\n}\n}\nThere are two things which can be useful in your code: logger and logTag extensions. logTag is the autocalculated by your object classname tag. logger extension can be used with applying to any object like in the next snippet:
class SomeClass {\ninit {\nlogger.i(\"inited\")\n}\n}\nThe code above will trigger calling of logging in KSLog.default with level LogLevel.INFO using tag SomeClass and message \"inited\". As you could have guessed, logger is using TagLogger with logTag underhood and the most expensive operation here is automatical calculation of logTag.
loggerFor JVM you may setup additionally use java loggers as the second parameter of KSLog factory. For example:
KSLog(\n\"yourTag\"\nLogger.getLogger(\"YourJavaLoggerName\")\n)\nIn the telegram system there are two types of keyboards:
Reply Inline Keyboard for each user in the chat Keyboard linked to the certain messageLow-level way to create keyboard looks like in the next snippet:
ReplyKeyboardMarkup(\nmatrix {\nrow {\nadd(SimpleKeyboardButton(\"Simple text\"))\n// ...\n}\n// ...\n}\n)\nIn case you wish to create inline keyboard, it will look like the same as for reply keyboard. But there is another way. The next snippet will create the same keyboard as on the screenshots above:
// reply keyboard\nreplyKeyboard {\nrow {\nsimpleButton(\"7\")\nsimpleButton(\"8\")\nsimpleButton(\"9\")\nsimpleButton(\"*\")\n}\nrow {\nsimpleButton(\"4\")\nsimpleButton(\"5\")\nsimpleButton(\"6\")\nsimpleButton(\"/\")\n}\nrow {\nsimpleButton(\"1\")\nsimpleButton(\"2\")\nsimpleButton(\"3\")\nsimpleButton(\"-\")\n}\nrow {\nsimpleButton(\"0\")\nsimpleButton(\".\")\nsimpleButton(\"=\")\nsimpleButton(\"+\")\n}\n}\n// inline keyboard\ninlineKeyboard {\nrow {\ndataButton(\"Get random music\", \"random\")\n}\nrow {\nurlButton(\"Send music to friends\", \"https://some.link\")\n}\n}\nBot API allows you to send live locations and update them during their lifetime. In this library there are several ways to use this API:
In the Bot API there is no independent sendLiveLocation method, instead it is suggested to use sendLocation with setting up live_period. In this library in difference with original Bot API live location is special request. It was required because of in fact live locations and static locations are different types of location info and you as bot developer may interact with them differently.
Anyway, in common case the logic looks like:
In difference with sendLiveLocation, startLiveLocation using LiveLocationProvider. With this provider you need not to handle chat and message ids and keep some other data for location changes. Instead, you workflow with provider will be next:
Besides, LiveLocationProvider contains different useful parameters about live location
This way of live locations handling is based on coroutines Flow and allow you to pass some external Flow with EditLiveLocationInfo. So, workflow:
flow {\nvar i = 0\nwhile (isActive) {\nval newInfo = EditLiveLocationInfo(\nlatitude = i.toDouble(),\nlongitude = i.toDouble(),\nreplyMarkup = flatInlineKeyboard {\ndataButton(\"Cancel\", \"cancel\")\n}\n)\nemit(newInfo)\ni++\ndelay(10000L) // 10 seconds\n}\n}\nval currentMessageState = MutableStateFlow<ContentMessage<LocationContent>?>(null)\nhandleLiveLocation(\nit.chat.id,\nlocationsFlow,\nsentMessageFlow = FlowCollector { currentMessageState.emit(it) }\n)\n// this code will be called after `locationsFlow` will ends\nscope.launch {\nhandleLiveLocation(\nit.chat.id,\nlocationsFlow,\nsentMessageFlow = FlowCollector { currentMessageState.emit(it) }\n)\n}\n// this code will be called right after launch will be completed\nSee our example to get more detailed sample
"},{"location":"tgbotapi/dsls/text.html","title":"Text","text":"For the text creating there are several tools. The most simple one is to concatenate several text sources to make list of text sources as a result:
val sources = \"Regular start of text \" + bold(\"with bold part\") + italic(\"and italic ending\")\nBut there is a little bit more useful way: entities builder:
val items = (0 until 10).map { it.toString() }\nbuildEntities(\" \") {// optional \" \" auto separator which will be pasted between text sources\n+\"It is regular start too\" + bold(\"it is bold as well\")\nitems.forEachIndexed { i, item ->\nif (i % 2) {\nitalic(item)\n} else {\nstrikethrough(item)\n}\n}\n}\nIn the code above we are creating an items list just for demonstrating that inside of buildEntities body we may use any operations for cunstructing our result list of TextSources. As a result, will be created the list which will looks like in telegram as \u201cIt is regular start too it is bold as well 0 ~~1~~ 2 ~~3~~ 4 ~~5~~ 6 ~~7~~ 8 ~~9~~\u201d.
There are several places you need to visit for starting work with any Telegram Bot framework on any language:
Anyway, the most important link is How do I create a bot? inside of Telegram Bot API
"},{"location":"tgbotapi/introduction/before-any-bot-project.html#next-steps","title":"Next steps","text":"Examples info
A lot of examples with using of Telegram Bot API you can find in this github repository
"},{"location":"tgbotapi/introduction/first-bot.html#the-most-simple-bot","title":"The most simple bot","text":"The most simple bot will just print information about itself. All source code you can find in this repository. Our interest here will be concentrated on the next example part:
suspend fun main(vararg args: String) {\nval botToken = args.first()\nval bot = telegramBot(botToken)\nprintln(bot.getMe())\n}\nSo, let\u2019s get understanding, about what is going on:
suspend fun main(vararg args: String):suspend required for making of requests inside of this function. For more info you can open official documentation for coroutins. In fact, suspend fun main is the same that fun main() = runBlocking {} from examplesval botToken = args.first(): here we are just getting the bot token from first arguments of command lineval bot = telegramBot(botToken) : inside of bot will be RequestsExecutor object which will be used for all requests in any project with this libraryprintln(bot.getMe()): here happens calling of getMe extensionAs a result, we will see in the command line something like
ExtendedBot(id=ChatId(chatId=123456789), username=Username(username=@first_test_ee17e8_bot), firstName=Your bot name, lastName=, canJoinGroups=false, canReadAllGroupMessages=false, supportsInlineQueries=false)\nThere are three projects:
TelegramBotAPI Core - project with base for all working with Telegram Bot APITelegramBotAPI API Extensions - extension of TelegramBotAPI with functions for more comfortable work with Telegram Bot APITelegramBotAPI Utils Extensions - extension of TelegramBotAPI with functions for extending of different things like retrieving of updatesTelegramBotAPI
Also, there is an aggregator-version tgbotapi, which will automatically include all projects above. It is most recommended version due to the fact that it is including all necessary tools around TelegramBotAPI Core, but it is optionally due to the possible restrictions on the result methods count (for android) or bundle size
Examples
You can find full examples info in this repository. In this repository there full codes which are working in normal situation. Currently, there is only one exception when these examples could work incorrectly: you are living in the location where Telegram Bot API is unavailable. For solving this problem you can read Proxy setup part
"},{"location":"tgbotapi/introduction/including-in-your-project.html#notice-about-repository","title":"Notice about repository","text":"To use this library, you will need to include Maven Central repository in your project
mavenCentral()\n<repository>\n<id>central</id>\n<name>mavenCentral</name>\n<url>https://repo1.maven.org/maven2</url>\n</repository>\nBesides, there is developer versions repo. To use it in your project, add the repo in repositories section:
maven {\nurl \"https://git.inmo.dev/api/packages/InsanusMokrassar/maven\"\n}\n<repository>\n<id>dev.inmo</id>\n<name>InmoDev</name>\n<url>https://git.inmo.dev/api/packages/InsanusMokrassar/maven</url>\n</repository>\nAs tgbotapi_version variable in next snippets will be used variable with next last published version:
implementation \"dev.inmo:tgbotapi:$tgbotapi_version\"\n<dependency>\n<groupId>dev.inmo</groupId>\n<artifactId>tgbotapi</artifactId>\n<version>${tgbotapi_version}</version>\n</dependency>\nAs tgbotapi_version variable in next snippets will be used variable with next last published version:
implementation \"dev.inmo:tgbotapi.core:$tgbotapi_version\"\n<dependency>\n<groupId>dev.inmo</groupId>\n<artifactId>tgbotapi.core</artifactId>\n<version>${tgbotapi_version}</version>\n</dependency>\nAs tgbotapi_version variable in next snippets will be used variable with next last published version:
implementation \"dev.inmo:tgbotapi.api:$tgbotapi_version\"\n<dependency>\n<groupId>dev.inmo</groupId>\n<artifactId>tgbotapi.api</artifactId>\n<version>${tgbotapi_version}</version>\n</dependency>\nAs tgbotapi_version variable in next snippets will be used variable with next last published version:
implementation \"dev.inmo:tgbotapi.utils:$tgbotapi_version\"\n<dependency>\n<groupId>dev.inmo</groupId>\n<artifactId>tgbotapi.utils</artifactId>\n<version>${tgbotapi_version}</version>\n</dependency>\nIn some locations Telegram Bots API urls will be unavailable. In this case all examples will just throw exception like:
Exception in thread \"main\" java.net.ConnectException: Connection refused\n at sun.nio.ch.SocketChannelImpl.checkConnect(Native Method)\nat sun.nio.ch.SocketChannelImpl.finishConnect(SocketChannelImpl.java:717)\nat io.ktor.network.sockets.SocketImpl.connect$ktor_network(SocketImpl.kt:36)\nat io.ktor.network.sockets.SocketImpl$connect$1.invokeSuspend(SocketImpl.kt)\nat kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)\nat kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:56)\nat kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.kt:571)\nat kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.kt:738)\nat kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.runWorker(CoroutineScheduler.kt:678)\nat kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.run(CoroutineScheduler.kt:665)\nProcess finished with exit code 1\nThere are several ways to solve this problem:
First of all, you will need to use one more library:
build.gradle:
implementation \"io.ktor:ktor-client-okhttp:2.0.1\"\nDependency note
In the snippet above was used version 2.0.1 which is actual for TelegramBotAPI at the moment of filling this documentation (May 22 2022, TelegramBotAPI version 2.0.0) and you can update version of this dependency in case if it is outdated.
For configuring proxy for your bot inside your program, you can use next snippet:
val botToken = \"HERE MUST BE YOUR TOKEN\"\nval bot = telegramBot(botToken) {\nktorClientEngineFactory = OkHttp\nproxy = ProxyBuilder.socks(\"127.0.0.1\", 1080)\n}\nExplanation line by line:
val botToken = \"HERE MUST BE YOUR TOKEN\" - here we are just creating variable botTokenval bot = telegramBot(botToken) { - start creating botktorClientEngineFactory = OkHttp - setting up engine factory of our bot. On the time of documentation filling, OkHttp is one of the engines in Ktor system which supports socks proxy. More you can read on Ktor site in subparts about engines and proxyproxy = ProxyBuilder.socks(\"127.0.0.1\", 1080) - here we are setting up our proxy. Here was used local server which (as assumed) will connect to server like shadowsocksAPI extensions is a module which you may include in your project in addition to core part. In most cases this module will allow just use syntax like bot.getUpdates() instead of bot.execute(GetUpdates()), but there are several other things you will achieve with that syntax.
This functionality allow you to build bot in more unified and comfortable way than standard creating with telegramBot function
buildBot(\n\"TOKEN\"\n) {\nproxy = ProxyBuilder.socks(host = \"127.0.0.1\", port = 4001) // just an example, more info on https://ktor.io/docs/proxy.html\nktorClientConfig = {\n// configuring of ktor client\n}\nktorClientEngineFactory = {\n// configuring of ktor client engine \n}\n}\nIn standard library requests there are no way to download some file retrieved in updates or after requests. You may use syntax like bot.downloadFile(file) where file is TelegramMediaFile from telegram, FileId or even PathedFile from GetFile request (sources).
By default, you should handle updates of Live location by your code. But with extension bot#startLiveLocation you may provide all necessary startup parameters and handle updates with just calling updateLocation for retrieved LiveLocationProvider.
There are several things you may read next:
Behaviour builder with FSM is based on the MicroUtils FSM. There are several important things in FSM:
State - any object which implements State interfaceStateHandler (or CheckableHandlerHolder) - the handler of statesStatesMachine have two methods:
start which will start work of machinestartChain which will add new state for handlingThe most based way to create StatesMachine and register StateHandlers looks like in the next snippet:
buildFSM<TrafficLightState> {\nstrictlyOn<SomeState> {\n// state handling\n}\n}.start(CoroutineScope(...)).join()\nFull example
You may find full example of FSM usage in the tests of FSM in MicroUtils
So, you must do next steps before you will launch your bot with FSM:
There are several extensions for TelegramBot to create your bot with FSM:
All of them will take as an callback some object with type CustomBehaviourContextReceiver and will looks like in the next snippet:
telegramBotWithBehaviourAndFSMAndStartLongPolling<YourStateType>(\"BOT_TOKEN\") {\n// here you may use any operations from BehaviourBuilder\n// here you may use any operations from BehaviourContextWithFSMBuilder like strictlyOn and others\n}\nIn the previous pages about updates handling and was mentioned that currently in the most cases you should use Flows. So, there is an improvement for that system which hide direct work with flows and allow you to create more declarative logic of your bot.
"},{"location":"tgbotapi/logic/behaviour-builder.html#main-parts-of-behaviour-builder","title":"Main parts of Behaviour Builder","text":"There are several things you should know for better understanding of behaviour builder:
on* extensions for BehaviourContext which allow you to create reaction on some updatewait* extensions which you may use in buildBehaviour function, but it is recommended to use it in bodies of triggersAs was said above, there is buildBehaviour function which allow you set up your bot logic. Let\u2019s see an example:
val bot = telegramBot(\"TOKEN\")\nbot.buildBehaviour {\nonCommand(\"start\") { // creating of trigger\nval message = it\nval content = message.content\nreply(message, \"Ok, send me one photo\") // send text message with replying on incoming message\nval photoContent = waitPhoto().first() // waitPhoto will return List, so, get first element\nval photo = downloadFile(photoContent) // ByteArray of photo\n// some logic with saving of photos\n}\n}\nIn most cases there are opportunity to filter some of messages before starting of main logic. Let\u2019s look at this using the example above:
val bot = telegramBot(\"TOKEN\")\nbot.buildBehaviour {\nonCommand(\n\"start\",\ninitialFilter = {\nit.content.textSources.size == 1 // make sure that user has sent /start without any additions\n}\n) {\n// ...\n}\n}\nOR
val bot = telegramBot(\"TOKEN\")\nbot.buildBehaviour {\nonCommand(\n\"start\",\nrequireOnlyCommandInMessage = true // it is default, but you can overwrite it with `requireOnlyCommandInMessage = false`\n) {\n// ...\n}\n}\nUnfortunatelly, exceptions handling in this library is a bit difficult in some places, but that have at least two reasons: flexibility and usability.
"},{"location":"tgbotapi/logic/exceptions-handling.html#in-place-handling","title":"\u201cIn place\u201d handling","text":"In case you know, where exceptions are happening, you may use several tools for exceptions catching:
If you prefer to receive Result objects instead of some weird callbacks, you may use the next syntax:
safelyWithResult {\n// do something\n}.onSuccess { // will be called if everything is right\n// handle success\n}.onFailure { // will be called if something went wrong\n// handle error\nit.printStackTrace()\n}.getOrThrow() // will return value or throw exception\nAlso there is more simple (in some cases) way to handle exceptions with callbacks:
safely(\n{\n// handle error\nit.printStackTrace()\nnull // return value\n}\n) {\n// do something\n}\nThere are two types of handling:
safely(\n{\nit.printStackTrace()\n\"error\"\n}\n) {\nerror(\"Hi :)\") // emulate exception throwing\n\"ok\"\n} // result will be with type String\nsafely, but this type by default allow to return nullable value (when exception was thrown) instead of just throwing (as with safely): safelyWithouExceptions {\n// do something\n} // will returns nullable result type\nThe most simple way to configure exceptions handling is to change CoroutineContext when you are creating your CoroutineScope for bot processing:
val bot = telegramBot(\"TOKEN\")\nbot.buildBehaviour (\nscope = scope,\ndefaultExceptionsHandler = {\nit.printStackTrace()\n}\n) {\n// ...\n}\nOR
val bot = telegramBotWithBehaviour (\n\"TOKEN\",\nscope = scope,\ndefaultExceptionsHandler = {\nit.printStackTrace()\n}\n) {\n// ...\n}\nHere we have used ContextSafelyExceptionHandler class. It will pass default handling of exceptions and will call the block in most cases when something inside of your bot logic has thrown exception.
According to the documentation there are several ways to work with files:
typealias for the FileId)There are several cases you may need in your app to work with files:
FileId (for sending in future)The most simple way to send some file is to get file id and send it. You may get file id from any message with media. For example, if you have received some Message, you may use asCommonMessage conversation to be able to get its content and then convert it to some content with media. Full code here:
val message: Message;\nval fileId = message.asCommonMessage() ?.withContent<MediaContent>() ?.content ?.media ?.fileId;\nWAT? O.o
In the code above we get some message, safely converted it to CommonMessage with asCommonMessage, then safely took its content via withContent<MediaContent>() ?.content and then just get its media file id.
There are three ways to download files:
ByteArrayByteReadChannelAllocator which allow to retrieve ByteReadChannel and do whatever you want with it[JVM Only] Download it directly to file or temporal fileAPI extensions","text":""},{"location":"tgbotapi/logic/files-handling.html#files-jvmandroid","title":"Files (JVM/Android)","text":"val bot: TelegramBot;\nval fileId: FileId;\nval outputFile: File;\nbot.downloadFile(fileId, outputFile)\nSee downloadFile extension docs in the JVM tab to get more available options
There is also way with saving of data into temporal file. That will allow you to do with data whatever you want without high requirements to memory or network connection:
val bot: TelegramBot;\nval fileId: FileId;\nval tempFile: File = bot.downloadFileToTemp(fileId)\nSee downloadFileToTemp extension docs to get more available options
"},{"location":"tgbotapi/logic/files-handling.html#byte-read-channel","title":"Byte read channel","text":"val bot: TelegramBot;\nval fileId: FileId;\nval bytes: ByteReadChannelAllocator = bot.downloadFileStream(fileId)\nSee downloadFileStream extension docs to get more available options
"},{"location":"tgbotapi/logic/files-handling.html#byte-read-channel-allocator","title":"Byte read channel allocator","text":"val bot: TelegramBot;\nval fileId: FileId;\nval bytes: ByteReadChannelAllocator = bot.downloadFileStreamAllocator(fileId)\nSee downloadFileStreamAllocator extension docs to get more available options
"},{"location":"tgbotapi/logic/files-handling.html#byte-arrays","title":"Byte arrays","text":"val bot: TelegramBot;\nval fileId: FileId;\nval bytes: ByteArray = bot.downloadFile(fileId)\nSee downloadFile extension docs to get more available options
"},{"location":"tgbotapi/logic/files-handling.html#low-level-or-how-does-it-work","title":"Low level orhow does it work?","text":"You may download file with streams or with downloading into the memory first. On low level you should do several things. They are presented in next snippet:
val bot: TelegramBot;\nval fileId: FileId;\nval pathedFile: PathedFile = bot.execute(GetFile(fileId))\nval downloadedBytes: ByteArray = bot.execute(DownloadFile(pathedFile.filePath))\nIn the snippet above we are getting file PathedFile by its FileId and use it to download file bytes into memory using DownloadFile request.
You may use almost the same way but with byte read channel allocator:
val bot: TelegramBot;\nval fileId: FileId;\nval pathedFile: PathedFile = bot.execute(GetFile(fileId))\nval channelAllocator: ByteReadChannelAllocator = bot.execute(DownloadFileStream(pathedFile.filePath))\nval byteReadChannel: ByteReadChannel = channelAllocator()\nAnd then you may look into ByteReadChannel docs to get more info about what you can do with that.
Several useful links
Of course, in most cases you must be sure that file have correct type.
"},{"location":"tgbotapi/logic/files-handling.html#fileid-and-fileurl","title":"FileId and FileUrl","text":"It is the most simple way to send any media in Telegram, but this way have several restrictions:
FileId which has retrieved for file should not (and probably will not too) equal to the FileId retrieved by some other botJS Restrictions
Sending via file is accessible from all supported platforms, but there is small note about JS - due to restrictions of work with streams and stream-like data (JS have no native support of files streaming) on this platform all the files will be loaded inside of RAM before the sending to the telegram services.
Sending via file is available throw the MultipartFile. There are several wayt to get it:
MultipartFile(\"filename.jpg\") { /* here Input allocation */ }ByteArray, ByteReadChannel, ByteReadChannelAllocator or File (on any platform)In most cases, sending via files looks like in the next snippet:
val file: File;\nbot.sendDocument(chatId, file.asMultipartFile())\nThe base version of library was done a lot of time ago and just got several additions related to improvements, updates in Telegram Bot API or some requests from our community.
"},{"location":"tgbotapi/logic/low-level-work-with-bots.html#base-things","title":"Base things","text":"There are several important things in context of this library:
TelegramBot)So, in most cases all your request calls with simplified api of this library (like bot.getMe()) will looks like bot.execute(GetMe). Result of these calls is defined in type of any request (for example, for GetMe request the result type is ExtendedBot). As a result, you can avoid any extension api (like special API extensions) and use low level request with full controlling of the whole logic flow.
As was written above, it will require some request:
val updates = bot.execute(GetUpdates())\nResult type of GetUpdates request is Update. You may find inheritors of this interface in Update kdocs.
"},{"location":"tgbotapi/logic/low-level-work-with-bots.html#what-is-next","title":"What is next?","text":"As was said above, you may look into our API extensions in case you wish to use more high-level functions instead of bot.execute(SomeRequest()). Besides, it will be very useful to know more about updates retrieving.
As you know, Telegram have the feature named Media Groups. Media groups have several differences with the common messages:
Row updates
In tgbotapi there is no any additional handling of media groups by default and in case you will use simple bot.getUpdates, you will get the list of row updates and media groups will be included in this list as separated messages with MediaGroupPartContent. In that case you may use convertWithMediaGroupUpdates to be able to work with media groups as will be described below
In case you are using standard long polling (one of alternatives is telegramBotWithBehaviourAndLongPolling) or webhooks updates will be converted uner the hood and as a result, you will take media groups as a content in one message:
telegramBotWithBehaviourAndLongPolling(\n\"token\"\n) {\nonVisualGallery { // it: CommonMessage<MediaGroupContent<VisualMediaGroupPartContent>>\nit.content // MediaGroupContent<VisualMediaGroupPartContent>\nit.content.group // List<MediaGroupCollectionContent.PartWrapper<VisualMediaGroupPartContent>>\nit.content.group.forEach { // it: MediaGroupCollectionContent.PartWrapper<VisualMediaGroupPartContent>\nit.messageId // source message id for current media group part\nit.sourceMessage // source message for current media group part\nit.content // VisualMediaGroupPartContent\nprintln(it.content) // will print current content part info\n}\n}\n}\nKDocs:
In two words, in difference with row Telegram Bot API, you will take media groups in one message instead of messages list.
"},{"location":"tgbotapi/logic/types-conversations.html","title":"Types conversations","text":"One of the most important topics in context of tgbotapi is types conversations. This library is very strong-typed and a lot of things are based on types hierarchy. Lets look into the hierarchy of classes for the Message in 0.35.8:
As you may see, it is a little bit complex and require several tools for types conversation.
"},{"location":"tgbotapi/logic/types-conversations.html#as","title":"As","text":"as conversations will return new type in case if it is possible. For example, when you got Message, you may use asContentMessage conversation to get message with content:
val message: Message;\nprintln(message.asContentMessage() ?.content)\nThis code will print null in case when message is not ContentMessage, and content when is.
require works like as, but instead of returning nullable type, it will always return object with required type OR throw ClassCastException:
val message: Message;\nprintln(message.requireContentMessage().content)\nThis code will throw exception when message is not ContentMessage and print content when is.
when extensions will call passed block when type is correct. For example:
val message: Message;\nmessage.whenContentMessage {\nprintln(it.content)\n}\nCode placed above will print content when message is ContentMessage and do nothing when not
Of course, in most cases here we will look up the way of using utils extnsions, but you may read deeper about updates retrieving here.
"},{"location":"tgbotapi/logic/updates-with-flows.html#phylosophy-of-flow-updates-retrieving","title":"Phylosophy ofFlow updates retrieving","text":"In most updates retrieving processes there are two components: UpdatesFiler and its inheritor FlowsUpdatesFilter. It is assumed, that you will do several things in your app to handle updates:
UpdatesFilter (for example, with flowsUpdatesFilter factory)flowsUpdatesFilter you will set up updates handling in the lambda passed to this factory)Let\u2019s look how it works with the factory above:
// Step 1 - create filter\nval filter = flowsUpdatesFilter {\n// Step 2 - set up handling. In this case we will print any message from group or user in console\nmessageFlow.onEach {\nprintln(it)\n}.launchIn(someCoroutineScope)\n}\n// Step 3 - passing updates to filter\nbot.getUpdates().forEach {\nfilter.asUpdatesReceiver(it)\n}\nSome example with long polling has been described above. But it is more useful to use some factories for it. In this page we will look for simple variant with TelegramBot#longPolling. So, with this function, your handling of updates will looks like:
val bot = telegramBot(\"TOKEN\")\nbot.longPolling {\nmessageFlow.onEach {\nprintln(it)\n}.launchIn(someCoroutineScope)\n}.join()\nThis example looks like the example above with three steps, but there are several important things here:
.join() will suspend your function \ud83d\ude0a longPolling function returns Job and you may use it to:cancel working of long polling (just call job.cancel())join and wait while the work of longPolling will not be completed (it will works infinity if you will not cancel it anywhere)longPolling functionWhat is next?","text":"As a result you can start listen updates and react on it. Next recommended articles:
Preview reading
It is recommended to visit our pages about UpdatesFilters and Webhooks to have more clear understanding about what is happening in this examples page
Heroku is a popular place for bots hosting. In common case you will need to configure webhooks for your server to include getting updates without problems. There are several things related to heroku you should know:
https://<app name>.herokuapp.com/System.getenv(\"PORT\").toInt()Sat Aug 15 5:04:21 +00 2020) there is only one official server engine for ktor which is correctly working with Heroku: Tomcat server engineServer configuration alternatives
Here will be presented variants of configuration of webhooks and starting server. You always able to set webhook manualy, create your own ktor server and include webhooks handling in it or create and start server with only webhooks handling. More info you can get on page Webhooks
"},{"location":"tgbotapi/updates/heroku.html#short-example-with-behaviour-builder","title":"Short example with Behaviour Builder","text":"suspend fun main {\n// This subroute will be used as random webhook subroute to improve security according to the recommendations of Telegram\nval subroute = uuid4().toString()\n// Input/Output coroutines scope more info here: https://kotlinlang.org/docs/coroutines-guide.html\nval scope = CoroutineScope(Dispatchers.IO)\n// Here will be automatically created bot and available inside of lambda where you will setup your bot behaviour\ntelegramBotWithBehaviour(\n// Pass TOKEN inside of your application environment variables\nSystem.getenv(\"TOKEN\"),\nscope = scope\n) {\n// Set up webhooks and start to listen them\nsetWebhookInfoAndStartListenWebhooks(\n// Automatic env which will be passed by heroku to the app\nSystem.getenv(\"PORT\").toInt(),\n// Server engine. More info here: https://ktor.io/docs/engines.html\nTomcat,\n// Pass URL environment variable via settings of application. It must looks like https://<app name>.herokuapp.com\nSetWebhook(\"${System.getenv(\"URL\").removeSuffix(\"/\")}/$subroute\"),\n// Just callback which will be called when exceptions will happen inside of webhooks\n{\nit.printStackTrace()\n},\n// Set up listen requests from outside\n\"0.0.0.0\",\n// Set up subroute to listen webhooks to\nsubroute,\n// BehaviourContext is the CoroutineScope and it is recommended to pass it inside of webhooks server\nscope = this,\n// BehaviourContext is the FlowsUpdatesFilter and it is recommended to pass its asUpdateReceiver as a block to retrieve all the updates\nblock = asUpdateReceiver\n)\n// Test reaction on each command with reply and text `Got it`\nonUnhandledCommand {\nreply(it, \"Got it\")\n}\n}\n// Just potentially infinite await of bot completion\nscope.coroutineContext.job.join()\n}\n// This subroute will be used as random webhook subroute to improve security according to the recommendations of Telegram\nval subroute = uuid4().toString()\nval bot = telegramBot(TOKEN)\nval scope = CoroutineScope(Dispatchers.Default)\nval filter = flowsUpdatesFilter {\nmessageFlow.onEach {\nprintln(it) // will be printed \n}.launchIn(scope)\n}\nval subroute = UUID.randomUUID().toString() // It will be used as subpath for security target as recommended by https://core.telegram.org/bots/api#setwebhook\nval server = bot.setWebhookInfoAndStartListenWebhooks(\n// Automatic env which will be passed by heroku to the app\nSystem.getenv(\"PORT\").toInt(),\n// Server engine. More info here: https://ktor.io/docs/engines.html\nTomcat,\n// Pass URL environment variable via settings of application. It must looks like https://<app name>.herokuapp.com\nSetWebhook(\"${System.getenv(\"URL\").removeSuffix(\"/\")}/$subroute\"),\n// Just callback which will be called when exceptions will happen inside of webhooks\n{\nit.printStackTrace()\n},\n// Set up listen requests from outside\n\"0.0.0.0\",\n// Set up subroute to listen webhooks to\nsubroute,\nscope = scope,\nblock = filter.asUpdateReceiver\n)\nserver.environment.connectors.forEach {\nprintln(it)\n}\nserver.start(false)\nLong polling is a technology of getting updates for cases you do not have some dedicated server or you have no opportunity to receive updates via webhooks. More about this you can read in wiki.
"},{"location":"tgbotapi/updates/long-polling.html#related-topics","title":"Related topics","text":"There are a lot of ways to include work with long polling:
RequestsExecutor#longPollingFlow Is the base way to get all updates cold Flow. Remember, that this flow will not be launched automaticallyRequestsExecutor#startGettingOfUpdatesByLongPolling Old and almost deprecated wayRequestsExecutor#longPolling Works like startGettingOfUpdatesByLongPolling but shorted in a name :)RequestsExecutor#createAccumulatedUpdatesRetrieverFlow Works like longPollingFlow, but flow inside will return only the updates accumulated at the moment of calls (all new updates will not be passed throw this flow)RequestsExecutor#retrieveAccumulatedUpdates Use createAccumulatedUpdatesRetrieverFlow to perform all accumulated updatesRequestsExecutor#flushAccumulatedUpdates Works like retrieveAccumulatedUpdates but perform all updates directly in a place of callingGetUpdates request or RequestsExecutor#getUpdates extensionlongPolling is a simple way to start getting updates and work with bot:
val bot = telegramBot(token)\nbot.longPolling(\ntextMessages().subscribe(scope) { // here \"scope\" is a CoroutineScope\nprintln(it) // will be printed each update from chats with messages\n}\n)\nThe main aim of startGettingOfUpdatesByLongPolling extension was to provide more simple way to get updates in automatic mode:
val bot = telegramBot(token)\nbot.startGettingOfUpdatesByLongPolling(\n{\nprintln(it) // will be printed each update from chats with messages\n}\n)\nThe other way is to use the most basic startGettingOfUpdatesByLongPolling extension:
val bot = telegramBot(token)\nbot.startGettingOfUpdatesByLongPolling {\nprintln(it) // will be printed each update\n}\nDue to the fact, that anyway you will get updates in one format (Update objects), some time ago was solved to create one point of updates filters for more usefull way of updates handling
UpdatesFilter currently have two properties:
asUpdateReceiver - required to represent this filter as common updates receiver which able to get any UpdateallowedUpdates - required to determine, which updates are usefull for this filterAnyway, this filter can\u2019t work with updates by itself. For retrieving updates you should pass this filter to some of getting updates functions (long polling or webhooks).
"},{"location":"tgbotapi/updates/updates-filters.html#simpleupdatesfilter","title":"SimpleUpdatesFilter","text":"SimpleUpdatesFilter is a simple variant of filters. It have a lot of UpdateReceiver properties which can be set up on creating of this object. For example, if you wish to get messages from chats (but not from channels), you can use next snippet:
SimpleUpdatesFilter {\nprintln(it)\n}\nA little bit more modern way is to use FlowsUpdatesFilter. It is very powerfull API of Kotlin Coroutines Flows, built-in support of additional extensions for FlowsUpdatesFilter and Flow<...> receivers and opportunity to split one filter for as much receivers as you want. Filter creating example:
val scope = CoroutineScope(Dispatchers.Default)\nflowsUpdatesFilter {\nmessageFlow.onEach {\nprintln(it)\n}.launchIn(scope)\n}\nIn cases you need not separate logic for handling of messages from channels and chats there are three ways to combine different flows into one:
plus operation and handling of different flows: flowsUpdatesFilter {\n(messageFlow + channelPostFlow).onEach {\nprintln(it) // will be printed each message update from channels and chats both\n}.launchIn(scope)\n}\naggregateFlows: flowsUpdatesFilter {\naggregateFlows(\nscope,\nmessageFlow,\nchannelPostFlow\n).onEach {\nprintln(it) // will be printed each message update from channels and chats both\n}.launchIn(scope)\n}\nFlowsUpdatesFilter extensions: flowsUpdatesFilter {\nallSentMessagesFlow.onEach {\nprintln(it) // will be printed each message update from channels and chats both\n}.launchIn(scope)\n}\nFlowsUpdatesFilter have a lot of extensions for messages types filtering:
flowsUpdatesFilter {\ntextMessages(scope).onEach {\nprintln(it) // will be printed each message from channels and chats both with content only `TextContent`\n}.launchIn(scope)\n}\nThe same things were created for media groups:
flowsUpdatesFilter {\nmediaGroupMessages(scope).onEach {\nprintln(it) // will be printed each media group messages list from both channels and chats without filtering of content\n}.launchIn(scope)\nmediaGroupPhotosMessages(scope).onEach {\nprintln(it) // will be printed each media group messages list from both channels and chats with PhotoContent only\n}.launchIn(scope)\nmediaGroupVideosMessages(scope).onEach {\nprintln(it) // will be printed each media group messages list from both channels and chats with VideoContent only\n}.launchIn(scope)\n}\nBesides, there is an opportunity to avoid separation on media groups and common messages and receive photos and videos content in one flow:
flowsUpdatesFilter {\nsentMessagesWithMediaGroups(scope).onEach {\nprintln(it) // will be printed each message including each separated media group message from both channels and chats without filtering of content\n}.launchIn(scope)\nphotoMessagesWithMediaGroups(scope).onEach {\nprintln(it) // will be printed each message including each separated media group message from both channels and chats with PhotoContent only\n}.launchIn(scope)\nvideoMessagesWithMediaGroups(scope).onEach {\nprintln(it) // will be printed each message including each separated media group message from both channels and chats with VideoContent only\n}.launchIn(scope)\n}\nIn telegram bot API there is an opportunity to get updates via webhooks. In this case you will be able to retrieve updates without making additional requests. Most of currently available methods for webhooks are working on ktor server for JVM. Currently, next ways are available for using for webhooks:
Route#includeWebhookHandlingInRoute for ktor serverRoute#includeWebhookHandlingInRouteWithFlows startListenWebhooksRequestsExecutor#setWebhookInfoAndStartListenWebhookssetWebhookInfoAndStartListenWebhooks","text":"It is the most common way to set updates webhooks and start listening of them. Example:
val bot = telegramBot(TOKEN)\nval filter = flowsUpdatesFilter {\n// ...\n}\nbot.setWebhookInfoAndStartListenWebhooks(\n8080, // listening port. It is required for cases when your server hidden by some proxy or other system like Heroku\nCIO, // default ktor server engine. It is recommended to replace it with something like `Netty`. More info about engines here: https://ktor.io/servers/configuration.html\nSetWebhook(\n\"address.com/webhook_route\",\nFile(\"/path/to/certificate\").toInputFile(), // certificate file. More info here: https://core.telegram.org/bots/webhooks#a-certificate-where-do-i-get-one-and-how\n40, // max allowed updates, by default is null\nfilter.allowedUpdates\n),\n{\nit.printStackTrace() // optional handling of exceptions\n},\n\"0.0.0.0\", // listening host which will be used to bind by server\n\"subroute\", // Optional subroute, if null - will listen root of address\nWebhookPrivateKeyConfig( // optional config of private key. It will be installed in server to use TLS with custom certificate. More info here: https://core.telegram.org/bots/webhooks#a-certificate-where-do-i-get-one-and-how\n\"/path/to/keystore.jks\",\n\"KeystorePassword\",\n\"Keystore key alias name\",\n\"KeystoreAliasPassword\"\n),\nscope, // Kotlin coroutine scope for internal transforming of media groups\nfilter.asUpdateReceiver\n)\nIf you will use previous example, ktor server will bind and listen url 0.0.0.0:8080/subroute and telegram will send requests to address address.com/webhook_route with custom certificate. Alternative variant will use the other SetWebhook request variant:
SetWebhook(\n\"address.com/webhook_route\",\n\"some_file_bot_id\".toInputFile(),\n40, // max allowed updates, by default is null\nfilter.allowedUpdates\n)\nAs a result, request SetWebhook will be executed and after this server will start its working and handling of updates.
startListenWebhooks","text":"This function is working almost exactly like previous example, but this one will not set up webhook info in telegram:
val filter = flowsUpdatesFilter {\n// ...\n}\nstartListenWebhooks(\n8080, // listening port. It is required for cases when your server hidden by some proxy or other system like Heroku\nCIO, // default ktor server engine. It is recommended to replace it with something like `Netty`. More info about engines here: https://ktor.io/servers/configuration.html\n{\nit.printStackTrace() // optional handling of exceptions\n},\n\"0.0.0.0\", // listening host which will be used to bind by server\n\"subroute\", // Optional subroute, if null - will listen root of address\nWebhookPrivateKeyConfig( // optional config of private key. It will be installed in server to use TLS with custom certificate. More info here: https://core.telegram.org/bots/webhooks#a-certificate-where-do-i-get-one-and-how\n\"/path/to/keystore.jks\",\n\"KeystorePassword\",\n\"Keystore key alias name\",\n\"KeystoreAliasPassword\"\n),\nscope, // Kotlin coroutine scope for internal transforming of media groups\nfilter.asUpdateReceiver\n)\nThe result will be the same as in previous example: server will start its working and handling of updates on 0.0.0.0:8080/subroute. The difference here is that in case if this bot must not answer or send some requiests - it will not be necessary to create bot for receiving of updates.
includeWebhookHandlingInRoute and includeWebhookHandlingInRouteWithFlows","text":"For these extensions you will need to start your server manualy. In common case it will look like:
val scope = CoroutineScope(Dispatchers.Default)\nval filter = flowsUpdatesFilter {\n// ...\n}\nval environment = applicationEngineEnvironment {\nmodule {\nrouting {\nincludeWebhookHandlingInRoute(\nscope,\n{\nit.printStackTrace()\n},\nfilter.asUpdateReceiver\n)\n}\n}\nconnector {\nhost = \"0.0.0.0\"\nport = 8080\n}\n}\nembeddedServer(CIO, environment).start(true) // will start server and wait its stoping\nIn the example above server will started and binded for listening on 0.0.0.0:8080.
Low-level way to create keyboard looks like in the next snippet:
-ReplyKeyboardMarkup(
- matrix {
- row {
- add(SimpleKeyboardButton("Simple text"))
- // ...
- }
- // ...
- }
-)
-ReplyKeyboardMarkup(
+ matrix {
+ row {
+ add(SimpleKeyboardButton("Simple text"))
+ // ...
+ }
+ // ...
+ }
+)
+In case you wish to create inline keyboard, it will look like the same as for reply keyboard. But there is another way. The next snippet will create the same keyboard as on the screenshots above:
-// reply keyboard
-replyKeyboard {
- row {
- simpleButton("7")
- simpleButton("8")
- simpleButton("9")
- simpleButton("*")
- }
- row {
- simpleButton("4")
- simpleButton("5")
- simpleButton("6")
- simpleButton("/")
- }
- row {
- simpleButton("1")
- simpleButton("2")
- simpleButton("3")
- simpleButton("-")
- }
- row {
- simpleButton("0")
- simpleButton(".")
- simpleButton("=")
- simpleButton("+")
- }
-}
-
-// inline keyboard
-inlineKeyboard {
- row {
- dataButton("Get random music", "random")
- }
- row {
- urlButton("Send music to friends", "https://some.link")
- }
-}
-// reply keyboard
+replyKeyboard {
+ row {
+ simpleButton("7")
+ simpleButton("8")
+ simpleButton("9")
+ simpleButton("*")
+ }
+ row {
+ simpleButton("4")
+ simpleButton("5")
+ simpleButton("6")
+ simpleButton("/")
+ }
+ row {
+ simpleButton("1")
+ simpleButton("2")
+ simpleButton("3")
+ simpleButton("-")
+ }
+ row {
+ simpleButton("0")
+ simpleButton(".")
+ simpleButton("=")
+ simpleButton("+")
+ }
+}
+
+// inline keyboard
+inlineKeyboard {
+ row {
+ dataButton("Get random music", "random")
+ }
+ row {
+ urlButton("Send music to friends", "https://some.link")
+ }
+}
+This way of live locations handling is based on coroutines Flow and allow you to pass some external Flow with EditLiveLocationInfo. So, workflow:
flow {
- var i = 0
- while (isActive) {
- val newInfo = EditLiveLocationInfo(
- latitude = i.toDouble(),
- longitude = i.toDouble(),
- replyMarkup = flatInlineKeyboard {
- dataButton("Cancel", "cancel")
- }
- )
- emit(newInfo)
- i++
- delay(10000L) // 10 seconds
- }
-}
-val currentMessageState = MutableStateFlow<ContentMessage<LocationContent>?>(null)
-handleLiveLocation(
- it.chat.id,
- locationsFlow,
- sentMessageFlow = FlowCollector { currentMessageState.emit(it) }
-)
-// this code will be called after `locationsFlow` will ends
-OR
-scope.launch {
- handleLiveLocation(
- it.chat.id,
- locationsFlow,
- sentMessageFlow = FlowCollector { currentMessageState.emit(it) }
- )
-}
-// this code will be called right after launch will be completed
-See our example to get more detailed sample
diff --git a/tgbotapi/dsls/text.html b/tgbotapi/dsls/text.html index faf05a7..0601166 100644 --- a/tgbotapi/dsls/text.html +++ b/tgbotapi/dsls/text.html @@ -1170,21 +1170,21 @@For the text creating there are several tools. The most simple one is to concatenate several text sources to make list of text sources as a result:
-val sources = "Regular start of text " + bold("with bold part") + italic("and italic ending")
-But there is a little bit more useful way: entities builder:
-val items = (0 until 10).map { it.toString() }
-buildEntities(" ") {// optional " " auto separator which will be pasted between text sources
- +"It is regular start too" + bold("it is bold as well")
- items.forEachIndexed { i, item ->
- if (i % 2) {
- italic(item)
- } else {
- strikethrough(item)
- }
- }
-}
-val items = (0 until 10).map { it.toString() }
+buildEntities(" ") {// optional " " auto separator which will be pasted between text sources
+ +"It is regular start too" + bold("it is bold as well")
+ items.forEachIndexed { i, item ->
+ if (i % 2) {
+ italic(item)
+ } else {
+ strikethrough(item)
+ }
+ }
+}
+In the code above we are creating an items list just for demonstrating that inside of buildEntities body we may use any operations for cunstructing our result list of TextSources. As a result, will be created the list which will looks like in telegram as “It is regular start too it is bold as well 0 ~~1~~ 2 ~~3~~ 4 ~~5~~ 6 ~~7~~ 8 ~~9~~”.
The most simple bot will just print information about itself. All source code you can find in this repository. Our interest here will be concentrated on the next example part:
-suspend fun main(vararg args: String) {
- val botToken = args.first()
- val bot = telegramBot(botToken)
- println(bot.getMe())
-}
-suspend fun main(vararg args: String) {
+ val botToken = args.first()
+ val bot = telegramBot(botToken)
+ println(bot.getMe())
+}
+So, let’s get understanding, about what is going on:
suspend fun main(vararg args: String):As a result, we will see in the command line something like
-ExtendedBot(id=ChatId(chatId=123456789), username=Username(username=@first_test_ee17e8_bot), firstName=Your bot name, lastName=, canJoinGroups=false, canReadAllGroupMessages=false, supportsInlineQueries=false)
-ExtendedBot(id=ChatId(chatId=123456789), username=Username(username=@first_test_ee17e8_bot), firstName=Your bot name, lastName=, canJoinGroups=false, canReadAllGroupMessages=false, supportsInlineQueries=false)
+To use this library, you will need to include Maven Central repository in your project
mavenCentral()
-<repository>
- <id>central</id>
- <name>mavenCentral</name>
- <url>https://repo1.maven.org/maven2</url>
-</repository>
-<repository>
+ <id>central</id>
+ <name>mavenCentral</name>
+ <url>https://repo1.maven.org/maven2</url>
+</repository>
+Besides, there is developer versions repo. To use it in your project, add the repo in repositories section:
maven {
- url "https://git.inmo.dev/api/packages/InsanusMokrassar/maven"
-}
-<repository>
- <id>dev.inmo</id>
- <name>InmoDev</name>
- <url>https://git.inmo.dev/api/packages/InsanusMokrassar/maven</url>
-</repository>
-As tgbotapi_version variable in next snippets will be used variable with next last published version:
implementation "dev.inmo:tgbotapi:$tgbotapi_version"
-<dependency>
- <groupId>dev.inmo</groupId>
- <artifactId>tgbotapi</artifactId>
- <version>${tgbotapi_version}</version>
-</dependency>
-<dependency>
+ <groupId>dev.inmo</groupId>
+ <artifactId>tgbotapi</artifactId>
+ <version>${tgbotapi_version}</version>
+</dependency>
+As tgbotapi_version variable in next snippets will be used variable with next last published version:
implementation "dev.inmo:tgbotapi.core:$tgbotapi_version"
-<dependency>
- <groupId>dev.inmo</groupId>
- <artifactId>tgbotapi.core</artifactId>
- <version>${tgbotapi_version}</version>
-</dependency>
-<dependency>
+ <groupId>dev.inmo</groupId>
+ <artifactId>tgbotapi.core</artifactId>
+ <version>${tgbotapi_version}</version>
+</dependency>
+As tgbotapi_version variable in next snippets will be used variable with next last published version:
implementation "dev.inmo:tgbotapi.api:$tgbotapi_version"
-<dependency>
- <groupId>dev.inmo</groupId>
- <artifactId>tgbotapi.api</artifactId>
- <version>${tgbotapi_version}</version>
-</dependency>
-<dependency>
+ <groupId>dev.inmo</groupId>
+ <artifactId>tgbotapi.api</artifactId>
+ <version>${tgbotapi_version}</version>
+</dependency>
+As tgbotapi_version variable in next snippets will be used variable with next last published version:
implementation "dev.inmo:tgbotapi.utils:$tgbotapi_version"
-<dependency>
- <groupId>dev.inmo</groupId>
- <artifactId>tgbotapi.utils</artifactId>
- <version>${tgbotapi_version}</version>
-</dependency>
-<dependency>
+ <groupId>dev.inmo</groupId>
+ <artifactId>tgbotapi.utils</artifactId>
+ <version>${tgbotapi_version}</version>
+</dependency>
+In some locations Telegram Bots API urls will be unavailable. In this case all examples will just throw exception like:
-Exception in thread "main" java.net.ConnectException: Connection refused
- at sun.nio.ch.SocketChannelImpl.checkConnect(Native Method)
- at sun.nio.ch.SocketChannelImpl.finishConnect(SocketChannelImpl.java:717)
- at io.ktor.network.sockets.SocketImpl.connect$ktor_network(SocketImpl.kt:36)
- at io.ktor.network.sockets.SocketImpl$connect$1.invokeSuspend(SocketImpl.kt)
- at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
- at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:56)
- at kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.kt:571)
- at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.kt:738)
- at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.runWorker(CoroutineScheduler.kt:678)
- at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.run(CoroutineScheduler.kt:665)
-
-Process finished with exit code 1
-Exception in thread "main" java.net.ConnectException: Connection refused
+ at sun.nio.ch.SocketChannelImpl.checkConnect(Native Method)
+ at sun.nio.ch.SocketChannelImpl.finishConnect(SocketChannelImpl.java:717)
+ at io.ktor.network.sockets.SocketImpl.connect$ktor_network(SocketImpl.kt:36)
+ at io.ktor.network.sockets.SocketImpl$connect$1.invokeSuspend(SocketImpl.kt)
+ at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
+ at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:56)
+ at kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.kt:571)
+ at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.kt:738)
+ at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.runWorker(CoroutineScheduler.kt:678)
+ at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.run(CoroutineScheduler.kt:665)
+
+Process finished with exit code 1
+There are several ways to solve this problem:
First of all, you will need to use one more library:
build.gradle:
-implementation "io.ktor:ktor-client-okhttp:2.0.1"
-Dependency note
In the snippet above was used version 2.0.1 which is actual for TelegramBotAPI at the moment of filling this documentation (May 22 2022, TelegramBotAPI version 2.0.0) and you can update version of this dependency in case if it is outdated.
For configuring proxy for your bot inside your program, you can use next snippet:
-val botToken = "HERE MUST BE YOUR TOKEN"
-val bot = telegramBot(botToken) {
- ktorClientEngineFactory = OkHttp
- proxy = ProxyBuilder.socks("127.0.0.1", 1080)
-}
-val botToken = "HERE MUST BE YOUR TOKEN"
+val bot = telegramBot(botToken) {
+ ktorClientEngineFactory = OkHttp
+ proxy = ProxyBuilder.socks("127.0.0.1", 1080)
+}
+Explanation line by line:
val botToken = "HERE MUST BE YOUR TOKEN" - here we are just creating variable botTokenAPI extensions is a module which you may include in your project in addition to core part. In most cases this module will allow just use syntax like bot.getUpdates() instead of bot.execute(GetUpdates()), but there are several other things you will achieve with that syntax.
This functionality allow you to build bot in more unified and comfortable way than standard creating with telegramBot function
buildBot(
- "TOKEN"
-) {
- proxy = ProxyBuilder.socks(host = "127.0.0.1", port = 4001) // just an example, more info on https://ktor.io/docs/proxy.html
- ktorClientConfig = {
- // configuring of ktor client
- }
- ktorClientEngineFactory = {
- // configuring of ktor client engine
- }
-}
-buildBot(
+ "TOKEN"
+) {
+ proxy = ProxyBuilder.socks(host = "127.0.0.1", port = 4001) // just an example, more info on https://ktor.io/docs/proxy.html
+ ktorClientConfig = {
+ // configuring of ktor client
+ }
+ ktorClientEngineFactory = {
+ // configuring of ktor client engine
+ }
+}
+In standard library requests there are no way to download some file retrieved in updates or after requests. You may use syntax like bot.downloadFile(file) where file is TelegramMediaFile from telegram, FileId or even PathedFile from GetFile request (sources).
startChain which will add new state for handlingThe most based way to create StatesMachine and register StateHandlers looks like in the next snippet:
buildFSM<TrafficLightState> {
- strictlyOn<SomeState> {
- // state handling
- }
-}.start(CoroutineScope(...)).join()
-buildFSM<TrafficLightState> {
+ strictlyOn<SomeState> {
+ // state handling
+ }
+}.start(CoroutineScope(...)).join()
+Full example
@@ -1273,11 +1273,11 @@ You may find full example of FSM usage in CustomBehaviourContextReceiver and will looks like in the next snippet:
-telegramBotWithBehaviourAndFSMAndStartLongPolling<YourStateType>("BOT_TOKEN") {
- // here you may use any operations from BehaviourBuilder
- // here you may use any operations from BehaviourContextWithFSMBuilder like strictlyOn and others
-}
-telegramBotWithBehaviourAndFSMAndStartLongPolling<YourStateType>("BOT_TOKEN") {
+ // here you may use any operations from BehaviourBuilder
+ // here you may use any operations from BehaviourContextWithFSMBuilder like strictlyOn and others
+}
+As was said above, there is buildBehaviour function which allow you set up your bot logic. Let’s see an example:
-val bot = telegramBot("TOKEN")
-
-bot.buildBehaviour {
- onCommand("start") { // creating of trigger
- val message = it
- val content = message.content
-
- reply(message, "Ok, send me one photo") // send text message with replying on incoming message
-
- val photoContent = waitPhoto().first() // waitPhoto will return List, so, get first element
-
- val photo = downloadFile(photoContent) // ByteArray of photo
-
- // some logic with saving of photos
- }
-}
-val bot = telegramBot("TOKEN")
+
+bot.buildBehaviour {
+ onCommand("start") { // creating of trigger
+ val message = it
+ val content = message.content
+
+ reply(message, "Ok, send me one photo") // send text message with replying on incoming message
+
+ val photoContent = waitPhoto().first() // waitPhoto will return List, so, get first element
+
+ val photo = downloadFile(photoContent) // ByteArray of photo
+
+ // some logic with saving of photos
+ }
+}
+In most cases there are opportunity to filter some of messages before starting of main logic. Let’s look at this using the example above:
-val bot = telegramBot("TOKEN")
-
-bot.buildBehaviour {
- onCommand(
- "start",
- initialFilter = {
- it.content.textSources.size == 1 // make sure that user has sent /start without any additions
- }
- ) {
- // ...
- }
-}
-val bot = telegramBot("TOKEN")
+
+bot.buildBehaviour {
+ onCommand(
+ "start",
+ initialFilter = {
+ it.content.textSources.size == 1 // make sure that user has sent /start without any additions
+ }
+ ) {
+ // ...
+ }
+}
+OR
-val bot = telegramBot("TOKEN")
-
-bot.buildBehaviour {
- onCommand(
- "start",
- requireOnlyCommandInMessage = true // it is default, but you can overwrite it with `requireOnlyCommandInMessage = false`
- ) {
- // ...
- }
-}
-val bot = telegramBot("TOKEN")
+
+bot.buildBehaviour {
+ onCommand(
+ "start",
+ requireOnlyCommandInMessage = true // it is default, but you can overwrite it with `requireOnlyCommandInMessage = false`
+ ) {
+ // ...
+ }
+}
+If you prefer to receive Result objects instead of some weird callbacks, you may use the next syntax:
safelyWithResult {
- // do something
-}.onSuccess { // will be called if everything is right
- // handle success
-}.onFailure { // will be called if something went wrong
- // handle error
- it.printStackTrace()
-}.getOrThrow() // will return value or throw exception
-safelyWithResult {
+ // do something
+}.onSuccess { // will be called if everything is right
+ // handle success
+}.onFailure { // will be called if something went wrong
+ // handle error
+ it.printStackTrace()
+}.getOrThrow() // will return value or throw exception
+Also there is more simple (in some cases) way to handle exceptions with callbacks:
-safely(
- {
- // handle error
- it.printStackTrace()
- null // return value
- }
-) {
- // do something
-}
-safely(
+ {
+ // handle error
+ it.printStackTrace()
+ null // return value
+ }
+) {
+ // do something
+}
+There are two types of handling:
safely, but this type by default allow to return nullable value (when exception was thrown) instead of just throwing (as with safely):
+safely(
- {
- it.printStackTrace()
- "error"
- }
-) {
- error("Hi :)") // emulate exception throwing
- "ok"
-} // result will be with type String
-safely, but this type by default allow to return nullable value (when exception was thrown) instead of just throwing (as with safely):safelyWithouExceptions {
- // do something
-} // will returns nullable result type
-The most simple way to configure exceptions handling is to change CoroutineContext when you are creating your CoroutineScope for bot processing:
val bot = telegramBot("TOKEN")
-
-bot.buildBehaviour (
- scope = scope,
- defaultExceptionsHandler = {
- it.printStackTrace()
- }
-) {
- // ...
-}
-val bot = telegramBot("TOKEN")
+
+bot.buildBehaviour (
+ scope = scope,
+ defaultExceptionsHandler = {
+ it.printStackTrace()
+ }
+) {
+ // ...
+}
+OR
-val bot = telegramBotWithBehaviour (
- "TOKEN",
- scope = scope,
- defaultExceptionsHandler = {
- it.printStackTrace()
- }
-) {
- // ...
-}
-val bot = telegramBotWithBehaviour (
+ "TOKEN",
+ scope = scope,
+ defaultExceptionsHandler = {
+ it.printStackTrace()
+ }
+) {
+ // ...
+}
+Here we have used ContextSafelyExceptionHandler class. It will pass default handling of exceptions and will call the block in most cases when something inside of your bot logic has thrown exception.
The most simple way to send some file is to get file id and send it. You may get file id from any message with media. For example, if you have received some Message, you may use asCommonMessage conversation to be able to get its content and then convert it to some content with media. Full code here:
val message: Message;
-
-val fileId = message.asCommonMessage() ?.withContent<MediaContent>() ?.content ?.media ?.fileId;
-val message: Message;
+
+val fileId = message.asCommonMessage() ?.withContent<MediaContent>() ?.content ?.media ?.fileId;
+WAT? O.o
In the code above we get some message, safely converted it to CommonMessage with asCommonMessage, then safely took its content via withContent<MediaContent>() ?.content and then just get its media file id.
API extensions¶val bot: TelegramBot;
-val fileId: FileId;
-val outputFile: File;
-
-bot.downloadFile(fileId, outputFile)
-val bot: TelegramBot;
+val fileId: FileId;
+val outputFile: File;
+
+bot.downloadFile(fileId, outputFile)
+See downloadFile extension docs in the JVM tab to get more available options
There is also way with saving of data into temporal file. That will allow you to do with data whatever you want without high requirements to memory or network connection:
-val bot: TelegramBot;
-val fileId: FileId;
-
-val tempFile: File = bot.downloadFileToTemp(fileId)
-See downloadFileToTemp extension docs to get more available options
val bot: TelegramBot;
-val fileId: FileId;
-
-val bytes: ByteReadChannelAllocator = bot.downloadFileStream(fileId)
-val bot: TelegramBot;
+val fileId: FileId;
+
+val bytes: ByteReadChannelAllocator = bot.downloadFileStream(fileId)
+See downloadFileStream extension docs to get more available options
val bot: TelegramBot;
-val fileId: FileId;
-
-val bytes: ByteReadChannelAllocator = bot.downloadFileStreamAllocator(fileId)
-val bot: TelegramBot;
+val fileId: FileId;
+
+val bytes: ByteReadChannelAllocator = bot.downloadFileStreamAllocator(fileId)
+See downloadFileStreamAllocator extension docs to get more available options
val bot: TelegramBot;
-val fileId: FileId;
-
-val bytes: ByteArray = bot.downloadFile(fileId)
-See downloadFile extension docs to get more available options
how does it work?¶You may download file with streams or with downloading into the memory first. On low level you should do several things. They are presented in next snippet:
-val bot: TelegramBot;
-val fileId: FileId;
-
-val pathedFile: PathedFile = bot.execute(GetFile(fileId))
-
-val downloadedBytes: ByteArray = bot.execute(DownloadFile(pathedFile.filePath))
-val bot: TelegramBot;
+val fileId: FileId;
+
+val pathedFile: PathedFile = bot.execute(GetFile(fileId))
+
+val downloadedBytes: ByteArray = bot.execute(DownloadFile(pathedFile.filePath))
+In the snippet above we are getting file PathedFile by its FileId and use it to download file bytes into memory using DownloadFile request.
You may use almost the same way but with byte read channel allocator:
-val bot: TelegramBot;
-val fileId: FileId;
-
-val pathedFile: PathedFile = bot.execute(GetFile(fileId))
-
-val channelAllocator: ByteReadChannelAllocator = bot.execute(DownloadFileStream(pathedFile.filePath))
-
-val byteReadChannel: ByteReadChannel = channelAllocator()
-val bot: TelegramBot;
+val fileId: FileId;
+
+val pathedFile: PathedFile = bot.execute(GetFile(fileId))
+
+val channelAllocator: ByteReadChannelAllocator = bot.execute(DownloadFileStream(pathedFile.filePath))
+
+val byteReadChannel: ByteReadChannel = channelAllocator()
+And then you may look into ByteReadChannel docs to get more info about what you can do with that.
Several useful links
@@ -1283,10 +1283,10 @@ Sending via file is accessible from all supported platforms, but there is smallByteArray, ByteReadChannel, ByteReadChannelAllocator or File (on any platform)In most cases, sending via files looks like in the next snippet:
-val file: File;
-
-bot.sendDocument(chatId, file.asMultipartFile())
-So, in most cases all your request calls with simplified api of this library (like bot.getMe()) will looks like bot.execute(GetMe). Result of these calls is defined in type of any request (for example, for GetMe request the result type is ExtendedBot). As a result, you can avoid any extension api (like special API extensions) and use low level request with full controlling of the whole logic flow.
As was written above, it will require some request:
-val updates = bot.execute(GetUpdates())
-Result type of GetUpdates request is Update. You may find inheritors of this interface in Update kdocs.
As was said above, you may look into our API extensions in case you wish to use more high-level functions instead of bot.execute(SomeRequest()). Besides, it will be very useful to know more about updates retrieving.
In case you are using standard long polling (one of alternatives is telegramBotWithBehaviourAndLongPolling) or webhooks updates will be converted uner the hood and as a result, you will take media groups as a content in one message:
-telegramBotWithBehaviourAndLongPolling(
- "token"
-) {
- onVisualGallery { // it: CommonMessage<MediaGroupContent<VisualMediaGroupPartContent>>
- it.content // MediaGroupContent<VisualMediaGroupPartContent>
- it.content.group // List<MediaGroupCollectionContent.PartWrapper<VisualMediaGroupPartContent>>
- it.content.group.forEach { // it: MediaGroupCollectionContent.PartWrapper<VisualMediaGroupPartContent>
- it.messageId // source message id for current media group part
- it.sourceMessage // source message for current media group part
- it.content // VisualMediaGroupPartContent
- println(it.content) // will print current content part info
- }
- }
-}
-telegramBotWithBehaviourAndLongPolling(
+ "token"
+) {
+ onVisualGallery { // it: CommonMessage<MediaGroupContent<VisualMediaGroupPartContent>>
+ it.content // MediaGroupContent<VisualMediaGroupPartContent>
+ it.content.group // List<MediaGroupCollectionContent.PartWrapper<VisualMediaGroupPartContent>>
+ it.content.group.forEach { // it: MediaGroupCollectionContent.PartWrapper<VisualMediaGroupPartContent>
+ it.messageId // source message id for current media group part
+ it.sourceMessage // source message for current media group part
+ it.content // VisualMediaGroupPartContent
+ println(it.content) // will print current content part info
+ }
+ }
+}
+KDocs:
As you may see, it is a little bit complex and require several tools for types conversation.
as conversations will return new type in case if it is possible. For example, when you got Message, you may use asContentMessage conversation to get message with content:
val message: Message;
-println(message.asContentMessage() ?.content)
-This code will print null in case when message is not ContentMessage, and content when is.
require works like as, but instead of returning nullable type, it will always return object with required type OR throw ClassCastException:
val message: Message;
-println(message.requireContentMessage().content)
-This code will throw exception when message is not ContentMessage and print content when is.
when extensions will call passed block when type is correct. For example:
val message: Message;
-message.whenContentMessage {
- println(it.content)
-}
-Code placed above will print content when message is ContentMessage and do nothing when not
Let’s look how it works with the factory above:
-// Step 1 - create filter
-val filter = flowsUpdatesFilter {
- // Step 2 - set up handling. In this case we will print any message from group or user in console
- messageFlow.onEach {
- println(it)
- }.launchIn(someCoroutineScope)
-}
-
-// Step 3 - passing updates to filter
-bot.getUpdates().forEach {
- filter.asUpdatesReceiver(it)
-}
-// Step 1 - create filter
+val filter = flowsUpdatesFilter {
+ // Step 2 - set up handling. In this case we will print any message from group or user in console
+ messageFlow.onEach {
+ println(it)
+ }.launchIn(someCoroutineScope)
+}
+
+// Step 3 - passing updates to filter
+bot.getUpdates().forEach {
+ filter.asUpdatesReceiver(it)
+}
+Some example with long polling has been described above. But it is more useful to use some factories for it. In this page we will look for simple variant with TelegramBot#longPolling. So, with this function, your handling of updates will looks like:
-val bot = telegramBot("TOKEN")
-
-bot.longPolling {
- messageFlow.onEach {
- println(it)
- }.launchIn(someCoroutineScope)
-}.join()
-val bot = telegramBot("TOKEN")
+
+bot.longPolling {
+ messageFlow.onEach {
+ println(it)
+ }.launchIn(someCoroutineScope)
+}.join()
+This example looks like the example above with three steps, but there are several important things here:
suspend fun main {
- // This subroute will be used as random webhook subroute to improve security according to the recommendations of Telegram
- val subroute = uuid4().toString()
- // Input/Output coroutines scope more info here: https://kotlinlang.org/docs/coroutines-guide.html
- val scope = CoroutineScope(Dispatchers.IO)
- // Here will be automatically created bot and available inside of lambda where you will setup your bot behaviour
- telegramBotWithBehaviour(
- // Pass TOKEN inside of your application environment variables
- System.getenv("TOKEN"),
- scope = scope
- ) {
- // Set up webhooks and start to listen them
- setWebhookInfoAndStartListenWebhooks(
- // Automatic env which will be passed by heroku to the app
- System.getenv("PORT").toInt(),
- // Server engine. More info here: https://ktor.io/docs/engines.html
- Tomcat,
- // Pass URL environment variable via settings of application. It must looks like https://<app name>.herokuapp.com
- SetWebhook("${System.getenv("URL").removeSuffix("/")}/$subroute"),
- // Just callback which will be called when exceptions will happen inside of webhooks
- {
- it.printStackTrace()
- },
- // Set up listen requests from outside
- "0.0.0.0",
- // Set up subroute to listen webhooks to
- subroute,
- // BehaviourContext is the CoroutineScope and it is recommended to pass it inside of webhooks server
- scope = this,
- // BehaviourContext is the FlowsUpdatesFilter and it is recommended to pass its asUpdateReceiver as a block to retrieve all the updates
- block = asUpdateReceiver
- )
- // Test reaction on each command with reply and text `Got it`
- onUnhandledCommand {
- reply(it, "Got it")
- }
- }
- // Just potentially infinite await of bot completion
- scope.coroutineContext.job.join()
-}
-suspend fun main {
+ // This subroute will be used as random webhook subroute to improve security according to the recommendations of Telegram
+ val subroute = uuid4().toString()
+ // Input/Output coroutines scope more info here: https://kotlinlang.org/docs/coroutines-guide.html
+ val scope = CoroutineScope(Dispatchers.IO)
+ // Here will be automatically created bot and available inside of lambda where you will setup your bot behaviour
+ telegramBotWithBehaviour(
+ // Pass TOKEN inside of your application environment variables
+ System.getenv("TOKEN"),
+ scope = scope
+ ) {
+ // Set up webhooks and start to listen them
+ setWebhookInfoAndStartListenWebhooks(
+ // Automatic env which will be passed by heroku to the app
+ System.getenv("PORT").toInt(),
+ // Server engine. More info here: https://ktor.io/docs/engines.html
+ Tomcat,
+ // Pass URL environment variable via settings of application. It must looks like https://<app name>.herokuapp.com
+ SetWebhook("${System.getenv("URL").removeSuffix("/")}/$subroute"),
+ // Just callback which will be called when exceptions will happen inside of webhooks
+ {
+ it.printStackTrace()
+ },
+ // Set up listen requests from outside
+ "0.0.0.0",
+ // Set up subroute to listen webhooks to
+ subroute,
+ // BehaviourContext is the CoroutineScope and it is recommended to pass it inside of webhooks server
+ scope = this,
+ // BehaviourContext is the FlowsUpdatesFilter and it is recommended to pass its asUpdateReceiver as a block to retrieve all the updates
+ block = asUpdateReceiver
+ )
+ // Test reaction on each command with reply and text `Got it`
+ onUnhandledCommand {
+ reply(it, "Got it")
+ }
+ }
+ // Just potentially infinite await of bot completion
+ scope.coroutineContext.job.join()
+}
+// This subroute will be used as random webhook subroute to improve security according to the recommendations of Telegram
-val subroute = uuid4().toString()
-val bot = telegramBot(TOKEN)
-val scope = CoroutineScope(Dispatchers.Default)
-
-val filter = flowsUpdatesFilter {
- messageFlow.onEach {
- println(it) // will be printed
- }.launchIn(scope)
-}
-
-val subroute = UUID.randomUUID().toString() // It will be used as subpath for security target as recommended by https://core.telegram.org/bots/api#setwebhook
-
-val server = bot.setWebhookInfoAndStartListenWebhooks(
- // Automatic env which will be passed by heroku to the app
- System.getenv("PORT").toInt(),
- // Server engine. More info here: https://ktor.io/docs/engines.html
- Tomcat,
- // Pass URL environment variable via settings of application. It must looks like https://<app name>.herokuapp.com
- SetWebhook("${System.getenv("URL").removeSuffix("/")}/$subroute"),
- // Just callback which will be called when exceptions will happen inside of webhooks
- {
- it.printStackTrace()
- },
- // Set up listen requests from outside
- "0.0.0.0",
- // Set up subroute to listen webhooks to
- subroute,
- scope = scope,
- block = filter.asUpdateReceiver
-)
-
-server.environment.connectors.forEach {
- println(it)
-}
-server.start(false)
-// This subroute will be used as random webhook subroute to improve security according to the recommendations of Telegram
+val subroute = uuid4().toString()
+val bot = telegramBot(TOKEN)
+val scope = CoroutineScope(Dispatchers.Default)
+
+val filter = flowsUpdatesFilter {
+ messageFlow.onEach {
+ println(it) // will be printed
+ }.launchIn(scope)
+}
+
+val subroute = UUID.randomUUID().toString() // It will be used as subpath for security target as recommended by https://core.telegram.org/bots/api#setwebhook
+
+val server = bot.setWebhookInfoAndStartListenWebhooks(
+ // Automatic env which will be passed by heroku to the app
+ System.getenv("PORT").toInt(),
+ // Server engine. More info here: https://ktor.io/docs/engines.html
+ Tomcat,
+ // Pass URL environment variable via settings of application. It must looks like https://<app name>.herokuapp.com
+ SetWebhook("${System.getenv("URL").removeSuffix("/")}/$subroute"),
+ // Just callback which will be called when exceptions will happen inside of webhooks
+ {
+ it.printStackTrace()
+ },
+ // Set up listen requests from outside
+ "0.0.0.0",
+ // Set up subroute to listen webhooks to
+ subroute,
+ scope = scope,
+ block = filter.asUpdateReceiver
+)
+
+server.environment.connectors.forEach {
+ println(it)
+}
+server.start(false)
+longPolling is a simple way to start getting updates and work with bot:
val bot = telegramBot(token)
-bot.longPolling(
- textMessages().subscribe(scope) { // here "scope" is a CoroutineScope
- println(it) // will be printed each update from chats with messages
- }
-)
-val bot = telegramBot(token)
+bot.longPolling(
+ textMessages().subscribe(scope) { // here "scope" is a CoroutineScope
+ println(it) // will be printed each update from chats with messages
+ }
+)
+The main aim of startGettingOfUpdatesByLongPolling extension was to provide more simple way to get updates in automatic mode:
val bot = telegramBot(token)
-bot.startGettingOfUpdatesByLongPolling(
- {
- println(it) // will be printed each update from chats with messages
- }
-)
-val bot = telegramBot(token)
+bot.startGettingOfUpdatesByLongPolling(
+ {
+ println(it) // will be printed each update from chats with messages
+ }
+)
+The other way is to use the most basic startGettingOfUpdatesByLongPolling extension:
val bot = telegramBot(token)
-bot.startGettingOfUpdatesByLongPolling {
- println(it) // will be printed each update
-}
-val bot = telegramBot(token)
+bot.startGettingOfUpdatesByLongPolling {
+ println(it) // will be printed each update
+}
+Anyway, this filter can’t work with updates by itself. For retrieving updates you should pass this filter to some of getting updates functions (long polling or webhooks).
SimpleUpdatesFilter is a simple variant of filters. It have a lot of UpdateReceiver properties which can be set up on creating of this object. For example, if you wish to get messages from chats (but not from channels), you can use next snippet:
SimpleUpdatesFilter {
- println(it)
-}
-A little bit more modern way is to use FlowsUpdatesFilter. It is very powerfull API of Kotlin Coroutines Flows, built-in support of additional extensions for FlowsUpdatesFilter and Flow<...> receivers and opportunity to split one filter for as much receivers as you want. Filter creating example:
val scope = CoroutineScope(Dispatchers.Default)
-flowsUpdatesFilter {
- messageFlow.onEach {
- println(it)
- }.launchIn(scope)
-}
-val scope = CoroutineScope(Dispatchers.Default)
+flowsUpdatesFilter {
+ messageFlow.onEach {
+ println(it)
+ }.launchIn(scope)
+}
+In cases you need not separate logic for handling of messages from channels and chats there are three ways to combine different flows into one:
plus operation and handling of different flows:plus operation and handling of different flows:
+aggregateFlows:
+FlowsUpdatesFilter extensions:
+flowsUpdatesFilter {
- (messageFlow + channelPostFlow).onEach {
- println(it) // will be printed each message update from channels and chats both
- }.launchIn(scope)
-}
-aggregateFlows:flowsUpdatesFilter {
- aggregateFlows(
- scope,
- messageFlow,
- channelPostFlow
- ).onEach {
- println(it) // will be printed each message update from channels and chats both
- }.launchIn(scope)
-}
-FlowsUpdatesFilter extensions:flowsUpdatesFilter {
- allSentMessagesFlow.onEach {
- println(it) // will be printed each message update from channels and chats both
- }.launchIn(scope)
-}
-FlowsUpdatesFilter have a lot of extensions for messages types filtering:
flowsUpdatesFilter {
- textMessages(scope).onEach {
- println(it) // will be printed each message from channels and chats both with content only `TextContent`
- }.launchIn(scope)
-}
-flowsUpdatesFilter {
+ textMessages(scope).onEach {
+ println(it) // will be printed each message from channels and chats both with content only `TextContent`
+ }.launchIn(scope)
+}
+The same things were created for media groups:
-flowsUpdatesFilter {
- mediaGroupMessages(scope).onEach {
- println(it) // will be printed each media group messages list from both channels and chats without filtering of content
- }.launchIn(scope)
-
- mediaGroupPhotosMessages(scope).onEach {
- println(it) // will be printed each media group messages list from both channels and chats with PhotoContent only
- }.launchIn(scope)
-
- mediaGroupVideosMessages(scope).onEach {
- println(it) // will be printed each media group messages list from both channels and chats with VideoContent only
- }.launchIn(scope)
-}
-flowsUpdatesFilter {
+ mediaGroupMessages(scope).onEach {
+ println(it) // will be printed each media group messages list from both channels and chats without filtering of content
+ }.launchIn(scope)
+
+ mediaGroupPhotosMessages(scope).onEach {
+ println(it) // will be printed each media group messages list from both channels and chats with PhotoContent only
+ }.launchIn(scope)
+
+ mediaGroupVideosMessages(scope).onEach {
+ println(it) // will be printed each media group messages list from both channels and chats with VideoContent only
+ }.launchIn(scope)
+}
+Besides, there is an opportunity to avoid separation on media groups and common messages and receive photos and videos content in one flow:
-flowsUpdatesFilter {
- sentMessagesWithMediaGroups(scope).onEach {
- println(it) // will be printed each message including each separated media group message from both channels and chats without filtering of content
- }.launchIn(scope)
-
- photoMessagesWithMediaGroups(scope).onEach {
- println(it) // will be printed each message including each separated media group message from both channels and chats with PhotoContent only
- }.launchIn(scope)
-
- videoMessagesWithMediaGroups(scope).onEach {
- println(it) // will be printed each message including each separated media group message from both channels and chats with VideoContent only
- }.launchIn(scope)
-}
-flowsUpdatesFilter {
+ sentMessagesWithMediaGroups(scope).onEach {
+ println(it) // will be printed each message including each separated media group message from both channels and chats without filtering of content
+ }.launchIn(scope)
+
+ photoMessagesWithMediaGroups(scope).onEach {
+ println(it) // will be printed each message including each separated media group message from both channels and chats with PhotoContent only
+ }.launchIn(scope)
+
+ videoMessagesWithMediaGroups(scope).onEach {
+ println(it) // will be printed each message including each separated media group message from both channels and chats with VideoContent only
+ }.launchIn(scope)
+}
+setWebhookInfoAndStartListenWebhooks¶It is the most common way to set updates webhooks and start listening of them. Example:
-val bot = telegramBot(TOKEN)
-
-val filter = flowsUpdatesFilter {
- // ...
-}
-
-bot.setWebhookInfoAndStartListenWebhooks(
- 8080, // listening port. It is required for cases when your server hidden by some proxy or other system like Heroku
- CIO, // default ktor server engine. It is recommended to replace it with something like `Netty`. More info about engines here: https://ktor.io/servers/configuration.html
- SetWebhook(
- "address.com/webhook_route",
- File("/path/to/certificate").toInputFile(), // certificate file. More info here: https://core.telegram.org/bots/webhooks#a-certificate-where-do-i-get-one-and-how
- 40, // max allowed updates, by default is null
- filter.allowedUpdates
- ),
- {
- it.printStackTrace() // optional handling of exceptions
- },
- "0.0.0.0", // listening host which will be used to bind by server
- "subroute", // Optional subroute, if null - will listen root of address
- WebhookPrivateKeyConfig( // optional config of private key. It will be installed in server to use TLS with custom certificate. More info here: https://core.telegram.org/bots/webhooks#a-certificate-where-do-i-get-one-and-how
- "/path/to/keystore.jks",
- "KeystorePassword",
- "Keystore key alias name",
- "KeystoreAliasPassword"
- ),
- scope, // Kotlin coroutine scope for internal transforming of media groups
- filter.asUpdateReceiver
-)
-val bot = telegramBot(TOKEN)
+
+val filter = flowsUpdatesFilter {
+ // ...
+}
+
+bot.setWebhookInfoAndStartListenWebhooks(
+ 8080, // listening port. It is required for cases when your server hidden by some proxy or other system like Heroku
+ CIO, // default ktor server engine. It is recommended to replace it with something like `Netty`. More info about engines here: https://ktor.io/servers/configuration.html
+ SetWebhook(
+ "address.com/webhook_route",
+ File("/path/to/certificate").toInputFile(), // certificate file. More info here: https://core.telegram.org/bots/webhooks#a-certificate-where-do-i-get-one-and-how
+ 40, // max allowed updates, by default is null
+ filter.allowedUpdates
+ ),
+ {
+ it.printStackTrace() // optional handling of exceptions
+ },
+ "0.0.0.0", // listening host which will be used to bind by server
+ "subroute", // Optional subroute, if null - will listen root of address
+ WebhookPrivateKeyConfig( // optional config of private key. It will be installed in server to use TLS with custom certificate. More info here: https://core.telegram.org/bots/webhooks#a-certificate-where-do-i-get-one-and-how
+ "/path/to/keystore.jks",
+ "KeystorePassword",
+ "Keystore key alias name",
+ "KeystoreAliasPassword"
+ ),
+ scope, // Kotlin coroutine scope for internal transforming of media groups
+ filter.asUpdateReceiver
+)
+If you will use previous example, ktor server will bind and listen url 0.0.0.0:8080/subroute and telegram will send requests to address address.com/webhook_route with custom certificate. Alternative variant will use the other SetWebhook request variant:
SetWebhook(
- "address.com/webhook_route",
- "some_file_bot_id".toInputFile(),
- 40, // max allowed updates, by default is null
- filter.allowedUpdates
-)
-SetWebhook(
+ "address.com/webhook_route",
+ "some_file_bot_id".toInputFile(),
+ 40, // max allowed updates, by default is null
+ filter.allowedUpdates
+)
+As a result, request SetWebhook will be executed and after this server will start its working and handling of updates.
startListenWebhooks¶This function is working almost exactly like previous example, but this one will not set up webhook info in telegram:
-val filter = flowsUpdatesFilter {
- // ...
-}
-
-startListenWebhooks(
- 8080, // listening port. It is required for cases when your server hidden by some proxy or other system like Heroku
- CIO, // default ktor server engine. It is recommended to replace it with something like `Netty`. More info about engines here: https://ktor.io/servers/configuration.html
- {
- it.printStackTrace() // optional handling of exceptions
- },
- "0.0.0.0", // listening host which will be used to bind by server
- "subroute", // Optional subroute, if null - will listen root of address
- WebhookPrivateKeyConfig( // optional config of private key. It will be installed in server to use TLS with custom certificate. More info here: https://core.telegram.org/bots/webhooks#a-certificate-where-do-i-get-one-and-how
- "/path/to/keystore.jks",
- "KeystorePassword",
- "Keystore key alias name",
- "KeystoreAliasPassword"
- ),
- scope, // Kotlin coroutine scope for internal transforming of media groups
- filter.asUpdateReceiver
-)
-val filter = flowsUpdatesFilter {
+ // ...
+}
+
+startListenWebhooks(
+ 8080, // listening port. It is required for cases when your server hidden by some proxy or other system like Heroku
+ CIO, // default ktor server engine. It is recommended to replace it with something like `Netty`. More info about engines here: https://ktor.io/servers/configuration.html
+ {
+ it.printStackTrace() // optional handling of exceptions
+ },
+ "0.0.0.0", // listening host which will be used to bind by server
+ "subroute", // Optional subroute, if null - will listen root of address
+ WebhookPrivateKeyConfig( // optional config of private key. It will be installed in server to use TLS with custom certificate. More info here: https://core.telegram.org/bots/webhooks#a-certificate-where-do-i-get-one-and-how
+ "/path/to/keystore.jks",
+ "KeystorePassword",
+ "Keystore key alias name",
+ "KeystoreAliasPassword"
+ ),
+ scope, // Kotlin coroutine scope for internal transforming of media groups
+ filter.asUpdateReceiver
+)
+The result will be the same as in previous example: server will start its working and handling of updates on 0.0.0.0:8080/subroute. The difference here is that in case if this bot must not answer or send some requiests - it will not be necessary to create bot for receiving of updates.
includeWebhookHandlingInRoute and includeWebhookHandlingInRouteWithFlows¶For these extensions you will need to start your server manualy. In common case it will look like:
-val scope = CoroutineScope(Dispatchers.Default)
-
-val filter = flowsUpdatesFilter {
- // ...
-}
-
-val environment = applicationEngineEnvironment {
- module {
- routing {
- includeWebhookHandlingInRoute(
- scope,
- {
- it.printStackTrace()
- },
- filter.asUpdateReceiver
- )
- }
- }
- connector {
- host = "0.0.0.0"
- port = 8080
- }
-}
-
-embeddedServer(CIO, environment).start(true) // will start server and wait its stoping
-val scope = CoroutineScope(Dispatchers.Default)
+
+val filter = flowsUpdatesFilter {
+ // ...
+}
+
+val environment = applicationEngineEnvironment {
+ module {
+ routing {
+ includeWebhookHandlingInRoute(
+ scope,
+ {
+ it.printStackTrace()
+ },
+ filter.asUpdateReceiver
+ )
+ }
+ }
+ connector {
+ host = "0.0.0.0"
+ port = 8080
+ }
+}
+
+embeddedServer(CIO, environment).start(true) // will start server and wait its stoping
+In the example above server will started and binded for listening on 0.0.0.0:8080.