agala v2.5.1 Agala.BotParams
This module specified generic system for configuration all the variety of Agala
bots.
It helps to keep types of the params in consistence.
Every Agala
bot requires some common params, and also requires some specific params
for only that bot type. Both of them can be specified in BotParams
structure.
BotParams
will be piped throw all the processes of your bot’s lifecycle, untill
the message will be finaly sent to the external environment.
So, the params are:
name
- name for specific bot. You can read about names and why they are so important.provider
- the name of theprovider
which will be used in this bot. You can read about them here.handler
- handler’s pipline, which will work with incomming messages and do all the business logic. Thees modules you will create during your application development. You can read about handlers pipline here.provider_params
- params, that are needed only for specifiedprovider
. Agala framework does not define any structure for these params, you can find it in yourprovider
s documentation.private
- sepcial place to put some additional information. These params can be precalculated by the internal processes of initiation for your provider, or to cache some data. In common situations you should not use it at all, until you are developing your ownprovider
.common
- almost the same as private params, but they are the same across all possible providers. Read about them in the section below.
Common params.
Common params works the same as private params - store information for providers. But,
they are common for each and every provider, and can touch not only Agala.Provider
specific layer, but also Agala
layer. You can use them inside your providers to control
application flow:
restart: true
will forceAgala.Bot.Receiver
process to restart in next cycle.
Link to this section Summary
Types
Type, representing Agala.BotParams
struct
Link to this section Types
Type, representing Agala.BotParams
struct.