blob: dc3bfaa7db163ef65bdb2c2601fe7ebc954747bd (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
# Backend API
Provides a set of helper functions to integrate the recipe into [Ferdi](https://getferdi.com).
## Ferdi Backend Class Methods
* [validateUrl](#user-content-validateurl)
* [overrideUserAgent](#user-content-overrideuseragent)
* [modifyRequestHeaders](#user-content-modifyrequestheaders)
## Events
* [webview events](#user-content-events)
### validateUrl(URL)
Validate if the given URL is a valid service instance.
#### Arguments
1. `string` URL
#### Returns
[`Promise`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise)
#### Usage
```js
// RocketChat integration
module.exports = Ferdi => class RocketChat extends Ferdi {
async validateUrl(url) {
try {
const resp = await window.fetch(`${url}/api/info`, {
method: 'GET',
headers: {
'Content-Type': 'application/json',
},
});
const data = await resp.json();
return Object.hasOwnProperty.call(data, 'version');
} catch (err) {
console.error(err);
}
return false;
}
};
```
### overrideUserAgent()
Override the user agent used inside the service webview.
#### Returns
`String`
#### Usage
```js
module.exports = Ferdi => class Discord extends Ferdi {
overrideUserAgent() {
// Remove Ferdi's signature from the user agent
return window.navigator.userAgent.replace(
/(Ferdi|Electron)\/\S+ \([^)]+\)/g,
""
);
}
};
```
```js
module.exports = Ferdi => class Example extends Ferdi {
overrideUserAgent() {
// Use a completely different user agent
return "Mozilla/2.02Gold (Win95; I)";
}
};
```
### modifyRequestHeaders()
Modify headers of HTTP requests sent from a recipe's webview
Any standard HTTP header can be added to the requests.
#### Returns
`Array` containing objects, each of which should have two properties.
- `headers` - Object containing the header params and their values in key-value format
- `requestFilters` - Array of URL patterns used to filter requests for which the headers need to be added.
Valid URL patterns can be referred from [here](https://www.electronjs.org/docs/api/web-request#webrequestonbeforerequestfilter-listener)
#### Usage
```js
// Hangouts Chat integration
module.exports = Ferdi => class HangoutsChat extends Ferdi {
modifyRequestHeaders() {
return [{
// Adding an origin header for all http requests from this recipe
headers: { 'origin': 'https://chat.google.com' },
requestFilters: {
urls: ['*://*/*']
}
}]
}
};
```
### Events
Ferdi recipes can hook into the [electron webview events](https://electron.atom.io/docs/api/webview-tag/#dom-events) to trigger custom functions.
This is necessary for services like TweetDeck where custom URL forwarding is needed during login.
#### Usage
```js
module.exports = Ferdi => class Tweetdeck extends Ferdi {
events = {
'did-get-redirect-request': '_redirectFix',
}
_redirectFix(event) {
if (event.newURL !== undefined && event.oldURL !== undefined && event.isMainFrame) {
if (event.isMainFrame) {
setTimeout(() => this.send('redirect-url', event.newURL), 100);
event.preventDefault();
}
}
}
};
```
|
