diff options
author | 2023-09-11 08:26:05 +0530 | |
---|---|---|
committer | 2023-09-11 02:59:47 +0000 | |
commit | 446cc2d05ee3a5ca66eabd1e109ba23778d8838c (patch) | |
tree | 7a6346efd41e4f37791c7615deae27de44939165 /docs/configuration.md | |
parent | Update icons (#419) (diff) | |
download | ferdium-recipes-446cc2d05ee3a5ca66eabd1e109ba23778d8838c.tar.gz ferdium-recipes-446cc2d05ee3a5ca66eabd1e109ba23778d8838c.tar.zst ferdium-recipes-446cc2d05ee3a5ca66eabd1e109ba23778d8838c.zip |
Remove references to hipchat
Diffstat (limited to 'docs/configuration.md')
-rw-r--r-- | docs/configuration.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/configuration.md b/docs/configuration.md index 8dff91b..081b7ad 100644 --- a/docs/configuration.md +++ b/docs/configuration.md | |||
@@ -38,7 +38,7 @@ This is the Ferdium-specific integration config. | |||
38 | * `string` **serviceURL**<br/> | 38 | * `string` **serviceURL**<br/> |
39 | Defines the URL that should be loaded into the Ferdium webview. | 39 | Defines the URL that should be loaded into the Ferdium webview. |
40 | <br /><br /> | 40 | <br /><br /> |
41 | If you want to load a simple URL like `https://www.messenger.com`, you can simply define it via the `serviceURL` parameter. If your service URL is team based, e.g. Slack or HipChat you can use `https://{teamId}.slack.com`. | 41 | If you want to load a simple URL like `https://www.messenger.com`, you can simply define it via the `serviceURL` parameter. If your service URL is team based, e.g. Slack you can use `https://{teamId}.slack.com`. |
42 | <br /><br /> | 42 | <br /><br /> |
43 | If your service works with custom URLs, just leave this empty. | 43 | If your service works with custom URLs, just leave this empty. |
44 | <br /><br /> | 44 | <br /><br /> |
@@ -61,19 +61,19 @@ If your service works with custom URLs, just leave this empty. | |||
61 | * `boolean` **hasTeamId** _default: false_<br /> | 61 | * `boolean` **hasTeamId** _default: false_<br /> |
62 | Is this a team based service? If true, the interface to add the service will require a team identifier. e.g. `[teamId]`.slack.com | 62 | Is this a team based service? If true, the interface to add the service will require a team identifier. e.g. `[teamId]`.slack.com |
63 | * `string` **urlInputPrefix**<br /> | 63 | * `string` **urlInputPrefix**<br /> |
64 | This option is only used in combination with `hasTeamId: true` in order to display the value of `urlInputPrefix` before the input for TeamId to make it obvious to the user what input is required from them. Eg. _<TeamID>.hipchat.com_ | 64 | This option is only used in combination with `hasTeamId: true` in order to display the value of `urlInputPrefix` before the input for TeamId to make it obvious to the user what input is required from them. Eg. _<TeamID>.slack.com_ |
65 | * `string` **urlInputSuffix**<br /> | 65 | * `string` **urlInputSuffix**<br /> |
66 | This option is only used in combination with `hasTeamId: true` in order to display the value of `urlInputSuffix` after the input for TeamId to make it obvious to the user what input is required from them. Eg. _<TeamID>.hipchat.com_ | 66 | This option is only used in combination with `hasTeamId: true` in order to display the value of `urlInputSuffix` after the input for TeamId to make it obvious to the user what input is required from them. Eg. _<TeamID>.slack.com_ |
67 | * `boolean` **hasHostedOption** _default: false_<br /> | 67 | * `boolean` **hasHostedOption** _default: false_<br /> |
68 | If a service can be hosted and has a teamId or customUrl | 68 | If a service can be hosted and has a teamId or customUrl |
69 | * `boolean` **hasCustomUrl** _default: false_<br /> | 69 | * `boolean` **hasCustomUrl** _default: false_<br /> |
70 | On-premise services like HipChat, Mattermost, ... require a custom URL. This option enables the user to enter a custom URL when adding the service. | 70 | On-premise services like Mattermost, ... require a custom URL. This option enables the user to enter a custom URL when adding the service. |
71 | * `boolean` **hasNotificationSound** _default: false_<br /> | 71 | * `boolean` **hasNotificationSound** _default: false_<br /> |
72 | Some services provide their own notification sound. In order to avoid multiple sounds when the user receives a message set this to `true`. If the service has no built in notification sound set this to `false`. | 72 | Some services provide their own notification sound. In order to avoid multiple sounds when the user receives a message set this to `true`. If the service has no built in notification sound set this to `false`. |
73 | * `boolean` **hasDirectMessages** _default: true_<br /> | 73 | * `boolean` **hasDirectMessages** _default: true_<br /> |
74 | Some services have direct 1x1 messages e.g. a mention or message to every user in a channel (@channel). If this flag is set to `true`, the user can enable/disable if there should be a badge for direct messages. | 74 | Some services have direct 1x1 messages e.g. a mention or message to every user in a channel (@channel). If this flag is set to `true`, the user can enable/disable if there should be a badge for direct messages. |
75 | * `boolean` **hasIndirectMessages** _default: false_<br /> | 75 | * `boolean` **hasIndirectMessages** _default: false_<br /> |
76 | Services like Slack or HipChat have direct messages e.g. a mention or message to every user in a channel (@channel) and indirect messages e.g. general discussion in a channel. If this flag is set to `true`, the user can enable/disable if there should be a badge for indirect messages. | 76 | Services like Slack have direct messages e.g. a mention or message to every user in a channel (@channel) and indirect messages e.g. general discussion in a channel. If this flag is set to `true`, the user can enable/disable if there should be a badge for indirect messages. |
77 | * `string` **message**<br /> | 77 | * `string` **message**<br /> |
78 | Info message that will be displayed in the add/edit service preferences screen. | 78 | Info message that will be displayed in the add/edit service preferences screen. |
79 | * `boolean` **disablewebsecurity** _default: false_<br /> | 79 | * `boolean` **disablewebsecurity** _default: false_<br /> |