]>
Commit | Line | Data |
---|---|---|
7663e55a | 1 | // Data from API hooks: {hookType}:api.{location}.{elementType}.{actionType}.{target} |
3d9a63d3 | 2 | // Data in internal functions: {hookType}:{location}.{elementType}.{actionType}.{target} |
93cae479 | 3 | |
7663e55a | 4 | export const clientFilterHookObject = { |
5f189c9c | 5 | // Filter params/result of the function that fetch videos of the trending page |
7663e55a C |
6 | 'filter:api.trending-videos.videos.list.params': true, |
7 | 'filter:api.trending-videos.videos.list.result': true, | |
93cae479 | 8 | |
c07eb946 JM |
9 | // Filter params/result of the function that fetch videos of the trending page |
10 | 'filter:api.most-liked-videos.videos.list.params': true, | |
11 | 'filter:api.most-liked-videos.videos.list.result': true, | |
12 | ||
5f189c9c | 13 | // Filter params/result of the function that fetch videos of the local page |
7663e55a C |
14 | 'filter:api.local-videos.videos.list.params': true, |
15 | 'filter:api.local-videos.videos.list.result': true, | |
93cae479 | 16 | |
5f189c9c | 17 | // Filter params/result of the function that fetch videos of the recently-added page |
7663e55a C |
18 | 'filter:api.recently-added-videos.videos.list.params': true, |
19 | 'filter:api.recently-added-videos.videos.list.result': true, | |
93cae479 | 20 | |
5f189c9c | 21 | // Filter params/result of the function that fetch videos of the user subscription page |
7663e55a C |
22 | 'filter:api.user-subscriptions-videos.videos.list.params': true, |
23 | 'filter:api.user-subscriptions-videos.videos.list.result': true, | |
93cae479 | 24 | |
5f189c9c | 25 | // Filter params/result of the function that fetch the video of the video-watch page |
7663e55a C |
26 | 'filter:api.video-watch.video.get.params': true, |
27 | 'filter:api.video-watch.video.get.result': true, | |
93cae479 | 28 | |
5f189c9c | 29 | // Filter params/result of the function that fetch the threads of the video-watch page |
7663e55a C |
30 | 'filter:api.video-watch.video-threads.list.params': true, |
31 | 'filter:api.video-watch.video-threads.list.result': true, | |
93cae479 | 32 | |
5f189c9c | 33 | // Filter params/result of the function that fetch the replies of a thread in the video-watch page |
7663e55a C |
34 | 'filter:api.video-watch.video-thread-replies.list.params': true, |
35 | 'filter:api.video-watch.video-thread-replies.list.result': true, | |
93cae479 | 36 | |
5f189c9c | 37 | // Filter params/result of the function that fetch videos according to the user search |
7663e55a C |
38 | 'filter:api.search.videos.list.params': true, |
39 | 'filter:api.search.videos.list.result': true, | |
5f189c9c | 40 | // Filter params/result of the function that fetch video-channels according to the user search |
7663e55a | 41 | 'filter:api.search.video-channels.list.params': true, |
ba7b7e57 RK |
42 | 'filter:api.search.video-channels.list.result': true, |
43 | ||
44 | // Filter form | |
3d9a63d3 C |
45 | 'filter:api.signup.registration.create.params': true, |
46 | ||
47 | // Filter the options to create our player | |
c2023a9f C |
48 | 'filter:internal.video-watch.player.build-options.params': true, |
49 | 'filter:internal.video-watch.player.build-options.result': true, | |
50 | ||
51 | // Filter our SVG icons content | |
52 | 'filter:internal.common.svg-icons.get-content.params': true, | |
8beea2d3 C |
53 | 'filter:internal.common.svg-icons.get-content.result': true, |
54 | ||
55 | // Filter left menu links | |
72f611ca | 56 | 'filter:left-menu.links.create.result': true, |
57 | ||
58 | // Filter videojs options built for PeerTube player | |
59 | 'filter:internal.player.videojs.options.result': true | |
7663e55a C |
60 | } |
61 | ||
62 | export type ClientFilterHookName = keyof typeof clientFilterHookObject | |
63 | ||
64 | export const clientActionHookObject = { | |
5f189c9c | 65 | // Fired when the application is being initialized |
7663e55a | 66 | 'action:application.init': true, |
93cae479 | 67 | |
5f189c9c | 68 | // Fired when the video watch page is being initialized |
7663e55a | 69 | 'action:video-watch.init': true, |
5f189c9c | 70 | // Fired when the video watch page loaded the video |
7663e55a | 71 | 'action:video-watch.video.loaded': true, |
5f85f8aa RK |
72 | // Fired when the player finished loading |
73 | 'action:video-watch.player.loaded': true, | |
0840ca76 C |
74 | // Fired when the video watch page comments(threads) are loaded and load more comments on scroll |
75 | 'action:video-watch.video-threads.loaded': true, | |
cf387740 B |
76 | // Fired when a user click on 'View x replies' and they're loaded |
77 | 'action:video-watch.video-thread-replies.loaded': true, | |
7663e55a | 78 | |
7294aab0 C |
79 | // Fired when the video edit page (upload, URL/torrent import, update) is being initialized |
80 | 'action:video-edit.init': true, | |
81 | ||
f375bb3d C |
82 | // Fired when the login page is being initialized |
83 | 'action:login.init': true, | |
84 | ||
5f189c9c | 85 | // Fired when the search page is being initialized |
23bdacf8 C |
86 | 'action:search.init': true, |
87 | ||
88 | // Fired every time Angular URL changes | |
ba7b7e57 RK |
89 | 'action:router.navigation-end': true, |
90 | ||
91 | // Fired when the registration page is being initialized | |
f9562863 C |
92 | 'action:signup.register.init': true, |
93 | ||
0ea9f463 C |
94 | // PeerTube >= 3.2 |
95 | // Fired when the admin plugin settings page is being initialized | |
96 | 'action:admin-plugin-settings.init': true, | |
97 | ||
2e257e36 C |
98 | // Fired when the video upload page is being initalized |
99 | 'action:video-upload.init': true, | |
100 | // Fired when the video import by URL page is being initalized | |
101 | 'action:video-url-import.init': true, | |
102 | // Fired when the video import by torrent/magnet URI page is being initalized | |
103 | 'action:video-torrent-import.init': true, | |
104 | // Fired when the "Go Live" page is being initalized | |
105 | 'action:go-live.init': true, | |
106 | ||
faeec106 C |
107 | // Fired when the user explicitely logged in/logged out |
108 | 'action:auth-user.logged-in': true, | |
109 | 'action:auth-user.logged-out': true, | |
110 | // Fired when the application loaded user information (using tokens from the local storage or after a successful login) | |
111 | 'action:auth-user.information-loaded': true, | |
112 | ||
4bc45da3 C |
113 | // Fired when the modal to download a video/caption is shown |
114 | 'action:modal.video-download.shown': true, | |
115 | ||
f9562863 | 116 | // ####### Embed hooks ####### |
4bc45da3 C |
117 | // /!\ In embed scope, peertube helpers are not available |
118 | // ########################### | |
f9562863 C |
119 | |
120 | // Fired when the embed loaded the player | |
121 | 'action:embed.player.loaded': true | |
7663e55a | 122 | } |
93cae479 | 123 | |
7663e55a | 124 | export type ClientActionHookName = keyof typeof clientActionHookObject |
93cae479 | 125 | |
7663e55a C |
126 | export const clientHookObject = Object.assign({}, clientFilterHookObject, clientActionHookObject) |
127 | export type ClientHookName = keyof typeof clientHookObject | |
93cae479 C |
128 | |
129 | export interface ClientHook { | |
130 | runHook <T> (hookName: ClientHookName, result?: T, params?: any): Promise<T> | |
131 | } |