jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-08 18:06:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

async_get_url -> get_url (#500)

Browse Source
This commit is contained in:
Franck Nijhof 2020-05-08 21:53:40 +02:00 committed by GitHub
parent 51f7e393e8
commit 0c282a05b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/instance_url.md
View File

@ -24,13 +24,13 @@ Luckily, Home Assistant provides a helper method to ease that a bit.
## The URL helper ## The URL helper
Home Assistant provides a network helper method to get the instance URL, Home Assistant provides a network helper method to get the instance URL,
that matches the requirements the integration needs, called `async_get_url`. that matches the requirements the integration needs, called `get_url`.
The signature of the helper method: The signature of the helper method:
```py ```py
# homeassistant.helpers.network.async_get_url # homeassistant.helpers.network.get_url
def async_get_url( def get_url(
hass: HomeAssistant, hass: HomeAssistant,
*, *,
require_ssl: bool = False, require_ssl: bool = False,
@ -82,7 +82,7 @@ The different parameters of the method:
## Default behavior ## Default behavior
By default, without passing additional parameters (`async_get_url(hass)`), By default, without passing additional parameters (`get_url(hass)`),
it will try to: it will try to:
- Get an internal URL set by the user, or if not available, try to detect one - Get an internal URL set by the user, or if not available, try to detect one
@ -100,9 +100,9 @@ without requirements.
The most basic example of using the helper: The most basic example of using the helper:
```py ```py
from homeassistant.helpers.network import async_get_url from homeassistant.helpers.network import get_url
instance_url = async_get_url(hass) instance_url = get_url(hass)
``` ```
This example call to the helper method would return an internal URL, preferably, This example call to the helper method would return an internal URL, preferably,
@ -117,7 +117,7 @@ an exception will be raised: `NoURLAvailableError`.
from homeassistant.helpers import network from homeassistant.helpers import network
try: try:
external_url = network.async_get_url( external_url = network.get_url(
hass, hass,
allow_internal=False, allow_internal=False,
allow_ip=False, allow_ip=False,