Docs: add edit link

This commit is contained in:
MM20 2024-02-10 01:53:41 +01:00
parent 4fe44dbd89
commit 6dce8ff61a
No known key found for this signature in database
GPG Key ID: 0B61A8F2DEAFA389
2 changed files with 4 additions and 1 deletions

View File

@ -28,6 +28,9 @@ export default defineConfig({
search: { search: {
provider: 'local', provider: 'local',
}, },
editLink: {
pattern: 'https://github.com/MM2-0/Kvaesitso/edit/main/docs/:path',
},
}, },
head: [['link', { rel: 'icon', href: '/icon.png' }]], head: [['link', { rel: 'icon', href: '/icon.png' }]],
}) })

View File

@ -9,7 +9,7 @@ suspend fun getPluginState(): PluginState
This method can either return <a href="/reference/plugins/sdk/de.mm20.launcher2.sdk/-plugin-state/-ready/index.html" target="_blank">`PluginState.Ready`</a>, or <a href="/reference/plugins/sdk/de.mm20.launcher2.sdk/-plugin-state/-setup-required/index.html" target="_blank">`PluginState.SetupRequired`</a>. This method can either return <a href="/reference/plugins/sdk/de.mm20.launcher2.sdk/-plugin-state/-ready/index.html" target="_blank">`PluginState.Ready`</a>, or <a href="/reference/plugins/sdk/de.mm20.launcher2.sdk/-plugin-state/-setup-required/index.html" target="_blank">`PluginState.SetupRequired`</a>.
- `PluginState.Ready` can have a status `text` to describe what the plugin does in its current configuration. For example _"Search {username}'s files on {service}_". This overrides the plugin's [description](/docs/developer-guide/plugins/metadata.html#description-1). - `PluginState.Ready` can have a status `text` to describe what the plugin does in its current configuration. For example _"Search {username}'s files on {service}_". This overrides the plugin's [description](/docs/developer-guide/plugins/metadata.html#description-1).
- `PluginState.SetupRequired` needs to a `setupActivity` Intent that starts the setup. You can also provide a `message` to describe what kind of setup needs to be performed. For example _"Sign in with {service} to search files on {service}"_ - `PluginState.SetupRequired` needs to have a `setupActivity` Intent that starts the setup. You can also provide a `message` to describe what kind of setup needs to be performed. For example _"Sign in with {service} to search files on {service}"_
> [!IMPORTANT] > [!IMPORTANT]
> This method is only meant to provide hints to the launcher's user interface. You should not rely on it as a safeguard for your other plugin methods. There is still a chance that your other plugin methods are called regardless of the return value of this method. Make sure to check your requirements in the other plugin methods as well. > This method is only meant to provide hints to the launcher's user interface. You should not rely on it as a safeguard for your other plugin methods. There is still a chance that your other plugin methods are called regardless of the return value of this method. Make sure to check your requirements in the other plugin methods as well.