summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBastien Nocera <hadess@hadess.net>2021-01-12 12:08:21 +0100
committerBastien Nocera <hadess@hadess.net>2021-01-12 15:11:55 +0100
commit4579ac3f0a85d6e07f8cd808a73eedf7fcdd2b77 (patch)
tree34ce9ee9d2bdf53cea69e7c9aa767fb54b343dbc
parenta4722d9c3bac334b00166c8fcb3deaf8338ec77b (diff)
downloadlibgweather-4579ac3f0a85d6e07f8cd808a73eedf7fcdd2b77.tar.gz
gweather: Add API doc for enabled-properties getter/setter
-rw-r--r--libgweather/gweather-weather.c19
1 files changed, 19 insertions, 0 deletions
diff --git a/libgweather/gweather-weather.c b/libgweather/gweather-weather.c
index 348ec6b..b30bf36 100644
--- a/libgweather/gweather-weather.c
+++ b/libgweather/gweather-weather.c
@@ -2138,6 +2138,13 @@ gweather_info_set_location (GWeatherInfo *info,
gweather_info_reset (info);
}
+/**
+ * gweather_info_get_enabled_providers:
+ * @info: a #GWeatherInfo
+ *
+ * Gets the bitmask of enabled #GWeatherProvider weather
+ * providers.
+ */
GWeatherProvider
gweather_info_get_enabled_providers (GWeatherInfo *info)
{
@@ -2147,6 +2154,18 @@ gweather_info_get_enabled_providers (GWeatherInfo *info)
return info->providers;
}
+/**
+ * gweather_info_set_enabled_providers:
+ * @info: a #GWeatherInfo
+ * @providers: a bitmask of #GWeatherProvider
+ *
+ * Sets the enabled providers for fetching the weather. Note
+ * that it is up to the application developer to make sure that
+ * the terms of use for each service are respected.
+ *
+ * Online providers will not be enabled if the application ID is
+ * not set to a valid value.
+ */
void
gweather_info_set_enabled_providers (GWeatherInfo *info,
GWeatherProvider providers)