khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-03 02:09:45 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9225 from nextcloud/feat/improve-flow-documentation

Browse Source 
Complete workflow development documentation
This commit is contained in:
Côme Chilliet
2023-01-12 17:53:11 +01:00
committed by GitHub
parent 602b315f37 e36556873c
commit 8a090407e9
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
developer_manual/digging_deeper/flow.rst
View File

@@ -30,8 +30,10 @@ Operations
Operations are actions that users can configure to happen when specific events occur.
An operation is a class implementing ISpecificOperation, IOperation or IComplexOperation. Specific operations can only act on one specific entity (e.g. a file), while normal operations can oact on all events. Complex operations do not listen on events but setup their own listener(s).
An operation is a class implementing ISpecificOperation, IOperation or IComplexOperation. Specific operations can only act on one specific entity (e.g. a file), while normal operations can act on all events. Complex operations do not listen on events but setup their own listener(s).
Your operation needs to implement ``validateOperation`` method, which will be called upon validating a flow configuration for your flow in the settings. The function must check that the configuration is correct and throw if that is not the case.
Once your operation is configured by the user, its ``onEvent`` method will be called on any event it is configured for, even if the rules are not matching. So you need to use the ``$ruleMatcher`` parameter to loop through matching rules and check if there are any. For each match the 'operation' key in the array is what the user configured for this rule in the settings.
Configuration Component
=======================