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 13:29:59 +0100
commit8357d09f713855c47c03715875831bdec4a0d094 (patch)
treea430f3c01a24d32197881c08c9126226a33d2712
parentd19138a8869de2e3f56ba33f967612ebb845757b (diff)
downloadlibgweather-wip/hadess/app-id.tar.gz
gweather: Add API doc for enabled-properties getter/setterwip/hadess/app-id
-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 2d1d493..31e07a3 100644
--- a/libgweather/gweather-weather.c
+++ b/libgweather/gweather-weather.c
@@ -2137,6 +2137,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)
{
@@ -2146,6 +2153,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)