LogoLogo
  • AppFlowy
    • ⭐Start here
      • Welcome to AppFlowy Docs
      • How to get help
      • Install AppFlowy
    • 🛠️Installation
      • 🖥️System Requirements
      • 💿Installation methods
        • Mac / Windows / Linux Packages
          • Installing on Linux
            • Installing & Setting up Flutter on Linux from Source
        • Docker
    • 🌱Community
      • 🤙Get in contact
      • 📔AppFlowy Mentorship Program
        • Program Guidance
        • Proposal Template
        • Pull Request Template
        • Mentorship 2023
          • Mentee Projects
            • Calendar View for AppFlowy Database
            • Custom Themes
            • Shortcuts and Customized Hotkeys for AppFlowy
            • Table
            • ⭐Favorites
            • Code Block
            • Outlines
            • Importers
            • AI Writers
            • Templates
          • Project Ideas
      • ✍️Write for AppFlowy
        • 📃Drafts
          • [Draft] Use Case: Software Engineer
          • [Draft] Use Case: High School Students
          • [Draft] How to add a new property to appflowy database
      • 🍂Hacktoberfest
    • 🛣️Roadmap
    • 🌋Product
      • 💽Data Storage
      • 🎨Customize and Style Content
      • ⏮️Duplicate, Delete, and Restore
      • 💎Databases
        • 🔢Database Properties
        • 🗃️Manage Properties
      • Ⓜ️Markdown
      • ⌨️Shortcuts
      • 🪄AppFlowy AI
      • 🦙AppFlowy Local AI - Ollama
      • 🎨Themes
      • ☁️AppFlowy Cloud
      • 🧩AppFlowy Plugins
        • Table-view Databases
        • Kanban Board
        • Calendar
        • Auto Generator
        • Smart Edit
        • Code Blocks
        • Math Equations
        • Cover
        • Emoji
  • Documentation
    • 💎Software Contributions
      • 🟢Get started
      • 💀Architecture
        • Frontend
          • Tauri
            • 🗺️CodeMap
          • Web
            • 🌟Design Philosophy
          • Flutter
            • 🗺️Project Structure: CodeMap
            • 🧮Grid
            • ⚙️Setting
          • Inter-Process Communication
          • User
            • User Data
            • Events & Notifications
          • Folder
            • Events & Notifications
          • Document
          • Database View
            • Events & Notifications
            • Grid
            • Calendar
            • Kanban Board
        • Backend
          • Initialize
          • Events
          • Delta(WIP)
          • Profiling
          • Database
        • Domain Driven Design
        • Proposals
      • 🏗️Conventions
        • 🔤Naming Conventions
        • ⌨️Code Conventions
          • 🐦Flutter
        • 🐙Git Conventions
      • 💛Submitting Code
        • 🏦Setting Up Your Repositories
        • ⤴️Submitting your first Pull Request
      • 🤟Coding Standards and Practices
        • 👽Rust Backend
    • 🚀AppFlowy
      • 👾How to contribute to AppFlowy
      • 🏗️Building from Source
        • 🌳Flutter Setup
          • 🐧Building on Linux
          • 🍎Building on macOS
          • 🪟Building on Windows
        • 🌐Web Setup
        • 📡Tauri Setup
      • ☁️Debugging with AppFlowy Cloud
      • 🔁Debugging in VS Code
      • ☎️Translate AppFlowy
      • ❓Troubleshooting
      • 👮‍♀️Licenses
    • 🏍️AppFlowy Editor
      • ⌨️How to Implement Markdown Syntax To Style Text In AppFlowy Editor
      • 🧩How to Create a Plugin for AppFlowy Editor
      • 👮‍♀️Licenses
    • ☁️AppFlowy Cloud
      • 🌈Architecture
      • ☀️Deployment
  • Guides
    • Sync Desktop and Mobile
    • Self-Hosting AppFlowy
      • ☁️Self-hosting AppFlowy with AppFlowy Cloud
      • 🆓Self-hosting AppFlowy for free Using Supabase
    • Import From Notion
  • Blog Highlights
    • 🔮Demystifying AppFlowy Editor's Codebase
  • Handbook
    • Core values
Powered by GitBook
On this page
  • Events
  • Notifications

Was this helpful?

Edit on GitHub
  1. Documentation
  2. Software Contributions
  3. Architecture
  4. Frontend
  5. Database View

Events & Notifications

PreviousDatabase ViewNextGrid

Last updated 2 years ago

Was this helpful?

Events are used in the between the frontend and the backend. If you interested in the process about generating the events files, please check out.

This document explains the events and notifications defined in the database scope.

Events

DatabaseEvent

GetDatabase

Create the data including list of Field and list of Row of the database

GetDatabaseSetting

Get the settings including filters/sorts configuration of the database

UpdateDatabaseSetting

Update the settings of the database

GetAllFilters

Return all the filter configurations that the database has

GetAllSorts

Return all the sort configuration that the database has

DeleteAllSorts

Delete all the sort configuration of the database

GetFields

Get all the fields of the database

UpdateField

Update the field of the database

UpdateFieldTypeOption

Update the TypeOption of the field of the database

DeleteField

Delete the field of the database

UpdateFieldType

Modify the type of the field

DuplicateField

Duplicate the field of the database

GetTypeOption

Get the TypeOption for specific field type of the field

CreateTypeOption

Create TypeOption for specific field type

CreateSelectOption

Create a new option. It's used when the field type is SingleSelect, Multi-select, and Checklist

GetSelectOptionCellData

Get the cell data of the option

UpdateSelectOption

Update the option content

CreateRow

Create a new row in the database

GetRow

Get the data of the row

DeleteRow

Delete the row in the database

DuplicateRow

Duplicate a row

GetCell

Get the data of the cell

UpdateCell

Update the data of the cell

UpdateSelectOptionCell

Update the data of the cell when the field type is SingleSelect, Multi-select, and Checklist

UpdateDateCell

Update the data of the cell when the field type is Date

Notifications

DatabaseNotification

DidUpdateViewRows

Trigger after inserting/deleting/updating a row

DidUpdateViewRowsVisibility

Trigger when the visibility of the row was changed. For example, updating the filter will trigger the notification

DidUpdateFields

Trigger after inserting/deleting/updating a field

DidUpdateCell

Trigger after editing a cell

DidUpdateField

Trigger after editing a field properties including rename,update type option, etc.

DidUpdateGroups

Trigger after the number of groups is changed

DidUpdateGroupRow

Trigger after inserting/deleting/updating/moving a row

DidGroupByField

Trigger when setting a new grouping field

DidUpdateFilter

Trigger after inserting/deleting/updating a filter

DidUpdateSort

Trigger after inserting/deleting/updating a sort

DidReorderRows

Trigger after the sort configurations are changed

DidReorderSingleRow

Trigger after editing the row that hit the sort rule

DidUpdateSetting

Trigger when the settings of the database are changed

💎
💀
communication
this