diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/backend_api.md | 48 |
1 files changed, 44 insertions, 4 deletions
diff --git a/docs/backend_api.md b/docs/backend_api.md index dd7d760..e4f07df 100644 --- a/docs/backend_api.md +++ b/docs/backend_api.md | |||
@@ -4,13 +4,14 @@ Provides a set of helper functions to integrate the recipe into [Ferdi](https:// | |||
4 | 4 | ||
5 | ## Ferdi Backend Class Methods | 5 | ## Ferdi Backend Class Methods |
6 | 6 | ||
7 | * [validateUrl](#user-content-validateurl) | 7 | * [validateUrl](#validateurl) |
8 | * [overrideUserAgent](#user-content-overrideuseragent) | 8 | * [overrideUserAgent](#overrideuseragent) |
9 | * [modifyRequestHeaders](#user-content-modifyrequestheaders) | 9 | * [modifyRequestHeaders](#modifyrequestheaders) |
10 | * [knownCertificateHosts](#knownCertificateHosts) | ||
10 | 11 | ||
11 | ## Events | 12 | ## Events |
12 | 13 | ||
13 | * [webview events](#user-content-events) | 14 | * [webview events](#events) |
14 | 15 | ||
15 | ### validateUrl(URL) | 16 | ### validateUrl(URL) |
16 | 17 | ||
@@ -110,6 +111,45 @@ module.exports = Ferdi => class HangoutsChat extends Ferdi { | |||
110 | }; | 111 | }; |
111 | ``` | 112 | ``` |
112 | 113 | ||
114 | ### knownCertificateHosts() | ||
115 | |||
116 | Specify an array of known hosts from where certificates can be issued for this service | ||
117 | |||
118 | #### Returns | ||
119 | |||
120 | `Array` containing hostnames from where certificates can be issued | ||
121 | |||
122 | #### Usage | ||
123 | |||
124 | ```js | ||
125 | // msteams Chat integration | ||
126 | module.exports = Ferdi => class MicrosoftTeams extends Ferdi { | ||
127 | knownCertificateHosts() { | ||
128 | return [ | ||
129 | 'aka.ms', | ||
130 | 'aspnetcdn.com', | ||
131 | 'azure.net', | ||
132 | 'azureedge.net', | ||
133 | 'live.com', | ||
134 | 'microsoft.com', | ||
135 | 'microsoftonline.com', | ||
136 | 'msecnd.net', | ||
137 | 'msedge.net', | ||
138 | 'mstea.ms', | ||
139 | 'office.net', | ||
140 | 'okta.com', | ||
141 | 'sfbassets.com', | ||
142 | 'skype.com', | ||
143 | 'skypeassets.com', | ||
144 | 'skypeforbusiness.com', | ||
145 | 'tenor.com', | ||
146 | 'windows.com', | ||
147 | 'windows.net', | ||
148 | ]; | ||
149 | }; | ||
150 | }; | ||
151 | ``` | ||
152 | |||
113 | ### Events | 153 | ### Events |
114 | 154 | ||
115 | Ferdi recipes can hook into the [electron webview events](https://electron.atom.io/docs/api/webview-tag/#dom-events) to trigger custom functions. | 155 | Ferdi recipes can hook into the [electron webview events](https://electron.atom.io/docs/api/webview-tag/#dom-events) to trigger custom functions. |