X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fplugins%2Fguide.md;h=a90f8e72b2e35c96a1aae4fee4cc4e6b28be17d5;hb=096231d00e766c5d45e8975f4cec21c41a50ec2e;hp=36ade117bb5a9b0c444b6897735dfae57ecd0f7e;hpb=302eba0d898e38dca14739486441c27c0be6c62f;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md index 36ade117b..a90f8e72b 100644 --- a/support/doc/plugins/guide.md +++ b/support/doc/plugins/guide.md @@ -20,6 +20,7 @@ - [Plugin static route](#plugin-static-route) - [Notifier](#notifier) - [Markdown Renderer](#markdown-renderer) + - [Auth header](#auth-header) - [Custom Modal](#custom-modal) - [Translate](#translate) - [Get public settings](#get-public-settings) @@ -203,7 +204,7 @@ function register ({ } ``` -You can also store files in the plugin data directory (`/{plugins-directory}/data/{npm-plugin-name}`). +You can also store files in the plugin data directory (`/{plugins-directory}/data/{npm-plugin-name}`) **in PeerTube >= 3.2**. This directory and its content won't be deleted when your plugin is uninstalled/upgraded. ```js @@ -526,6 +527,30 @@ function register (...) { } ``` +#### Auth header + +**PeerTube >= 3.2** + +To make your own HTTP requests using the current authenticated user, use an helper to automatically set appropriate headers: + +```js +function register (...) { + registerHook({ + target: 'action:auth-user.information-loaded', + handler: ({ user }) => { + + // Useless because we have the same info in the ({ user }) parameter + // It's just an example + fetch('/api/v1/users/me', { + method: 'GET', + headers: peertubeHelpers.getAuthHeader() + }).then(res => res.json()) + .then(data => console.log('Hi %s.', data.username)) + } + }) +} +``` + #### Custom Modal To show a custom modal: