diff options
author | lutangar <johan.dufour@gmail.com> | 2021-06-29 16:02:05 +0200 |
---|---|---|
committer | lutangar <johan.dufour@gmail.com> | 2021-07-16 17:49:40 +0200 |
commit | dc3d902234bb73fbc8cf9787e3036f2012526e6c (patch) | |
tree | 58ab2812fa5b38f4e19376f1a7cf3d718f3003fb /support/doc/plugins | |
parent | de15b052c59cbd4b99bca835b124485ca1af399e (diff) | |
download | PeerTube-dc3d902234bb73fbc8cf9787e3036f2012526e6c.tar.gz PeerTube-dc3d902234bb73fbc8cf9787e3036f2012526e6c.tar.zst PeerTube-dc3d902234bb73fbc8cf9787e3036f2012526e6c.zip |
Introduce generic video constant manager for plugins
Allow a plugin developer to get back constants values,
and reset constants deletions or additions.
Diffstat (limited to 'support/doc/plugins')
-rw-r--r-- | support/doc/plugins/guide.md | 28 |
1 files changed, 18 insertions, 10 deletions
diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md index 568c0662f..85aaf9f02 100644 --- a/support/doc/plugins/guide.md +++ b/support/doc/plugins/guide.md | |||
@@ -234,21 +234,29 @@ function register ({ | |||
234 | 234 | ||
235 | #### Update video constants | 235 | #### Update video constants |
236 | 236 | ||
237 | You can add/delete video categories, licences or languages using the appropriate managers: | 237 | You can add/delete video categories, licences or languages using the appropriate constant managers: |
238 | 238 | ||
239 | ```js | 239 | ```js |
240 | function register (...) { | 240 | function register ({ |
241 | videoLanguageManager.addLanguage('al_bhed', 'Al Bhed') | 241 | videoLanguageManager, |
242 | videoLanguageManager.deleteLanguage('fr') | 242 | videoCategoryManager, |
243 | videoLicenceManager, | ||
244 | videoPrivacyManager, | ||
245 | playlistPrivacyManager | ||
246 | }) { | ||
247 | videoLanguageManager.addConstant('al_bhed', 'Al Bhed') | ||
248 | videoLanguageManager.deleteConstant('fr') | ||
243 | 249 | ||
244 | videoCategoryManager.addCategory(42, 'Best category') | 250 | videoCategoryManager.addConstant(42, 'Best category') |
245 | videoCategoryManager.deleteCategory(1) // Music | 251 | videoCategoryManager.deleteConstant(1) // Music |
252 | videoCategoryManager.resetConstants() // Reset to initial categories | ||
253 | videoCategoryManager.getConstants() // Retrieve all category constants | ||
246 | 254 | ||
247 | videoLicenceManager.addLicence(42, 'Best licence') | 255 | videoLicenceManager.addConstant(42, 'Best licence') |
248 | videoLicenceManager.deleteLicence(7) // Public domain | 256 | videoLicenceManager.deleteConstant(7) // Public domain |
249 | 257 | ||
250 | videoPrivacyManager.deletePrivacy(2) // Remove Unlisted video privacy | 258 | videoPrivacyManager.deleteConstant(2) // Remove Unlisted video privacy |
251 | playlistPrivacyManager.deletePlaylistPrivacy(3) // Remove Private video playlist privacy | 259 | playlistPrivacyManager.deleteConstant(3) // Remove Private video playlist privacy |
252 | } | 260 | } |
253 | ``` | 261 | ``` |
254 | 262 | ||