Fields
BaseField
- class aiogram.types.fields.BaseField(*, base=None, default=None, alias=None, on_change=None)[source]
Bases:
object
Base field (prop)
Init prop
- Parameters
base – class for child element
default – default value
alias – alias name (for e.g. field ‘from’ has to be named ‘from_user’ as ‘from’ is a builtin Python keyword
on_change – callback will be called when value is changed
- get_value(instance)[source]
Get value for the current object instance
- Parameters
instance –
- Returns
- set_value(instance, value, parent=None)[source]
Set prop value
- Parameters
instance –
value –
parent –
- Returns
Field
- class aiogram.types.fields.Field(*, base=None, default=None, alias=None, on_change=None)[source]
Bases:
BaseField
Simple field
Init prop
- Parameters
base – class for child element
default – default value
alias – alias name (for e.g. field ‘from’ has to be named ‘from_user’ as ‘from’ is a builtin Python keyword
on_change – callback will be called when value is changed
ListField
- class aiogram.types.fields.ListField(*args, **kwargs)[source]
Bases:
Field
The field contains a list of objects
Init prop
- Parameters
base – class for child element
default – default value
alias – alias name (for e.g. field ‘from’ has to be named ‘from_user’ as ‘from’ is a builtin Python keyword
on_change – callback will be called when value is changed
ListOfLists
- class aiogram.types.fields.ListOfLists(*, base=None, default=None, alias=None, on_change=None)[source]
Bases:
Field
Init prop
- Parameters
base – class for child element
default – default value
alias – alias name (for e.g. field ‘from’ has to be named ‘from_user’ as ‘from’ is a builtin Python keyword
on_change – callback will be called when value is changed
DateTimeField
- class aiogram.types.fields.DateTimeField(*, base=None, default=None, alias=None, on_change=None)[source]
Bases:
Field
In this field stored datetime
in: unixtime out: datetime
Init prop
- Parameters
base – class for child element
default – default value
alias – alias name (for e.g. field ‘from’ has to be named ‘from_user’ as ‘from’ is a builtin Python keyword
on_change – callback will be called when value is changed
TextField
- class aiogram.types.fields.TextField(*, prefix=None, suffix=None, default=None, alias=None)[source]
Bases:
Field
Init prop
- Parameters
base – class for child element
default – default value
alias – alias name (for e.g. field ‘from’ has to be named ‘from_user’ as ‘from’ is a builtin Python keyword
on_change – callback will be called when value is changed