]>
Commit | Line | Data |
---|---|---|
1 | // {hookType}:{api?}.{location}.{subLocation?}.{actionType}.{target} | |
2 | ||
3 | export const serverFilterHookObject = { | |
4 | // Filter params/result used to list videos for the REST API | |
5 | // (used by the trending page, recently-added page, local page etc) | |
6 | 'filter:api.videos.list.params': true, | |
7 | 'filter:api.videos.list.result': true, | |
8 | // Filter the result of the get function | |
9 | // Used to get detailed video information (video watch page for example) | |
10 | 'filter:api.video.get.result': true, | |
11 | ||
12 | // Filter the result of the accept upload, import via torrent or url functions | |
13 | // If this function returns false then the upload is aborted with an error | |
14 | 'filter:api.video.upload.accept.result': true, | |
15 | 'filter:api.video.pre-import-url.accept.result': true, | |
16 | 'filter:api.video.pre-import-torrent.accept.result': true, | |
17 | 'filter:api.video.post-import-url.accept.result': true, | |
18 | 'filter:api.video.post-import-torrent.accept.result': true, | |
19 | // Filter the result of the accept comment (thread or reply) functions | |
20 | // If the functions return false then the user cannot post its comment | |
21 | 'filter:api.video-thread.create.accept.result': true, | |
22 | 'filter:api.video-comment-reply.create.accept.result': true, | |
23 | ||
24 | // Filter params/result used to list threads of a specific video | |
25 | // (used by the video watch page) | |
26 | 'filter:api.video-threads.list.params': true, | |
27 | 'filter:api.video-threads.list.result': true, | |
28 | ||
29 | // Filter params/result used to list replies of a specific thread | |
30 | // (used by the video watch page when we click on the "View replies" button) | |
31 | 'filter:api.video-thread-comments.list.params': true, | |
32 | 'filter:api.video-thread-comments.list.result': true, | |
33 | ||
34 | // Filter result used to check if we need to auto blacklist a video | |
35 | // (fired when a local or remote video is created or updated) | |
36 | 'filter:video.auto-blacklist.result': true, | |
37 | ||
38 | // Filter result used to check if a user can register on the instance | |
39 | 'filter:api.user.signup.allowed.result': true | |
40 | } | |
41 | ||
42 | export type ServerFilterHookName = keyof typeof serverFilterHookObject | |
43 | ||
44 | export const serverActionHookObject = { | |
45 | // Fired when the application has been loaded and is listening HTTP requests | |
46 | 'action:application.listening': true, | |
47 | ||
48 | // Fired when a local video is updated | |
49 | 'action:api.video.updated': true, | |
50 | // Fired when a local video is deleted | |
51 | 'action:api.video.deleted': true, | |
52 | // Fired when a local video is uploaded | |
53 | 'action:api.video.uploaded': true, | |
54 | // Fired when a local video is viewed | |
55 | 'action:api.video.viewed': true, | |
56 | ||
57 | // Fired when a thread is created | |
58 | 'action:api.video-thread.created': true, | |
59 | // Fired when a reply to a thread is created | |
60 | 'action:api.video-comment-reply.created': true, | |
61 | // Fired when a comment (thread or reply) is deleted | |
62 | 'action:api.video-comment.deleted': true, | |
63 | ||
64 | // Fired when a user is blocked (banned) | |
65 | 'action:api.user.blocked': true, | |
66 | // Fired when a user is unblocked (unbanned) | |
67 | 'action:api.user.unblocked': true, | |
68 | // Fired when a user registered on the instance | |
69 | 'action:api.user.registered': true, | |
70 | // Fired when an admin/moderator created a user | |
71 | 'action:api.user.created': true, | |
72 | // Fired when a user is removed by an admin/moderator | |
73 | 'action:api.user.deleted': true, | |
74 | // Fired when a user is updated by an admin/moderator | |
75 | 'action:api.user.updated': true, | |
76 | ||
77 | // Fired when a user got a new oauth2 token | |
78 | 'action:api.user.oauth2-got-token': true | |
79 | } | |
80 | ||
81 | export type ServerActionHookName = keyof typeof serverActionHookObject | |
82 | ||
83 | export const serverHookObject = Object.assign({}, serverFilterHookObject, serverActionHookObject) | |
84 | export type ServerHookName = keyof typeof serverHookObject | |
85 | ||
86 | export interface ServerHook { | |
87 | runHook <T> (hookName: ServerHookName, result?: T, params?: any): Promise<T> | |
88 | } |