forked from raycast/extensions
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: update for the new API release
- Loading branch information
1 parent
5537d5e
commit 49e975f
Showing
7 changed files
with
96 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
{ | ||
"version": "1.46.1" | ||
"version": "1.47.0" | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Deeplinks | ||
|
||
Deeplinks are Raycast-specific URLs which you can use to launch any command, as long as it's installed an enabled in Raycast. | ||
|
||
They adhere the following format: | ||
|
||
``` | ||
raycast://extensions/<author-or-owner>/<extension-name>/<command-name> | ||
``` | ||
|
||
| Name | Description | Type | | ||
| :-------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | ||
| author-or-owner | For store extensions, it's the value of the `owner` or the `author` field in the extension's [manifest](../manifest.md). For built-in extensions (such as `Calendar`), this is always `raycast`. | `string` | | ||
| extension-name | For store extensions, it's the value of the extensions `name` field in the extension's [manifest](../manifest.md). For built-in extensions (such as `Calendar`), this is the "slugified" extension name; in this case `calendar`. | `string` | | ||
| command-name | For store extensions, it's the value of the command's `name` field in the extension's [manifest](../manifest.md). For built-in commands (such as `My Schedule`), this is the "slugified" command name; in this case `my-schedule`. | `string` | | ||
|
||
To make fetching a command's Deeplink easier, each command in the Raycast root now has a `Copy Deeplink` action. | ||
|
||
{% hint style="info" %} | ||
Whenever a command is launched using a Deeplink, Raycast will ask you to confirm that you want to run the command. This is to ensure that you are aware of the command you are running. | ||
{% endhint %} | ||
|
||
![](../../.gitbook/assets/deeplink-confirmation.png) | ||
|
||
## Query Parameters | ||
|
||
| Name | Description | Type | | ||
| :--------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | | ||
| launchType | Runs the command in the background, skipping bringing Raycast to the front. | Either `userInitiated` or `background` | | ||
| arguments | If the command acepts [arguments](./arguments.md), they can be passed using this query parameter. | URL-encoded JSON object. | | ||
| context | If the command make use of [LaunchContext](../../api-reference/utilities.md#launchcontext), it can be passed using this query parameter. | URL-encoded JSON object. | |