Views documenation¶
Message Views¶
-
class
aiogram_oop_framework.views.message.MessageView¶ View for updates of type “message”
-
custom_filters¶ Custom filters (for ex.: [lambda m: m.reply_to_message]).
Type: list
-
commands¶ List of commands (for ex.: [‘start’, ‘help’]), defaults to None
Type: list
-
regexp¶ Regexp string for matching message text/caption (for ex.: r’^hello$’), defaults to None
Type: str
-
content_types¶ List of content_type’s of message (for ex.: [‘text’, ‘photo’]), defaults to None
Type: list
-
state¶ Function, which returns a State object of aiogram or “*”, defaults to lambda: None
Type: Callable
-
run_task¶ Run callback in task (no wait results), defaults to None
Type: bool
-
register_kwargs¶ Kwargs, which you would add in @dp.message_handler in fresh aiogram, defaults to None
Type: dict
-
index¶ in which order to register the view, defaults to None
Type: int
-
auto_register¶ set to False if you don’t want re register the view autcomatically, ignored, if AUTO_REGISTER_VIEWS in settings.py is set to False, defaults to True
Type: bool
Make sure you don’t want to use a more high-level view like
aiogram_oop_framework.views.custom_views.command.CommandVieworaiogram_oop_framework.views.content_types_views.text.TextViewinstead.You may found more info about custom_filters, commands, regexp, content_types, state and run_task attributes attributes in aiogram’s docs on Dispatcher.message_handler or you may not, depends on aiogram’s docs.
-
classmethod
register(dp: aiogram.dispatcher.dispatcher.Dispatcher)¶ method to register the handler, normally called automatically in manage.initialize_project()
Parameters: dp (Dispatcher) – in which dispatcher to register the handler
-
-
class
aiogram_oop_framework.views.edited_message_view.EditedMessageView¶ -
classmethod
register(dp: aiogram.dispatcher.dispatcher.Dispatcher)¶ method to register the handler, normally called automatically in manage.initialize_project()
Parameters: dp (Dispatcher) – in which dispatcher to register the handler
-
classmethod
-
class
aiogram_oop_framework.views.channel_post_view.ChannelPostView¶ -
classmethod
register(dp: aiogram.dispatcher.dispatcher.Dispatcher)¶ method to register the handler, normally called automatically in manage.initialize_project()
Parameters: dp (Dispatcher) – in which dispatcher to register the handler
-
classmethod
-
class
aiogram_oop_framework.views.edited_channel_post_view.EditedChannelPostView¶ -
classmethod
register(dp: aiogram.dispatcher.dispatcher.Dispatcher)¶ method to register the handler, normally called automatically in manage.initialize_project()
Parameters: dp (Dispatcher) – in which dispatcher to register the handler
-
classmethod
Views by content_types¶
-
class
aiogram_oop_framework.views.content_types_views.animation.AnimationView¶ May be same as
aiogram_oop_framework.views.message.MessageView, oraiogram_oop_framework.views.edited_message_view.EditedMessageView, oraiogram_oop_framework.views.channel_post_view.ChannelPostView, oraiogram_oop_framework.views.edited_channel_post_view.EditedChannelPostView, dependently on update_type field, with difference that content_types field defaults to [ContentType.ANIMATION], and it has one more field:-
update_type¶ Update type, must be one of: ‘message’, ‘edited_message’, ‘channel_post’, ‘edited_channel_post’, defaults to ‘message’s
Type: str
-
-
class
aiogram_oop_framework.views.content_types_views.audio.AudioView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.AUDIO]
-
class
aiogram_oop_framework.views.content_types_views.connected_website.ConnectedWebsiteView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.CONNECTED_WEBSITE]
-
class
aiogram_oop_framework.views.content_types_views.contact.ContactView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.CONTACT]
-
class
aiogram_oop_framework.views.content_types_views.delete_chat_photo.DeleteChatPhotoView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.DELETE_CHAT_PHOTO]
-
class
aiogram_oop_framework.views.content_types_views.dice.DiceView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.DICE]
-
class
aiogram_oop_framework.views.content_types_views.document.DocumentView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.DOCUMENT]
-
class
aiogram_oop_framework.views.content_types_views.game.GameView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.GAME]
-
class
aiogram_oop_framework.views.content_types_views.group_chat_created.GroupChatCreatedView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.GROUP_CHAT_CREATED]
-
class
aiogram_oop_framework.views.content_types_views.invoice.InvoiceView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.INVOICE]
-
class
aiogram_oop_framework.views.content_types_views.left_chat_member.LeftChatMemberView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.LEFT_CHAT_MEMBER]
-
class
aiogram_oop_framework.views.content_types_views.location.LocationView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.LOCATION]
-
class
aiogram_oop_framework.views.content_types_views.migrate_from_chat_id.MigrateFromChatIdView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.MIGRATE_FROM_CHAT_ID]
-
class
aiogram_oop_framework.views.content_types_views.migrate_to_chat_id.MigrateToChatIdView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.MIGRATE_TO_CHAT_ID]
-
class
aiogram_oop_framework.views.content_types_views.new_chat_members.NewChatMembersView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.NEW_CHAT_MEMBERS]
-
class
aiogram_oop_framework.views.content_types_views.new_chat_photo.NewChatPhotoView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.NEW_CHAT_PHOTO]
-
class
aiogram_oop_framework.views.content_types_views.new_chat_title.NewChatTitleView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.NEW_CHAT_TITLE]
-
class
aiogram_oop_framework.views.content_types_views.passport_data.PassportDataView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.PASSPORT_DATA]
-
class
aiogram_oop_framework.views.content_types_views.photo.PhotoView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.PHOTO]
-
class
aiogram_oop_framework.views.content_types_views.pinned_message.PinnedMessageView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.PINNED_MESSAGE]
-
class
aiogram_oop_framework.views.content_types_views.poll.PollMessageView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.POLL]
-
class
aiogram_oop_framework.views.content_types_views.sticker.StickerView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.STICKER]
-
class
aiogram_oop_framework.views.content_types_views.successful_payment.SuccessfulPaymentView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.SUCCESSFUL_PAYMENT]
-
class
aiogram_oop_framework.views.content_types_views.text.TextView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.TEXT]
-
class
aiogram_oop_framework.views.content_types_views.venue.VenueView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.VENUE]
-
class
aiogram_oop_framework.views.content_types_views.video.VideoView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.VIDEO]
-
class
aiogram_oop_framework.views.content_types_views.video_note.VideoNoteView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.VIDEO_NOTE]
-
class
aiogram_oop_framework.views.content_types_views.voice.VoiceView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to [ContentType.VOICE]
-
class
aiogram_oop_framework.views.content_types_views.any_content_type_message.AnyContentTypeMessageView¶ Same as
aiogram_oop_framework.views.content_types_views.animation.AnimationView, but content_types defaults to ContentType.all()
Other update types’ views¶
-
class
aiogram_oop_framework.views.inline_query.InlineQueryView¶ View for updates of type “message”
-
custom_filters¶ Custom filters (for ex.: [lambda m: m.reply_to_message]).
Type: list
-
state¶ Function, which returns a State object of aiogram or “*”
Type: Callable
-
run_task¶ Run callback in task (no wait results)
Type: bool
-
register_kwargs¶ Kwargs, which you would add in @dp.message_handler in fresh aiogram
Type: dict
You may found more info about attributes in aiogram’s docs on Dispatcher.message_handler or you may not, depends on aiogram’s docs.
-
-
class
aiogram_oop_framework.views.callback_query.CallbackQueryView¶
-
class
aiogram_oop_framework.views.poll.PollView¶
-
class
aiogram_oop_framework.views.poll_answer.PollAnswerView¶
-
class
aiogram_oop_framework.views.shipping_query.ShippingQueryView¶
Custom views¶
-
class
aiogram_oop_framework.views.custom_views.command.CommandView¶ May be same as
aiogram_oop_framework.views.message.MessageView, oraiogram_oop_framework.views.edited_message_view.EditedMessageView, oraiogram_oop_framework.views.channel_post_view.ChannelPostView, oraiogram_oop_framework.views.edited_channel_post_view.EditedChannelPostView, dependently on update_type field, with difference that content_types field defaults to [ContentType.TEXT], and it has some differences, look down:-
update_type¶ Update type, must be one of: ‘message’, ‘edited_message’, ‘channel_post’, ‘edited_channel_post’, defaults to ‘message’
Type: str
-
append_commands¶ If you set commands manually, does it need to append to the commands the default command or not
Type: bool
while registering looks at your view’s name and creates a default command with it (Start -> [‘start’])
-
classmethod
register(dp: aiogram.dispatcher.dispatcher.Dispatcher)¶
-