[libgweather/wip/hadess/app-id: 8/10] 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: 8/10] gweather: Add API doc for enabled-properties getter/setter
- Date: Tue, 12 Jan 2021 14:12:26 +0000 (UTC)
commit 4579ac3f0a85d6e07f8cd808a73eedf7fcdd2b77
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 348ec6b9..b30bf36f 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)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]