[libgweather/wip/hadess/app-id: 11/11] gweather: Add API doc for enabled-properties getter/setter
- From: Bastien Nocera <hadess src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgweather/wip/hadess/app-id: 11/11] gweather: Add API doc for enabled-properties getter/setter
- Date: Tue, 12 Jan 2021 11:29:45 +0000 (UTC)
commit ff0e76116588f737b5b0fd8fd2b3c3f71b24f801
Author: Bastien Nocera <hadess hadess net>
Date: Tue Jan 12 12:08:21 2021 +0100
gweather: Add API doc for enabled-properties getter/setter
libgweather/gweather-weather.c | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
---
diff --git a/libgweather/gweather-weather.c b/libgweather/gweather-weather.c
index 2d1d4937..31e07a37 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)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]