2023-06-09 20:03:53 +00:00
<!doctype html>
< html lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< meta name = "description" content = "Single documentation place for all Insanus Mokrassar libraries" >
< meta name = "author" content = "Ovsiannikov Aleksei" >
< link rel = "canonical" href = "https://docs.inmo.dev/tgbotapi/logic/behaviour-builder-with-fsm.html" >
< link rel = "prev" href = "api-extensions.html" >
< link rel = "next" href = "behaviour-builder.html" >
< link rel = "icon" href = "../../assets/images/favicon.png" >
< meta name = "generator" content = "mkdocs-1.4.3, mkdocs-material-9.1.15" >
< title > Behaviour Builder with FSM - InMo Docs< / title >
< link rel = "stylesheet" href = "../../assets/stylesheets/main.26e3688c.min.css" >
< link rel = "preconnect" href = "https://fonts.gstatic.com" crossorigin >
< link rel = "stylesheet" href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" >
< style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style >
< script > _ _md _scope = new URL ( "../.." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script >
< / head >
< body dir = "ltr" >
< script > var palette = _ _md _get ( "__palette" ) ; if ( palette && "object" == typeof palette . color ) for ( var key of Object . keys ( palette . color ) ) document . body . setAttribute ( "data-md-color-" + key , palette . color [ key ] ) < / script >
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" autocomplete = "off" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" autocomplete = "off" >
< label class = "md-overlay" for = "__drawer" > < / label >
< div data-md-component = "skip" >
< a href = "#behaviour-builder-with-fsm" class = "md-skip" >
Skip to content
< / a >
< / div >
< div data-md-component = "announce" >
< / div >
< header class = "md-header" data-md-component = "header" >
< nav class = "md-header__inner md-grid" aria-label = "Header" >
< a href = "../../index.html" title = "InMo Docs" class = "md-header__button md-logo" aria-label = "InMo Docs" data-md-component = "logo" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z" / > < / svg >
< / a >
< label class = "md-header__button md-icon" for = "__drawer" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z" / > < / svg >
< / label >
< div class = "md-header__title" data-md-component = "header-title" >
< div class = "md-header__ellipsis" >
< div class = "md-header__topic" >
< span class = "md-ellipsis" >
InMo Docs
< / span >
< / div >
< div class = "md-header__topic" data-md-component = "header-topic" >
< span class = "md-ellipsis" >
Behaviour Builder with FSM
< / span >
< / div >
< / div >
< / div >
< label class = "md-header__button md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< / label >
< div class = "md-search" data-md-component = "search" role = "dialog" >
< label class = "md-search__overlay" for = "__search" > < / label >
< div class = "md-search__inner" role = "search" >
< form class = "md-search__form" name = "search" >
< input type = "text" class = "md-search__input" name = "query" aria-label = "Search" placeholder = "Search" autocapitalize = "off" autocorrect = "off" autocomplete = "off" spellcheck = "false" data-md-component = "search-query" required >
< label class = "md-search__icon md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" / > < / svg >
< / label >
< nav class = "md-search__options" aria-label = "Search" >
< a href = "javascript:void(0)" class = "md-search__icon md-icon" title = "Share" aria-label = "Share" data-clipboard data-clipboard-text = "" data-md-component = "search-share" tabindex = "-1" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7 0-.24-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91 1.61 0 2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08Z" / > < / svg >
< / a >
< button type = "reset" class = "md-search__icon md-icon" title = "Clear" aria-label = "Clear" tabindex = "-1" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z" / > < / svg >
< / button >
< / nav >
< div class = "md-search__suggest" data-md-component = "search-suggest" > < / div >
< / form >
< div class = "md-search__output" >
< div class = "md-search__scrollwrap" data-md-scrollfix >
< div class = "md-search-result" data-md-component = "search-result" >
< div class = "md-search-result__meta" >
Initializing search
< / div >
< ol class = "md-search-result__list" role = "presentation" > < / ol >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "md-header__source" >
< a href = "https://github.com/InsanusMokrassar/docs" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc. --> < path d = "M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z" / > < / svg >
< / div >
< div class = "md-source__repository" >
InsanusMokrassar/docs
< / div >
< / a >
< / div >
< / nav >
< / header >
< div class = "md-container" data-md-component = "container" >
< nav class = "md-tabs" aria-label = "Tabs" data-md-component = "tabs" >
< div class = "md-grid" >
< ul class = "md-tabs__list" >
< li class = "md-tabs__item" >
< a href = "../../index.html" class = "md-tabs__link" >
Home
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../introduction/before-any-bot-project.html" class = "md-tabs__link md-tabs__link--active" >
Telegram Bot API
< / a >
< / li >
2023-06-10 07:40:12 +00:00
< li class = "md-tabs__item" >
< a href = "../../krontab/introduction/including-in-project.html" class = "md-tabs__link" >
Krontab
< / a >
< / li >
2023-06-09 20:03:53 +00:00
< / ul >
< / div >
< / nav >
< main class = "md-main" data-md-component = "main" >
< div class = "md-main__inner md-grid" >
< div class = "md-sidebar md-sidebar--primary" data-md-component = "sidebar" data-md-type = "navigation" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--primary md-nav--lifted" aria-label = "Navigation" data-md-level = "0" >
< label class = "md-nav__title" for = "__drawer" >
< a href = "../../index.html" title = "InMo Docs" class = "md-nav__button md-logo" aria-label = "InMo Docs" data-md-component = "logo" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z" / > < / svg >
< / a >
InMo Docs
< / label >
< div class = "md-nav__source" >
< a href = "https://github.com/InsanusMokrassar/docs" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc. --> < path d = "M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z" / > < / svg >
< / div >
< div class = "md-source__repository" >
InsanusMokrassar/docs
< / div >
< / a >
< / div >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../index.html" class = "md-nav__link" >
Home
< / a >
< / li >
< li class = "md-nav__item md-nav__item--active md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_2" checked >
< label class = "md-nav__link" for = "__nav_2" id = "__nav_2_label" tabindex = "0" >
Telegram Bot API
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_2_label" aria-expanded = "true" >
< label class = "md-nav__title" for = "__nav_2" >
< span class = "md-nav__icon md-icon" > < / span >
Telegram Bot API
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item md-nav__item--section md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_2_1" >
< label class = "md-nav__link" for = "__nav_2_1" id = "__nav_2_1_label" tabindex = "0" >
Introduction
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_2_1_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_2_1" >
< span class = "md-nav__icon md-icon" > < / span >
Introduction
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../introduction/before-any-bot-project.html" class = "md-nav__link" >
Before any bot project
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../introduction/including-in-your-project.html" class = "md-nav__link" >
Including in your project
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../introduction/proxy-setup.html" class = "md-nav__link" >
Proxy setup
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../introduction/first-bot.html" class = "md-nav__link" >
First bot
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--section md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_2_2" >
< label class = "md-nav__link" for = "__nav_2_2" id = "__nav_2_2_label" tabindex = "0" >
Updates retrieving
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_2_2_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_2_2" >
< span class = "md-nav__icon md-icon" > < / span >
Updates retrieving
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../updates/updates-filters.html" class = "md-nav__link" >
Updates filters
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../updates/long-polling.html" class = "md-nav__link" >
Long polling
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../updates/webhooks.html" class = "md-nav__link" >
Webhooks
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../updates/heroku.html" class = "md-nav__link" >
Heroku
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_2_3" checked >
< label class = "md-nav__link" for = "__nav_2_3" id = "__nav_2_3_label" tabindex = "0" >
Logic handling
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_2_3_label" aria-expanded = "true" >
< label class = "md-nav__title" for = "__nav_2_3" >
< span class = "md-nav__icon md-icon" > < / span >
Logic handling
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "api-extensions.html" class = "md-nav__link" >
API Extensions
< / a >
< / li >
< li class = "md-nav__item md-nav__item--active" >
< input class = "md-nav__toggle md-toggle" type = "checkbox" id = "__toc" >
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
Behaviour Builder with FSM
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< a href = "behaviour-builder-with-fsm.html" class = "md-nav__link md-nav__link--active" >
Behaviour Builder with FSM
< / a >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#bot-with-fsm" class = "md-nav__link" >
Bot with FSM
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#examples" class = "md-nav__link" >
Examples
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "behaviour-builder.html" class = "md-nav__link" >
Behaviour Builder
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "exceptions-handling.html" class = "md-nav__link" >
Exceptions handling
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "files-handling.html" class = "md-nav__link" >
Files handling
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "low-level-work-with-bots.html" class = "md-nav__link" >
Low-level work with bots
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "media-groups.html" class = "md-nav__link" >
Media Groups
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "types-conversations.html" class = "md-nav__link" >
Types conversations
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "updates-with-flows.html" class = "md-nav__link" >
Updates with flows
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--section md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_2_4" >
< label class = "md-nav__link" for = "__nav_2_4" id = "__nav_2_4_label" tabindex = "0" >
DSLs
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_2_4_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_2_4" >
< span class = "md-nav__icon md-icon" > < / span >
DSLs
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../dsls/keyboards.html" class = "md-nav__link" >
Keyboards
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../dsls/live-location.html" class = "md-nav__link" >
Live Location
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../dsls/text.html" class = "md-nav__link" >
Text
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
2023-06-10 07:40:12 +00:00
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_3" >
< label class = "md-nav__link" for = "__nav_3" id = "__nav_3_label" tabindex = "0" >
Krontab
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_3_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_3" >
< span class = "md-nav__icon md-icon" > < / span >
Krontab
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item md-nav__item--section md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_3_1" >
< label class = "md-nav__link" for = "__nav_3_1" id = "__nav_3_1_label" tabindex = "0" >
Introduction
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_3_1_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_3_1" >
< span class = "md-nav__icon md-icon" > < / span >
Introduction
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../krontab/introduction/including-in-project.html" class = "md-nav__link" >
Including in project
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../krontab/introduction/how-to-use.html" class = "md-nav__link" >
How to use
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../krontab/introduction/faq.html" class = "md-nav__link" >
FAQ
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--section md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_3_2" >
< label class = "md-nav__link" for = "__nav_3_2" id = "__nav_3_2_label" tabindex = "0" >
Describing
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_3_2_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_3_2" >
< span class = "md-nav__icon md-icon" > < / span >
Describing
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../krontab/describing/string-format.html" class = "md-nav__link" >
String format
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../krontab/describing/krontabscheduler.html" class = "md-nav__link" >
KrontabScheduler
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
2023-06-09 20:03:53 +00:00
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-sidebar md-sidebar--secondary" data-md-component = "sidebar" data-md-type = "toc" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#bot-with-fsm" class = "md-nav__link" >
Bot with FSM
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#examples" class = "md-nav__link" >
Examples
< / a >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
< a href = "https://github.com/InsanusMokrassar/docs/edit/master/docs/tgbotapi/logic/behaviour-builder-with-fsm.md" title = "Edit this page" class = "md-content__button md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4v-2m10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1 2.1 2.1Z" / > < / svg >
< / a >
< a href = "https://github.com/InsanusMokrassar/docs/raw/master/docs/tgbotapi/logic/behaviour-builder-with-fsm.md" title = "View source of this page" class = "md-content__button md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.15 8.15 0 0 1-1.23-2Z" / > < / svg >
< / a >
< h1 id = "behaviour-builder-with-fsm" > Behaviour Builder with FSM< a class = "headerlink" href = "#behaviour-builder-with-fsm" title = "Permanent link" > ¶ < / a > < / h1 >
< p > Behaviour builder with FSM is based on the MicroUtils FSM. There are several important things in FSM:< / p >
< ul >
< li > < code > State< / code > - any object which implements < a href = "https://microutils.inmo.dev/micro_utils.dokka/dev.inmo.micro_utils.fsm.common/-state/index.html" > State< / a > interface< / li >
< li > < code > StateHandler< / code > (or < a href = "https://microutils.inmo.dev/micro_utils.dokka/dev.inmo.micro_utils.fsm.common/-checkable-handler-holder/index.html" > CheckableHandlerHolder< / a > ) - the handler of states< / li >
< li > < a href = "https://microutils.inmo.dev/micro_utils.dokka/dev.inmo.micro_utils.fsm.common/-states-machine/index.html" > StatesMachine< / a > - some machine which work with states and handlers< / li >
< li > < a href = "https://microutils.inmo.dev/micro_utils.dokka/dev.inmo.micro_utils.fsm.common/-states-manager/index.html" > StatesManager< / a > - simple manager that will solve which states to save and notify about states changes via its flows< / li >
< / ul >
< p > < code > StatesMachine< / code > have two methods:< / p >
< ul >
< li > < code > start< / code > which will start work of machine< / li >
< li > < code > startChain< / code > which will add new state for handling< / li >
< / ul >
< p > The most based way to create < code > StatesMachine< / code > and register < code > StateHandler< / code > s looks like in the next snippet:< / p >
< pre > < code class = "language-kotlin" > buildFSM< TrafficLightState> {
strictlyOn< SomeState> {
// state handling
}
}.start(CoroutineScope(...)).join()
< / code > < / pre >
< div class = "admonition note" >
< p class = "admonition-title" > Full example< / p >
< p >
You may find full example of FSM usage in < a href = "https://github.com/InsanusMokrassar/MicroUtils/blob/master/fsm/common/src/jvmTest/kotlin/PlayableMain.kt" > the tests of FSM in MicroUtils< / a > < / p >
< / div >
< p > So, you must do next steps before you will launch your bot with FSM:< / p >
< ul >
< li > Create your states. Remember that you may plan to save them, so it is likely you will need to serialize it there< / li >
< li > Create your handlers for your states. In most cases it is useful to use < a href = "https://microutils.inmo.dev/micro_utils.dokka/dev.inmo.micro_utils.fsm.common/-checkable-handler-holder/index.html" > CheckableHandlerHolder< / a > if you want to use standard states machine< / li >
< li > Solve which states managers to use (the most simple one is the < a href = "https://microutils.inmo.dev/micro_utils.dokka/dev.inmo.micro_utils.fsm.common.managers/-default-states-manager/index.html" > DefaultStatesManager< / a > with < a href = "https://microutils.inmo.dev/micro_utils.dokka/dev.inmo.micro_utils.fsm.common.managers/-in-memory-default-states-manager-repo/index.html" > InMemoryDefaultStatesManager< / a > )< / li >
< / ul >
< h2 id = "bot-with-fsm" > Bot with FSM< a class = "headerlink" href = "#bot-with-fsm" title = "Permanent link" > ¶ < / a > < / h2 >
< p > There are several extensions for < code > TelegramBot< / code > to create your bot with FSM:< / p >
< ul >
< li > < a href = "https://tgbotapi.inmo.dev/docs/dev.inmo.tgbotapi.extensions.behaviour_builder/build-behaviour-with-f-s-m.html" > buildBehaviourWithFSM< / a > < ul >
< li > < a href = "https://tgbotapi.inmo.dev/docs/dev.inmo.tgbotapi.extensions.behaviour_builder/build-behaviour-with-f-s-m-and-start-long-polling.html" > buildBehaviourWithFSMAndStartLongPolling< / a > < / li >
< / ul >
< / li >
< li > < a href = "https://tgbotapi.inmo.dev/docs/dev.inmo.tgbotapi.extensions.behaviour_builder/telegram-bot-with-behaviour-and-f-s-m.html" > telegramBotWithBehaviourAndFSM< / a > < ul >
< li > < a href = "https://tgbotapi.inmo.dev/docs/dev.inmo.tgbotapi.extensions.behaviour_builder/telegram-bot-with-behaviour-and-f-s-m-and-start-long-polling.html" > telegramBotWithBehaviourAndFSMAndStartLongPolling
< / a > < / li >
< / ul >
< / li >
< / ul >
< p > All of them will take as an callback some object with type < a href = "https://tgbotapi.inmo.dev/docs/dev.inmo.tgbotapi.extensions.behaviour_builder/index.html#-1892390839%2FClasslikes%2F-1982836883" > CustomBehaviourContextReceiver< / a > and will looks like in the next snippet:< / p >
< pre > < code class = "language-kotlin" > telegramBotWithBehaviourAndFSMAndStartLongPolling< YourStateType> (" BOT_TOKEN" ) {
// here you may use any operations from BehaviourBuilder
// here you may use any operations from BehaviourContextWithFSMBuilder like strictlyOn and others
}
< / code > < / pre >
< h2 id = "examples" > Examples< a class = "headerlink" href = "#examples" title = "Permanent link" > ¶ < / a > < / h2 >
< ul >
< li > < a href = "https://github.com/InsanusMokrassar/TelegramBotAPI-examples/blob/master/FSMBot/src/main/kotlin/SimpleFSMBot.kt" > TelegramBotAPI-examples/FSMBot< / a > < / li >
< li > < a href = "https://github.com/InsanusMokrassar/MicroUtils/blob/master/fsm/common/src/jvmTest/kotlin/PlayableMain.kt" > MicroUtils simple example in the tests< / a > < / li >
< / ul >
< / article >
< / div >
< / div >
< button type = "button" class = "md-top md-icon" data-md-component = "top" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z" / > < / svg >
Back to top
< / button >
< / main >
< footer class = "md-footer" >
< nav class = "md-footer__inner md-grid" aria-label = "Footer" >
< a href = "api-extensions.html" class = "md-footer__link md-footer__link--prev" aria-label = "Previous: API Extensions" rel = "prev" >
< div class = "md-footer__button md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" / > < / svg >
< / div >
< div class = "md-footer__title" >
< span class = "md-footer__direction" >
Previous
< / span >
< div class = "md-ellipsis" >
API Extensions
< / div >
< / div >
< / a >
< a href = "behaviour-builder.html" class = "md-footer__link md-footer__link--next" aria-label = "Next: Behaviour Builder" rel = "next" >
< div class = "md-footer__title" >
< span class = "md-footer__direction" >
Next
< / span >
< div class = "md-ellipsis" >
Behaviour Builder
< / div >
< / div >
< div class = "md-footer__button md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z" / > < / svg >
< / div >
< / a >
< / nav >
< div class = "md-footer-meta md-typeset" >
< div class = "md-footer-meta__inner md-grid" >
< div class = "md-copyright" >
Made with
< a href = "https://squidfunk.github.io/mkdocs-material/" target = "_blank" rel = "noopener" >
Material for MkDocs
< / a >
< / div >
< / div >
< / div >
< / footer >
< / div >
< div class = "md-dialog" data-md-component = "dialog" >
< div class = "md-dialog__inner md-typeset" > < / div >
< / div >
< script id = "__config" type = "application/json" > { "base" : "../.." , "features" : [ "announce.dismiss" , "content.action.edit" , "content.action.view" , "content.code.annotate" , "content.code.copy" , "content.tooltips" , "navigation.footer" , "navigation.indexes" , "navigation.sections" , "navigation.tabs" , "navigation.top" , "navigation.tracking" , "search.highlight" , "search.share" , "search.suggest" , "toc.follow" ] , "search" : "../../assets/javascripts/workers/search.208ed371.min.js" , "translations" : { "clipboard.copied" : "Copied to clipboard" , "clipboard.copy" : "Copy to clipboard" , "search.result.more.one" : "1 more on this page" , "search.result.more.other" : "# more on this page" , "search.result.none" : "No matching documents" , "search.result.one" : "1 matching document" , "search.result.other" : "# matching documents" , "search.result.placeholder" : "Type to start searching" , "search.result.term.missing" : "Missing" , "select.version" : "Select version" } } < / script >
< script src = "../../assets/javascripts/bundle.b4d07000.min.js" > < / script >
< / body >
< / html >