]>
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 | ||
a4d2ca07 C |
17 | // Filter params/result used to list my user videos for the REST API |
18 | 'filter:api.user.me.videos.list.params': true, | |
19 | 'filter:api.user.me.videos.list.result': true, | |
20 | ||
74a4d531 C |
21 | // Filter params/results to search videos/channels in the DB or on the remote index |
22 | 'filter:api.search.videos.local.list.params': true, | |
23 | 'filter:api.search.videos.local.list.result': true, | |
24 | 'filter:api.search.videos.index.list.params': true, | |
25 | 'filter:api.search.videos.index.list.result': true, | |
26 | 'filter:api.search.video-channels.local.list.params': true, | |
27 | 'filter:api.search.video-channels.local.list.result': true, | |
28 | 'filter:api.search.video-channels.index.list.params': true, | |
29 | 'filter:api.search.video-channels.index.list.result': true, | |
37a44fc9 C |
30 | 'filter:api.search.video-playlists.local.list.params': true, |
31 | 'filter:api.search.video-playlists.local.list.result': true, | |
32 | 'filter:api.search.video-playlists.index.list.params': true, | |
33 | 'filter:api.search.video-playlists.index.list.result': true, | |
74a4d531 | 34 | |
5f189c9c C |
35 | // Filter the result of the get function |
36 | // Used to get detailed video information (video watch page for example) | |
7663e55a | 37 | 'filter:api.video.get.result': true, |
b4055e1c | 38 | |
3cabf353 | 39 | // Filter the result of the accept upload/live, import via torrent/url functions |
5f189c9c | 40 | // If this function returns false then the upload is aborted with an error |
7663e55a | 41 | 'filter:api.video.upload.accept.result': true, |
3cabf353 | 42 | 'filter:api.live-video.create.accept.result': true, |
2158ac90 RK |
43 | 'filter:api.video.pre-import-url.accept.result': true, |
44 | 'filter:api.video.pre-import-torrent.accept.result': true, | |
45 | 'filter:api.video.post-import-url.accept.result': true, | |
46 | 'filter:api.video.post-import-torrent.accept.result': true, | |
5f189c9c C |
47 | // Filter the result of the accept comment (thread or reply) functions |
48 | // If the functions return false then the user cannot post its comment | |
7663e55a C |
49 | 'filter:api.video-thread.create.accept.result': true, |
50 | 'filter:api.video-comment-reply.create.accept.result': true, | |
b4055e1c | 51 | |
5f189c9c C |
52 | // Filter params/result used to list threads of a specific video |
53 | // (used by the video watch page) | |
7663e55a C |
54 | 'filter:api.video-threads.list.params': true, |
55 | 'filter:api.video-threads.list.result': true, | |
b4055e1c | 56 | |
5f189c9c C |
57 | // Filter params/result used to list replies of a specific thread |
58 | // (used by the video watch page when we click on the "View replies" button) | |
7663e55a C |
59 | 'filter:api.video-thread-comments.list.params': true, |
60 | 'filter:api.video-thread-comments.list.result': true, | |
6691c522 | 61 | |
5f189c9c C |
62 | // Filter result used to check if we need to auto blacklist a video |
63 | // (fired when a local or remote video is created or updated) | |
4ce7eb71 C |
64 | 'filter:video.auto-blacklist.result': true, |
65 | ||
66 | // Filter result used to check if a user can register on the instance | |
4bc45da3 C |
67 | 'filter:api.user.signup.allowed.result': true, |
68 | ||
69 | // Filter result used to check if video/torrent download is allowed | |
70 | 'filter:api.download.video.allowed.result': true, | |
eebd9838 C |
71 | 'filter:api.download.torrent.allowed.result': true, |
72 | ||
73 | // Filter result to check if the embed is allowed for a particular request | |
74 | 'filter:html.embed.video.allowed.result': true, | |
75 | 'filter:html.embed.video-playlist.allowed.result': true | |
7663e55a C |
76 | } |
77 | ||
78 | export type ServerFilterHookName = keyof typeof serverFilterHookObject | |
b4055e1c | 79 | |
7663e55a | 80 | export const serverActionHookObject = { |
5f189c9c | 81 | // Fired when the application has been loaded and is listening HTTP requests |
7663e55a | 82 | 'action:application.listening': true, |
b4055e1c | 83 | |
5f189c9c | 84 | // Fired when a local video is updated |
7663e55a | 85 | 'action:api.video.updated': true, |
5f189c9c | 86 | // Fired when a local video is deleted |
7663e55a | 87 | 'action:api.video.deleted': true, |
5f189c9c | 88 | // Fired when a local video is uploaded |
7663e55a | 89 | 'action:api.video.uploaded': true, |
5f189c9c | 90 | // Fired when a local video is viewed |
7663e55a C |
91 | 'action:api.video.viewed': true, |
92 | ||
3cabf353 C |
93 | // Fired when a live video is created |
94 | 'action:api.live-video.created': true, | |
95 | ||
5f189c9c | 96 | // Fired when a thread is created |
7663e55a | 97 | 'action:api.video-thread.created': true, |
5f189c9c | 98 | // Fired when a reply to a thread is created |
7663e55a | 99 | 'action:api.video-comment-reply.created': true, |
5f189c9c | 100 | // Fired when a comment (thread or reply) is deleted |
6f3fe96f C |
101 | 'action:api.video-comment.deleted': true, |
102 | ||
103 | // Fired when a user is blocked (banned) | |
104 | 'action:api.user.blocked': true, | |
105 | // Fired when a user is unblocked (unbanned) | |
106 | 'action:api.user.unblocked': true, | |
107 | // Fired when a user registered on the instance | |
108 | 'action:api.user.registered': true, | |
109 | // Fired when an admin/moderator created a user | |
110 | 'action:api.user.created': true, | |
111 | // Fired when a user is removed by an admin/moderator | |
112 | 'action:api.user.deleted': true, | |
113 | // Fired when a user is updated by an admin/moderator | |
114 | 'action:api.user.updated': true, | |
115 | ||
a1587156 | 116 | // Fired when a user got a new oauth2 token |
e2e0b645 | 117 | 'action:api.user.oauth2-got-token': true, |
118 | ||
119 | // Fired when a video is added to a playlist | |
120 | 'action:api.video-playlist-element.created': true | |
7663e55a | 121 | } |
b4055e1c | 122 | |
7663e55a | 123 | export type ServerActionHookName = keyof typeof serverActionHookObject |
b4055e1c | 124 | |
7663e55a C |
125 | export const serverHookObject = Object.assign({}, serverFilterHookObject, serverActionHookObject) |
126 | export type ServerHookName = keyof typeof serverHookObject | |
b4055e1c C |
127 | |
128 | export interface ServerHook { | |
93cae479 | 129 | runHook <T> (hookName: ServerHookName, result?: T, params?: any): Promise<T> |
b4055e1c | 130 | } |