Skip to content

Commit 6da5114

Browse files
committed
Document existing events
* LoadAdditionalScripts (@rullzer) - nextcloud/server#16641 * LoadViewerEvent (@skjnldsv) - nextcloud/viewer#271 * RegisterDirectEditorEvent (@juliushaertl) - nextcloud/server#17625 * typed events for files scanner (@ChristophWurst) - nextcloud/server#18351 * typed events for group mangement (@ChristophWurst) - nextcloud/server#18350 * AddContentSecurityPolicyEvent (@rullzer) - nextcloud/server#15730 * UserLiveStatusEvent (@georgehrke) - nextcloud/server#21186 * password_policy events (@ChristophWurst) - nextcloud/server#18019 * AddFeaturePolicyEvent (@rullzer) - nextcloud/server#16613 * ShareCreatedEvent (@rullzer) - nextcloud/server#18384 * LoadSettingsScriptsEvent (@blizzz) - nextcloud/server#21475 * flow events (@rullzer) - nextcloud/server#18535 Signed-off-by: Morris Jobke <hey@morrisjobke.de>
1 parent 5acd77b commit 6da5114

File tree

1 file changed

+144
-10
lines changed

1 file changed

+144
-10
lines changed

developer_manual/app/events.rst

Lines changed: 144 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,133 @@ Available Events
167167

168168
Here you find an overview of the public events that can be consumed in apps. See their source files for more details.
169169

170+
``\OCA\Files\Event\LoadAdditionalScriptsEvent``
171+
***********************************************
172+
173+
*Available in Nextcloud 17 and later.*
174+
175+
This event is triggered when the files app is rendered. It canb e used to add additional scripts to the files app.
176+
177+
``\OCA\Viewer\Event\LoadViewer``
178+
********************************
179+
180+
*Available in Nextcloud 17 and later.*
181+
182+
This event is triggered whenever the viewer is loaded and extensions should be loaded.
183+
184+
``\OCP\DirectEditing\RegisterDirectEditorEvent``
185+
************************************************
186+
187+
*Available in Nextcloud 18 and later.*
188+
189+
Event to allow to register the direct editor.
190+
191+
``\OCP\Files\Events\BeforeFileScannedEvent``
192+
********************************************
193+
194+
*Available in Nextcloud 18 and later.*
195+
196+
``\OCP\Files\Events\BeforeFolderScannedEvent``
197+
**********************************************
198+
199+
*Available in Nextcloud 18 and later.*
200+
201+
``\OCP\Files\Events\FileCacheUpdated``
202+
**************************************
203+
204+
*Available in Nextcloud 18 and later.*
205+
206+
``\OCP\Files\Events\FileScannedEvent``
207+
**************************************
208+
209+
*Available in Nextcloud 18 and later.*
210+
211+
``\OCP\Files\Events\FolderScannedEvent``
212+
****************************************
213+
214+
*Available in Nextcloud 18 and later.*
215+
216+
``\OCP\Files\Events\NodeAddedToCache``
217+
**************************************
218+
219+
*Available in Nextcloud 18 and later.*
220+
221+
``\OCP\Files\Events\NodeRemovedFromCache``
222+
******************************************
223+
224+
*Available in Nextcloud 18 and later.*
225+
226+
``\OCP\Group\Events\BeforeGroupCreatedEvent``
227+
*********************************************
228+
229+
*Available in Nextcloud 18 and later.*
230+
231+
``\OCP\Group\Events\BeforeGroupDeletedEvent``
232+
*********************************************
233+
234+
*Available in Nextcloud 18 and later.*
235+
236+
``\OCP\Group\Events\BeforeUserAddedEvent``
237+
******************************************
238+
239+
*Available in Nextcloud 18 and later.*
240+
241+
``\OCP\Group\Events\BeforeUserRemovedEvent``
242+
********************************************
243+
244+
*Available in Nextcloud 18 and later.*
245+
246+
``\OCP\Group\Events\GroupCreatedEvent``
247+
***************************************
248+
249+
*Available in Nextcloud 18 and later.*
250+
251+
``\OCP\Group\Events\GroupDeletedEvent``
252+
***************************************
253+
254+
*Available in Nextcloud 18 and later.*
255+
256+
``\OCP\Group\Events\UserAddedEvent``
257+
************************************
258+
259+
*Available in Nextcloud 18 and later.*
260+
261+
``\OCP\Group\Events\UserRemovedEvent``
262+
**************************************
263+
264+
*Available in Nextcloud 18 and later.*
265+
266+
``\OCP\Security\CSP\AddContentSecurityPolicyEvent``
267+
***************************************************
268+
269+
*Available in Nextcloud 17 and later.*
270+
271+
Allows to inject something into the default content policy. This is for example useful when you're injecting Javascript code into a view belonging to another controller and cannot modify its Content-Security-Policy itself. Note that the adjustment is only applied to applications that use AppFramework controllers.
272+
273+
WARNING: Using this API incorrectly may make the instance more insecure. Do think twice before adding whitelisting resources. Please do also note that it is not possible to use the `disallowXYZ` functions.
274+
275+
``\OCP\Security\Events\GenerateSecurePasswordEvent``
276+
****************************************************
277+
278+
*Available in Nextcloud 18 and later.*
279+
280+
``\OCP\Security\Events\ValidatePasswordPolicyEvent``
281+
****************************************************
282+
283+
*Available in Nextcloud 18 and later.*
284+
285+
``\OCP\Security\FeaturePolicy\AddFeaturePolicyEvent``
286+
****************************************************
287+
288+
*Available in Nextcloud 17 and later.*
289+
290+
Event that allows to register a feature policy header to a request.
291+
292+
``\OCP\Share\Events\ShareCreatedEvent``
293+
*******************************************
294+
295+
*Available in Nextcloud 18 and later.*
296+
170297
``\OCP\User\Events\BeforeUserLoggedInWithCookieEvent``
171298
******************************************************
172299

@@ -177,10 +304,10 @@ Emitted before a user is logged in via remember-me cookies.
177304
``\OCP\User\Events\UserLoggedInWithCookieEvent``
178305
************************************************
179306

180-
Emitted when a user has been succesfully logged in via remember-me cookies.
181-
182307
*Available in Nextcloud 18 and later.*
183308

309+
Emitted when a user has been succesfully logged in via remember-me cookies.
310+
184311
``\OCP\User\Events\BeforePasswordUpdatedEvent``
185312
***********************************************
186313

@@ -214,15 +341,11 @@ Emitted when a new user has been created on the back-end.
214341

215342
*Available in Nextcloud 18 and later.*
216343

217-
Emitted before a user is logged out.
218-
219344
``\OCP\User\Events\UserDeletedEvent``
220345
*************************************
221346

222347
*Available in Nextcloud 18 and later.*
223348

224-
Emitted when a user has been logged out successfully.
225-
226349
``\OCP\User\Events\BeforeUserLoggedInEvent``
227350
********************************************
228351

@@ -233,6 +356,8 @@ Emitted when a user has been logged out successfully.
233356

234357
*Available in Nextcloud 18 and later.*
235358

359+
Emitted before a user is logged out.
360+
236361
``\OCP\User\Events\CreateUserEvent``
237362
************************************
238363

@@ -258,13 +383,22 @@ Emitted when a user has been logged out successfully.
258383

259384
*Available in Nextcloud 18 and later.*
260385

261-
``\OCP\Security\CSP\AddContentSecurityPolicyEvent``
262-
***************************************************
386+
Emitted when a user has been logged out successfully.
263387

264-
*Available in Nextcloud 17 and later.*
388+
``\OCP\WorkflowEngine\RegisterChecksEvent``
389+
***************************************
390+
391+
*Available in Nextcloud 18 and later.*
392+
393+
``\OCP\WorkflowEngine\RegisterEntitiesEvent``
394+
***************************************
265395

266-
This event is emitted so apps can modify the CSP provided by nextcloud. For example if more domains can be used to connect to. Added in Nextcloud 17.
396+
*Available in Nextcloud 18 and later.*
267397

398+
``\OCP\WorkflowEngine\RegisterOperationsEvent``
399+
***************************************
400+
401+
*Available in Nextcloud 18 and later.*
268402

269403
Symfony event dispatcher
270404
------------------------

0 commit comments

Comments
 (0)