Delineate platform support of various deeplink types #1159
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
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -5,11 +5,51 @@ id: 'url-handler' | |||||
|
|
||||||
| Home Assistant supports opening from other apps via URL. | ||||||
|
|
||||||
| ## Platform Compatibility | ||||||
|
|
||||||
| Platform support of different types of deeplinks will vary, consult the table below to see which deeplink types are available for your platform. | ||||||
|
|
||||||
| <table className="core-table"> | ||||||
| <thead> | ||||||
| <tr> | ||||||
| <th><strong>Deep Link Type</strong></th> | ||||||
|
There was a problem hiding this comment. Consistency with your previous paragraph and use sentence case
Suggested change
|
||||||
| <th><img alt="Android" src="/assets/android.svg" /> Full</th> | ||||||
| <th><img alt="Android" src="/assets/android.svg" /> Minimal</th> | ||||||
| <th><img alt="iOS" src="/assets/iOS.svg" /></th> | ||||||
| <th><img alt="macOS" src="/assets/macOS.svg" /></th> | ||||||
| </tr> | ||||||
| </thead> | ||||||
| <tbody> | ||||||
| <tr> | ||||||
| <td>Navigate</td> | ||||||
| <td>✅</td> | ||||||
| <td>✅</td> | ||||||
| <td>✅</td> | ||||||
| <td>✅</td> | ||||||
| </tr> | ||||||
| <tr> | ||||||
| <td>Call Service</td> | ||||||
|
There was a problem hiding this comment. Use sentence case
Suggested change
|
||||||
| <td></td> | ||||||
| <td></td> | ||||||
| <td>✅</td> | ||||||
| <td>✅</td> | ||||||
| </tr> | ||||||
| <tr> | ||||||
| <td>Fire Event</td> | ||||||
|
There was a problem hiding this comment. Use sentence case
Suggested change
|
||||||
| <td></td> | ||||||
| <td></td> | ||||||
| <td>✅</td> | ||||||
| <td>✅</td> | ||||||
| </tr> | ||||||
| <tr> | ||||||
| <td>Send Location</td> | ||||||
|
There was a problem hiding this comment. Use sentence case and match heading
Suggested change
There was a problem hiding this comment. do you have a preference of "Send one shot location" over "Send location"? I prefer the latter, I think because "one shot" is a bit redundant and maybe a little metaphorical, but happy to adopt whichever you prefer. |
||||||
| <td></td> | ||||||
| <td></td> | ||||||
| <td>✅</td> | ||||||
| <td>✅</td> | ||||||
| </tr> | ||||||
| </tbody> | ||||||
| </table> | ||||||
|
|
||||||
| ## Navigate | ||||||
| This allows you to update the frontend page location via a deeplink. To build a deeplink, follow these steps: | ||||||
|
|
@@ -18,22 +58,32 @@ This allows you to update the frontend page location via a deeplink. To build a | |||||
| 2. Copy the path portion of the URL, in this example that would be `/dashboard-mobile/my-subview` | ||||||
| 3. Craft your URL by starting with `homeassistant://navigate` and adding the path, e.g. `homeassistant://navigate/dashboard-mobile/my-subview` | ||||||
|
|
||||||
jpelgrom marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| :::info | ||||||
|  **Specifying which server to navigate to is currently only supported in iOS**<br /> | ||||||
| By default the App will ask which server you want to navigate to in case you have multiple servers. | ||||||
| To define which server you want to navigate to, use the query param `?server=` like the example below:<br /><br /> | ||||||
| `homeassistant://navigate/webcams?server=My%20home` when your server name is `My Home`, or use `?server=default` if you want to navigate to the first server available. | ||||||
| ::: | ||||||
|
|
||||||
| ## Call service | ||||||
| Example: `homeassistant://call_service/device_tracker.see?entity_id=device_tracker.entity` | ||||||
|
|
||||||
| Query parameters are passed as a dictionary in the call. | ||||||
|
|
||||||
| :::info | ||||||
| If multiple servers are connected to an app, `call_service` links will be handled using the first server in the list. | ||||||
| ::: | ||||||
|
|
||||||
| ## Fire event | ||||||
| You can create an [event trigger](https://www.home-assistant.io/docs/automation/trigger/#event-trigger) and fire the event. | ||||||
|
|
||||||
| Example: `homeassistant://fire_event/custom_event?entity_id=MY_CUSTOM_EVENT` | ||||||
|
|
||||||
| Query parameters are passed as a dictionary in the call. | ||||||
|
|
||||||
| :::info | ||||||
| If multiple servers are connected to an app, `fire_event` links will be handled using the first server in the list. | ||||||
| ::: | ||||||
|
|
||||||
| ## Send one shot location | ||||||
|
There was a problem hiding this comment. I'm curious what the use case for this is. Is it for if you don't share your location by default but want to once to trigger automations etc? Or to force a precise GPS location update? Maybe both are valid usages? |
||||||
| Example: `homeassistant://send_location/` | ||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use sentence case - the current page may not always match the standards but let's try to keep them in mind for new documentation.