]>
Commit | Line | Data |
---|---|---|
a8b666e9 C |
1 | // {hookType}:{api?}.{location}.{subLocation?}.{actionType}.{target} |
2 | ||
7663e55a | 3 | export const serverFilterHookObject = { |
5f189c9c C |
4 | // Filter params/result used to list videos for the REST API |
5 | // (used by the trending page, recently-added page, local page etc) | |
7663e55a C |
6 | 'filter:api.videos.list.params': true, |
7 | 'filter:api.videos.list.result': true, | |
5f189c9c C |
8 | // Filter the result of the get function |
9 | // Used to get detailed video information (video watch page for example) | |
7663e55a | 10 | 'filter:api.video.get.result': true, |
b4055e1c | 11 | |
5f189c9c C |
12 | // Filter the result of the accept upload function |
13 | // If this function returns false then the upload is aborted with an error | |
7663e55a | 14 | 'filter:api.video.upload.accept.result': true, |
5f189c9c C |
15 | // Filter the result of the accept comment (thread or reply) functions |
16 | // If the functions return false then the user cannot post its comment | |
7663e55a C |
17 | 'filter:api.video-thread.create.accept.result': true, |
18 | 'filter:api.video-comment-reply.create.accept.result': true, | |
b4055e1c | 19 | |
5f189c9c C |
20 | // Filter params/result used to list threads of a specific video |
21 | // (used by the video watch page) | |
7663e55a C |
22 | 'filter:api.video-threads.list.params': true, |
23 | 'filter:api.video-threads.list.result': true, | |
b4055e1c | 24 | |
5f189c9c C |
25 | // Filter params/result used to list replies of a specific thread |
26 | // (used by the video watch page when we click on the "View replies" button) | |
7663e55a C |
27 | 'filter:api.video-thread-comments.list.params': true, |
28 | 'filter:api.video-thread-comments.list.result': true, | |
6691c522 | 29 | |
5f189c9c C |
30 | // Filter result used to check if we need to auto blacklist a video |
31 | // (fired when a local or remote video is created or updated) | |
7663e55a C |
32 | 'filter:video.auto-blacklist.result': true |
33 | } | |
34 | ||
35 | export type ServerFilterHookName = keyof typeof serverFilterHookObject | |
b4055e1c | 36 | |
7663e55a | 37 | export const serverActionHookObject = { |
5f189c9c | 38 | // Fired when the application has been loaded and is listening HTTP requests |
7663e55a | 39 | 'action:application.listening': true, |
b4055e1c | 40 | |
5f189c9c | 41 | // Fired when a local video is updated |
7663e55a | 42 | 'action:api.video.updated': true, |
5f189c9c | 43 | // Fired when a local video is deleted |
7663e55a | 44 | 'action:api.video.deleted': true, |
5f189c9c | 45 | // Fired when a local video is uploaded |
7663e55a | 46 | 'action:api.video.uploaded': true, |
5f189c9c | 47 | // Fired when a local video is viewed |
7663e55a C |
48 | 'action:api.video.viewed': true, |
49 | ||
5f189c9c | 50 | // Fired when a thread is created |
7663e55a | 51 | 'action:api.video-thread.created': true, |
5f189c9c | 52 | // Fired when a reply to a thread is created |
7663e55a | 53 | 'action:api.video-comment-reply.created': true, |
5f189c9c | 54 | // Fired when a comment (thread or reply) is deleted |
7663e55a C |
55 | 'action:api.video-comment.deleted': true |
56 | } | |
b4055e1c | 57 | |
7663e55a | 58 | export type ServerActionHookName = keyof typeof serverActionHookObject |
b4055e1c | 59 | |
7663e55a C |
60 | export const serverHookObject = Object.assign({}, serverFilterHookObject, serverActionHookObject) |
61 | export type ServerHookName = keyof typeof serverHookObject | |
b4055e1c C |
62 | |
63 | export interface ServerHook { | |
93cae479 | 64 | runHook <T> (hookName: ServerHookName, result?: T, params?: any): Promise<T> |
b4055e1c | 65 | } |