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