aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--client/src/app/core/plugins/plugin.service.ts5
-rw-r--r--client/src/types/register-client-option.model.ts3
-rw-r--r--support/doc/plugins/guide.md12
3 files changed, 18 insertions, 2 deletions
diff --git a/client/src/app/core/plugins/plugin.service.ts b/client/src/app/core/plugins/plugin.service.ts
index da5114048..b9d55a7e4 100644
--- a/client/src/app/core/plugins/plugin.service.ts
+++ b/client/src/app/core/plugins/plugin.service.ts
@@ -12,7 +12,7 @@ import { ClientHook, ClientHookName, clientHookObject } from '@shared/models/plu
12import { PluginClientScope } from '@shared/models/plugins/plugin-client-scope.type' 12import { PluginClientScope } from '@shared/models/plugins/plugin-client-scope.type'
13import { RegisterClientHookOptions } from '@shared/models/plugins/register-client-hook.model' 13import { RegisterClientHookOptions } from '@shared/models/plugins/register-client-hook.model'
14import { HttpClient } from '@angular/common/http' 14import { HttpClient } from '@angular/common/http'
15import { AuthService } from '@app/core/auth' 15import { AuthService, Notifier } from '@app/core'
16import { RestExtractor } from '@app/shared/rest' 16import { RestExtractor } from '@app/shared/rest'
17import { PluginType } from '@shared/models/plugins/plugin.type' 17import { PluginType } from '@shared/models/plugins/plugin.type'
18import { PublicServerSetting } from '@shared/models/plugins/public-server.setting' 18import { PublicServerSetting } from '@shared/models/plugins/public-server.setting'
@@ -60,6 +60,7 @@ export class PluginService implements ClientHook {
60 constructor ( 60 constructor (
61 private router: Router, 61 private router: Router,
62 private authService: AuthService, 62 private authService: AuthService,
63 private notifier: Notifier,
63 private server: ServerService, 64 private server: ServerService,
64 private zone: NgZone, 65 private zone: NgZone,
65 private authHttp: HttpClient, 66 private authHttp: HttpClient,
@@ -272,6 +273,8 @@ export class PluginService implements ClientHook {
272 return this.authService.isLoggedIn() 273 return this.authService.isLoggedIn()
273 }, 274 },
274 275
276 notifier: this.notifier,
277
275 translate: (value: string) => { 278 translate: (value: string) => {
276 return this.translationsObservable 279 return this.translationsObservable
277 .pipe(map(allTranslations => allTranslations[npmName])) 280 .pipe(map(allTranslations => allTranslations[npmName]))
diff --git a/client/src/types/register-client-option.model.ts b/client/src/types/register-client-option.model.ts
index 638b08653..1faf13c42 100644
--- a/client/src/types/register-client-option.model.ts
+++ b/client/src/types/register-client-option.model.ts
@@ -1,4 +1,5 @@
1import { RegisterClientHookOptions } from '@shared/models/plugins/register-client-hook.model' 1import { RegisterClientHookOptions } from '@shared/models/plugins/register-client-hook.model'
2import { Notifier } from '@app/core'
2 3
3export type RegisterClientOptions = { 4export type RegisterClientOptions = {
4 registerHook: (options: RegisterClientHookOptions) => void 5 registerHook: (options: RegisterClientHookOptions) => void
@@ -13,5 +14,7 @@ export type RegisterClientHelpers = {
13 14
14 getSettings: () => Promise<{ [ name: string ]: string }> 15 getSettings: () => Promise<{ [ name: string ]: string }>
15 16
17 notifier: Notifier
18
16 translate: (toTranslate: string) => Promise<string> 19 translate: (toTranslate: string) => Promise<string>
17} 20}
diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md
index bdc9d2ad8..5251ce48a 100644
--- a/support/doc/plugins/guide.md
+++ b/support/doc/plugins/guide.md
@@ -197,7 +197,7 @@ The `ping` route can be accessed using:
197 197
198### Client helpers (themes & plugins) 198### Client helpers (themes & plugins)
199 199
200### Plugin static route 200#### Plugin static route
201 201
202To get your plugin static route: 202To get your plugin static route:
203 203
@@ -206,6 +206,16 @@ const baseStaticUrl = peertubeHelpers.getBaseStaticRoute()
206const imageUrl = baseStaticUrl + '/images/chocobo.png' 206const imageUrl = baseStaticUrl + '/images/chocobo.png'
207``` 207```
208 208
209#### Notifier
210
211To notify the user with the PeerTube ToastModule:
212
213```js
214const { notifier } = peertubeHelpers
215notifier.success('Success message content.')
216notifier.error('Error message content.')
217```
218
209#### Translate 219#### Translate
210 220
211You can translate some strings of your plugin (PeerTube will use your `translations` object of your `package.json` file): 221You can translate some strings of your plugin (PeerTube will use your `translations` object of your `package.json` file):