colin/ModemManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs,libmm-glib: provide per-version indices

Browse Source
This commit is contained in:
Aleksander Morgado
2019-10-24 22:58:42 +02:00
parent 53a7dc2f63
commit 08d23dd64d
45 changed files with 3268 additions and 1317 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/reference/libmm-glib/libmm-glib-docs.xml
View File

@@ -250,16 +250,42 @@
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
</chapter>
<chapter id="api-index-full">
<title>Index</title>
<xi:include href="xml/api-index-full.xml"></xi:include>
</chapter>
<chapter id="deprecated-api-index" role="deprecated">
<title>Index of deprecated symbols</title>
<xi:include href="xml/api-index-deprecated.xml"></xi:include>
</chapter>
<chapter id="api-index-1-0" role="1.0">
<title>Index of new symbols in 1.0</title>
<xi:include href="xml/api-index-1.0.xml"></xi:include>
</chapter>
<chapter id="api-index-1-2" role="1.2">
<title>Index of new symbols in 1.2</title>
<xi:include href="xml/api-index-1.2.xml"></xi:include>
</chapter>
<chapter id="api-index-1-4" role="1.4">
<title>Index of new symbols in 1.4</title>
<xi:include href="xml/api-index-1.4.xml"></xi:include>
</chapter>
<chapter id="api-index-1-6" role="1.6">
<title>Index of new symbols in 1.6</title>
<xi:include href="xml/api-index-1.6.xml"></xi:include>
</chapter>
<chapter id="api-index-1-8" role="1.8">
<title>Index of new symbols in 1.8</title>
<xi:include href="xml/api-index-1.8.xml"></xi:include>
</chapter>
<chapter id="api-index-1-10" role="1.10">
<title>Index of new symbols in 1.10</title>
<xi:include href="xml/api-index-1.10.xml"></xi:include>
</chapter>
<chapter id="api-index-1-12" role="1.12">
<title>Index of new symbols in 1.12</title>
<xi:include href="xml/api-index-1.12.xml"></xi:include>
</chapter>
<index>
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<index id="deprecated-api-index" role="deprecated">
<title>Index of deprecated API</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
<xi:include href="xml/annotation-glossary.xml"></xi:include>
</book>

29
libmm-glib/mm-bearer-ip-config.c
View File

@@ -60,6 +60,8 @@ struct _MMBearerIpConfigPrivate {
* Gets the IP method to be used with this bearer.
*
* Returns: a #MMBearerIpMethod.
*
* Since: 1.0
*/
MMBearerIpMethod
mm_bearer_ip_config_get_method (MMBearerIpConfig *self)
@@ -86,7 +88,10 @@ mm_bearer_ip_config_set_method (MMBearerIpConfig *self,
*
* Gets the IP address to be used with this bearer.
*
* Returns: a string with the IP address, or #NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: a string with the IP address, or #NULL if unknown. Do not free the
* returned value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_bearer_ip_config_get_address (MMBearerIpConfig *self)
@@ -115,6 +120,8 @@ mm_bearer_ip_config_set_address (MMBearerIpConfig *self,
* Gets the network prefix to be used with this bearer.
*
* Returns: the network prefix.
*
* Since: 1.0
*/
guint
mm_bearer_ip_config_get_prefix (MMBearerIpConfig *self)
@@ -141,7 +148,10 @@ mm_bearer_ip_config_set_prefix (MMBearerIpConfig *self,
*
* Gets the list of IP addresses of DNS servers to be used with this bearer.
*
* Returns: (transfer none) (array zero-terminated=1): a NULL-terminated array of strings. Do not free the returned value, it is owned by @self.
* Returns: (transfer none) (array zero-terminated=1): a %NULL-terminated array
* of strings. Do not free the returned value, it is owned by @self.
*
* Since: 1.0
*/
const gchar **
mm_bearer_ip_config_get_dns (MMBearerIpConfig *self)
@@ -169,7 +179,10 @@ mm_bearer_ip_config_set_dns (MMBearerIpConfig *self,
*
* Gets the IP address of the gateway to be used with this bearer.
*
* Returns: a string with the IP address, or #NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: a string with the IP address, or #NULL if unknown. Do not free the
* returned value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_bearer_ip_config_get_gateway (MMBearerIpConfig *self)
@@ -198,6 +211,8 @@ mm_bearer_ip_config_set_gateway (MMBearerIpConfig *self,
* Gets the MTU to be used with this bearer.
*
* Returns: the MTU.
*
* Since: 1.4
*/
guint
mm_bearer_ip_config_get_mtu (MMBearerIpConfig *self)
@@ -367,14 +382,6 @@ mm_bearer_ip_config_new_from_dictionary (GVariant *dictionary,
/*****************************************************************************/
/**
* mm_bearer_ip_config_dup:
* @orig: a #MMBearerIpConfig
*
* Creates a copy of @orig.
*
* Returns: (transfer full): a newly created #MMBearerIpConfig
*/
MMBearerIpConfig *
mm_bearer_ip_config_dup (MMBearerIpConfig *orig)
{

59
libmm-glib/mm-bearer-properties.c
View File

@@ -70,6 +70,8 @@ struct _MMBearerPropertiesPrivate {
* @apn: Name of the access point.
*
* Sets the name of the access point to use when connecting.
*
* Since: 1.0
*/
void
mm_bearer_properties_set_apn (MMBearerProperties *self,
@@ -87,7 +89,10 @@ mm_bearer_properties_set_apn (MMBearerProperties *self,
*
* Gets the name of the access point to use when connecting.
*
* Returns: (transfer none): the access point, or #NULL if not set. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): the access point, or #NULL if not set. Do not free
* the returned value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_bearer_properties_get_apn (MMBearerProperties *self)
@@ -102,9 +107,13 @@ mm_bearer_properties_get_apn (MMBearerProperties *self)
/**
* mm_bearer_properties_set_allowed_auth:
* @self: a #MMBearerProperties.
* @allowed_auth: a bitmask of #MMBearerAllowedAuth values. %MM_BEARER_ALLOWED_AUTH_UNKNOWN may be given to request the modem-default method.
* @allowed_auth: a bitmask of #MMBearerAllowedAuth values.
* %MM_BEARER_ALLOWED_AUTH_UNKNOWN may be given to request the modem-default
* method.
*
* Sets the authentication method to use.
*
* Since: 1.0
*/
void
mm_bearer_properties_set_allowed_auth (MMBearerProperties *self,
@@ -121,7 +130,10 @@ mm_bearer_properties_set_allowed_auth (MMBearerProperties *self,
*
* Gets the authentication methods allowed in the connection.
*
* Returns: a bitmask of #MMBearerAllowedAuth values, or %MM_BEARER_ALLOWED_AUTH_UNKNOWN to request the modem-default method.
* Returns: a bitmask of #MMBearerAllowedAuth values, or
* %MM_BEARER_ALLOWED_AUTH_UNKNOWN to request the modem-default method.
*
* Since: 1.0
*/
MMBearerAllowedAuth
mm_bearer_properties_get_allowed_auth (MMBearerProperties *self)
@@ -139,6 +151,8 @@ mm_bearer_properties_get_allowed_auth (MMBearerProperties *self)
* @user: the username
*
* Sets the username used to authenticate with the access point.
*
* Since: 1.0
*/
void
mm_bearer_properties_set_user (MMBearerProperties *self,
@@ -156,7 +170,10 @@ mm_bearer_properties_set_user (MMBearerProperties *self,
*
* Gets the username used to authenticate with the access point.
*
* Returns: (transfer none): the username, or #NULL if not set. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): the username, or #NULL if not set. Do not free the
* returned value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_bearer_properties_get_user (MMBearerProperties *self)
@@ -174,6 +191,8 @@ mm_bearer_properties_get_user (MMBearerProperties *self)
* @password: the password
*
* Sets the password used to authenticate with the access point.
*
* Since: 1.0
*/
void
mm_bearer_properties_set_password (MMBearerProperties *self,
@@ -191,7 +210,10 @@ mm_bearer_properties_set_password (MMBearerProperties *self,
*
* Gets the password used to authenticate with the access point.
*
* Returns: (transfer none): the password, or #NULL if not set. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): the password, or #NULL if not set. Do not free
* the returned value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_bearer_properties_get_password (MMBearerProperties *self)
@@ -209,6 +231,8 @@ mm_bearer_properties_get_password (MMBearerProperties *self)
* @ip_type: a #MMBearerIpFamily.
*
* Sets the IP type to use.
*
* Since: 1.0
*/
void
mm_bearer_properties_set_ip_type (MMBearerProperties *self,
@@ -226,6 +250,8 @@ mm_bearer_properties_set_ip_type (MMBearerProperties *self,
* Sets the IP type to use.
*
* Returns: a #MMBearerIpFamily.
*
* Since: 1.0
*/
MMBearerIpFamily
mm_bearer_properties_get_ip_type (MMBearerProperties *self)
@@ -244,6 +270,8 @@ mm_bearer_properties_get_ip_type (MMBearerProperties *self)
*
* Sets the flag to indicate whether roaming is allowed or not in the
* connection.
*
* Since: 1.0
*/
void
mm_bearer_properties_set_allow_roaming (MMBearerProperties *self,
@@ -262,6 +290,8 @@ mm_bearer_properties_set_allow_roaming (MMBearerProperties *self,
* Checks whether roaming is allowed in the connection.
*
* Returns: %TRUE if roaming is allowed, %FALSE otherwise.
*
* Since: 1.0
*/
gboolean
mm_bearer_properties_get_allow_roaming (MMBearerProperties *self)
@@ -282,6 +312,7 @@ mm_bearer_properties_get_allow_roaming (MMBearerProperties *self)
*
* Sets the number to use when performing the connection.
*
* Since: 1.0
* Deprecated: 1.10.0. The number setting is not used anywhere, and therefore
* it doesn't make sense to expose it in the ModemManager interface.
*/
@@ -300,8 +331,10 @@ mm_bearer_properties_set_number (MMBearerProperties *self,
*
* Gets the number to use when performing the connection.
*
* Returns: (transfer none): the number, or #NULL if not set. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): the number, or #NULL if not set. Do not free the
* returned value, it is owned by @self.
*
* Since: 1.0
* Deprecated: 1.10.0. The number setting is not used anywhere, and therefore
* it doesn't make sense to expose it in the ModemManager interface.
*/
@@ -324,6 +357,8 @@ mm_bearer_properties_get_number (MMBearerProperties *self)
* @protocol: a #MMModemCdmaRmProtocol.
*
* Sets the RM protocol to use in the CDMA connection.
*
* Since: 1.0
*/
void
mm_bearer_properties_set_rm_protocol (MMBearerProperties *self,
@@ -341,6 +376,8 @@ mm_bearer_properties_set_rm_protocol (MMBearerProperties *self,
* Gets the RM protocol requested to use in the CDMA connection.
*
* Returns: a #MMModemCdmaRmProtocol.
*
* Since: 1.0
*/
MMModemCdmaRmProtocol
mm_bearer_properties_get_rm_protocol (MMBearerProperties *self)
@@ -615,14 +652,6 @@ mm_bearer_properties_new_from_dictionary (GVariant *dictionary,
/*****************************************************************************/
/**
* mm_bearer_properties_dup:
* @orig: a #MMBearerProperties
*
* Creates a copy of @orig.
*
* Returns: (transfer full): a newly created #MMBearerProperties
*/
MMBearerProperties *
mm_bearer_properties_dup (MMBearerProperties *orig)
{
@@ -664,6 +693,8 @@ mm_bearer_properties_cmp (MMBearerProperties *a,
* Creates a new empty #MMBearerProperties.
*
* Returns: (transfer full): a #MMBearerProperties. The returned value should be freed with g_object_unref().
*
* Since: 1.0
*/
MMBearerProperties *
mm_bearer_properties_new (void)

6
libmm-glib/mm-bearer-stats.c
View File

@@ -53,6 +53,8 @@ struct _MMBearerStatsPrivate {
* Gets the duration of the current connection, in seconds.
*
* Returns: a #guint.
*
* Since: 1.6
*/
guint
mm_bearer_stats_get_duration (MMBearerStats *self)
@@ -80,6 +82,8 @@ mm_bearer_stats_set_duration (MMBearerStats *self,
* Gets the number of bytes received without error in the connection.
*
* Returns: a #guint64.
*
* Since: 1.6
*/
guint64
mm_bearer_stats_get_rx_bytes (MMBearerStats *self)
@@ -107,6 +111,8 @@ mm_bearer_stats_set_rx_bytes (MMBearerStats *self,
* Gets the number of bytes transmitted without error in the connection.
*
* Returns: a #guint64.
*
* Since: 1.6
*/
guint64
mm_bearer_stats_get_tx_bytes (MMBearerStats *self)

120
libmm-glib/mm-bearer.c
View File

@@ -69,6 +69,8 @@ struct _MMBearerPrivate {
* Gets the DBus path of the #MMBearer object.
*
* Returns: (transfer none): The DBus path of the #MMBearer object.
*
* Since: 1.0
*/
const gchar *
mm_bearer_get_path (MMBearer *self)
@@ -85,7 +87,10 @@ mm_bearer_get_path (MMBearer *self)
*
* Gets a copy of the DBus path of the #MMBearer object.
*
* Returns: (transfer full): The DBus path of the #MMBearer object. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMBearer object. The returned
* value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_bearer_dup_path (MMBearer *self)
@@ -116,7 +121,10 @@ mm_bearer_dup_path (MMBearer *self)
* @self was constructed. Use mm_bearer_dup_interface() if on another
* thread.</warning>
*
* Returns: (transfer none): The name of the interface, or %NULL if it couldn't be retrieved.
* Returns: (transfer none): The name of the interface, or %NULL if it couldn't
* be retrieved.
*
* Since: 1.0
*/
const gchar *
mm_bearer_get_interface (MMBearer *self)
@@ -131,11 +139,14 @@ mm_bearer_get_interface (MMBearer *self)
* mm_bearer_dup_interface:
* @self: A #MMBearer.
*
* Gets a copy of the operating system name for the network data interface that provides
* packet data using this #MMBearer. This will only be available once the #MMBearer
* is in connected state.
* Gets a copy of the operating system name for the network data interface that
* provides packet data using this #MMBearer. This will only be available once
* the #MMBearer is in connected state.
*
* Returns: (transfer full): The name of the interface, or %NULL if it couldn't be retrieved. The returned value should be freed with g_free().
* Returns: (transfer full): The name of the interface, or %NULL if it couldn't
* be retrieved. The returned value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_bearer_dup_interface (MMBearer *self)
@@ -156,6 +167,8 @@ mm_bearer_dup_interface (MMBearer *self)
* communication is possible.
*
* Returns: %TRUE if the #MMBearer is connected, #FALSE otherwise.
*
* Since: 1.0
*/
gboolean
mm_bearer_get_connected (MMBearer *self)
@@ -171,10 +184,13 @@ mm_bearer_get_connected (MMBearer *self)
* mm_bearer_get_suspended:
* @self: A #MMBearer.
*
* Checks whether or not the #MMBearer is suspended (but not deactivated) while the
* device is handling other communications, like a voice call.
* Checks whether or not the #MMBearer is suspended (but not deactivated) while
* the device is handling other communications, like a voice call.
*
* Returns: %TRUE if packet data service is suspended in the #MMBearer, #FALSE otherwise.
* Returns: %TRUE if packet data service is suspended in the #MMBearer, #FALSE
* otherwise.
*
* Since: 1.0
*/
gboolean
mm_bearer_get_suspended (MMBearer *self)
@@ -193,6 +209,8 @@ mm_bearer_get_suspended (MMBearer *self)
* Gets the maximum time to wait for the bearer to retrieve a valid IP address.
*
* Returns: The IP timeout, or 0 if no specific one given.
*
* Since: 1.0
*/
guint
mm_bearer_get_ip_timeout (MMBearer *self)
@@ -211,6 +229,8 @@ mm_bearer_get_ip_timeout (MMBearer *self)
* Gets the type of bearer.
*
* Returns: a #MMBearerType.
*
* Since: 1.0
*/
MMBearerType
mm_bearer_get_bearer_type (MMBearer *self)
@@ -296,7 +316,10 @@ ensure_internal_ipv4_config (MMBearer *self,
* mm_bearer_get_ipv4_config() again to get a new #MMBearerIpConfig with the
* new values.</warning>
*
* Returns: (transfer full): A #MMBearerIpConfig that must be freed with g_object_unref() or %NULL if unknown.
* Returns: (transfer full): A #MMBearerIpConfig that must be freed with
* g_object_unref() or %NULL if unknown.
*
* Since: 1.0
*/
MMBearerIpConfig *
mm_bearer_get_ipv4_config (MMBearer *self)
@@ -321,7 +344,10 @@ mm_bearer_get_ipv4_config (MMBearer *self)
* @self was constructed. Use mm_bearer_get_ipv4_config() if on another
* thread.</warning>
*
* Returns: (transfer none): A #MMBearerIpConfig. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): A #MMBearerIpConfig. Do not free the returned
* value, it belongs to @self.
*
* Since: 1.0
*/
MMBearerIpConfig *
mm_bearer_peek_ipv4_config (MMBearer *self)
@@ -408,7 +434,10 @@ ensure_internal_ipv6_config (MMBearer *self,
* mm_bearer_get_ipv6_config() again to get a new #MMBearerIpConfig with the
* new values.</warning>
*
* Returns: (transfer full): A #MMBearerIpConfig that must be freed with g_object_unref() or %NULL if unknown.
* Returns: (transfer full): A #MMBearerIpConfig that must be freed with
* g_object_unref() or %NULL if unknown.
*
* Since: 1.0
*/
MMBearerIpConfig *
mm_bearer_get_ipv6_config (MMBearer *self)
@@ -433,7 +462,10 @@ mm_bearer_get_ipv6_config (MMBearer *self)
* @self was constructed. Use mm_bearer_get_ipv6_config() if on another
* thread.</warning>
*
* Returns: (transfer none): A #MMBearerIpConfig. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): A #MMBearerIpConfig. Do not free the returned
* value, it belongs to @self.
*
* Since: 1.0
*/
MMBearerIpConfig *
mm_bearer_peek_ipv6_config (MMBearer *self)
@@ -520,7 +552,10 @@ ensure_internal_properties (MMBearer *self,
* mm_bearer_get_properties() again to get a new #MMBearerProperties with the
* new values.</warning>
*
* Returns: (transfer full): A #MMBearerProperties that must be freed with g_object_unref() or %NULL if unknown.
* Returns: (transfer full): A #MMBearerProperties that must be freed with
* g_object_unref() or %NULL if unknown.
*
* Since: 1.0
*/
MMBearerProperties *
mm_bearer_get_properties (MMBearer *self)
@@ -545,7 +580,10 @@ mm_bearer_get_properties (MMBearer *self)
* @self was constructed. Use mm_bearer_get_properties() if on another
* thread.</warning>
*
* Returns: (transfer none): A #MMBearerProperties. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): A #MMBearerProperties. Do not free the returned
* value, it belongs to @self.
*
* Since: 1.0
*/
MMBearerProperties *
mm_bearer_peek_properties (MMBearer *self)
@@ -631,7 +669,10 @@ ensure_internal_stats (MMBearer *self,
* mm_bearer_get_stats() again to get a new #MMBearerStats with the
* new values.</warning>
*
* Returns: (transfer full): A #MMBearerStats that must be freed with g_object_unref() or %NULL if unknown.
* Returns: (transfer full): A #MMBearerStats that must be freed with
* g_object_unref() or %NULL if unknown.
*
* Since: 1.6
*/
MMBearerStats *
mm_bearer_get_stats (MMBearer *self)
@@ -656,7 +697,10 @@ mm_bearer_get_stats (MMBearer *self)
* @self was constructed. Use mm_bearer_get_stats() if on another
* thread.</warning>
*
* Returns: (transfer none): A #MMBearerStats. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): A #MMBearerStats. Do not free the returned value,
* it belongs to @self.
*
* Since: 1.6
*/
MMBearerStats *
mm_bearer_peek_stats (MMBearer *self)
@@ -672,12 +716,15 @@ mm_bearer_peek_stats (MMBearer *self)
/**
* mm_bearer_connect_finish:
* @self: A #MMBearer.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_bearer_connect().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_bearer_connect().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_bearer_connect().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_bearer_connect_finish (MMBearer *self,
@@ -699,10 +746,14 @@ mm_bearer_connect_finish (MMBearer *self,
* Asynchronously requests activation of a packet data connection with the
* network using this #MMBearer properties.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_bearer_connect_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_bearer_connect_finish() to get the result of the operation.
*
* See mm_bearer_connect_sync() for the synchronous, blocking version of this method.
*
* Since: 1.0
*/
void
mm_bearer_connect (MMBearer *self,
@@ -728,6 +779,8 @@ mm_bearer_connect (MMBearer *self,
* See mm_bearer_connect() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_bearer_connect_sync (MMBearer *self,
@@ -745,15 +798,22 @@ mm_bearer_connect_sync (MMBearer *self,
* mm_bearer_disconnect:
* @self: A #MMBearer.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Synchronously requests disconnection and deactivation of the packet data connection.
* Synchronously requests disconnection and deactivation of the packet data
* connection.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_bearer_disconnect_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_bearer_disconnect_finish() to get the result of the operation.
*
* See mm_bearer_disconnect_sync() for the synchronous, blocking version of this method.
* See mm_bearer_disconnect_sync() for the synchronous, blocking version of this
* method.
*
* Since: 1.0
*/
void
mm_bearer_disconnect (MMBearer *self,
@@ -769,12 +829,15 @@ mm_bearer_disconnect (MMBearer *self,
/**
* mm_bearer_disconnect_finish:
* @self: A #MMBearer.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_bearer_disconnect().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_bearer_disconnect().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_bearer_disconnect().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_bearer_disconnect_finish (MMBearer *self,
@@ -792,12 +855,15 @@ mm_bearer_disconnect_finish (MMBearer *self,
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Synchronously requests disconnection and deactivation of the packet data connection.
* Synchronously requests disconnection and deactivation of the packet data
* connection.
*
* The calling thread is blocked until a reply is received.
* See mm_bearer_disconnect() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_bearer_disconnect_sync (MMBearer *self,

20
libmm-glib/mm-call-audio-format.c
View File

@@ -51,7 +51,10 @@ struct _MMCallAudioFormatPrivate {
* Gets the encoding of the audio format. For example, "pcm" for PCM-encoded
* audio.
*
* Returns: a string with the encoding, or #NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: a string with the encoding, or #NULL if unknown. Do not free the
* returned value, it is owned by @self.
*
* Since: 1.10
*/
const gchar *
mm_call_audio_format_get_encoding (MMCallAudioFormat *self)
@@ -80,7 +83,10 @@ mm_call_audio_format_set_encoding (MMCallAudioFormat *self,
* Gets the resolution of the audio format. For example, "s16le" for signed
* 16-bit little-endian audio sampling resolution.
*
* Returns: a string with the resolution, or #NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: a string with the resolution, or #NULL if unknown. Do not free the
* returned value, it is owned by @self.
*
* Since: 1.10
*/
const gchar *
mm_call_audio_format_get_resolution (MMCallAudioFormat *self)
@@ -110,6 +116,8 @@ mm_call_audio_format_set_resolution (MMCallAudioFormat *self,
* sampling rate.
*
* Returns: the sampling rate, or 0 if unknown.
*
* Since: 1.10
*/
guint
mm_call_audio_format_get_rate (MMCallAudioFormat *self)
@@ -212,14 +220,6 @@ mm_call_audio_format_new_from_dictionary (GVariant *dictionary,
/*****************************************************************************/
/**
* mm_call_audio_format_dup:
* @orig: a #MMCallAudioFormat
*
* Creates a copy of @orig.
*
* Returns: (transfer full): a newly created #MMCallAudioFormat
*/
MMCallAudioFormat *
mm_call_audio_format_dup (MMCallAudioFormat *orig)
{

38
libmm-glib/mm-call-properties.c
View File

@@ -56,6 +56,8 @@ struct _MMCallPropertiesPrivate {
* @text: The number to set, in UTF-8.
*
* Sets the call number.
*
* Since: 1.6
*/
void
mm_call_properties_set_number (MMCallProperties *self,
@@ -73,7 +75,10 @@ mm_call_properties_set_number (MMCallProperties *self,
*
* Gets the number, in UTF-8.
*
* Returns: the call number, or %NULL if it doesn't contain any (anonymous caller). Do not free the returned value, it is owned by @self.
* Returns: the call number, or %NULL if it doesn't contain any (anonymous
* caller). Do not free the returned value, it is owned by @self.
*
* Since: 1.6
*/
const gchar *
mm_call_properties_get_number (MMCallProperties *self)
@@ -90,7 +95,9 @@ mm_call_properties_get_number (MMCallProperties *self)
* @self: A #MMCallProperties.
* @direction: the call direction
*
* Sets the call direction
* Sets the call direction.
*
* Since: 1.6
*/
void
mm_call_properties_set_direction (MMCallProperties *self,
@@ -108,6 +115,8 @@ mm_call_properties_set_direction (MMCallProperties *self,
* Gets the call direction.
*
* Returns: the call direction.
*
* Since: 1.6
*/
MMCallDirection
mm_call_properties_get_direction (MMCallProperties *self)
@@ -125,6 +134,8 @@ mm_call_properties_get_direction (MMCallProperties *self)
* @state: the call state
*
* Sets the call state
*
* Since: 1.6
*/
void
mm_call_properties_set_state (MMCallProperties *self,
@@ -142,6 +153,8 @@ mm_call_properties_set_state (MMCallProperties *self,
* Gets the call state.
*
* Returns: the call state.
*
* Since: 1.6
*/
MMCallState
mm_call_properties_get_state (MMCallProperties *self)
@@ -156,9 +169,11 @@ mm_call_properties_get_state (MMCallProperties *self)
/**
* mm_call_properties_set_state_reason:
* @self: A #MMCallProperties.
* @state_reason: the call state_reason
* @state_reason: the call state reason.
*
* Sets the call state reason
* Sets the call state reason.
*
* Since: 1.6
*/
void
mm_call_properties_set_state_reason (MMCallProperties *self,
@@ -176,6 +191,8 @@ mm_call_properties_set_state_reason (MMCallProperties *self,
* Gets the call state reason.
*
* Returns: the call state reason.
*
* Since: 1.6
*/
MMCallStateReason
mm_call_properties_get_state_reason (MMCallProperties *self)
@@ -404,14 +421,6 @@ mm_call_properties_new_from_dictionary (GVariant *dictionary,
/*****************************************************************************/
/**
* mm_call_properties_dup:
* @orig: a #MMCallProperties
*
* Returns a copy of @orig.
*
* Returns: (transfer full): a #MMCallProperties
*/
MMCallProperties *
mm_call_properties_dup (MMCallProperties *orig)
{
@@ -436,7 +445,10 @@ mm_call_properties_dup (MMCallProperties *orig)
*
* Creates a new empty #MMCallProperties.
*
* Returns: (transfer full): a #MMCallProperties. The returned value should be freed with g_object_unref().
* Returns: (transfer full): a #MMCallProperties. The returned value should be
* freed with g_object_unref().
*
* Since: 1.6
*/
MMCallProperties *
mm_call_properties_new (void)

183
libmm-glib/mm-call.c
View File

@@ -52,6 +52,8 @@ struct _MMCallPrivate {
* Gets the DBus path of the #MMCall object.
*
* Returns: (transfer none): The DBus path of the #MMCall object.
*
* Since: 1.6
*/
const gchar *
mm_call_get_path (MMCall *self)
@@ -68,7 +70,10 @@ mm_call_get_path (MMCall *self)
*
* Gets a copy of the DBus path of the #MMCall object.
*
* Returns: (transfer full): The DBus path of the #MMCall object. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMCall object.
* The returned value should be freed with g_free().
*
* Since: 1.6
*/
gchar *
mm_call_dup_path (MMCall *self)
@@ -99,6 +104,8 @@ mm_call_dup_path (MMCall *self)
* thread.</warning>
*
* Returns: (transfer none): The number, or %NULL if it couldn't be retrieved.
*
* Since: 1.6
*/
const gchar *
mm_call_get_number (MMCall *self)
@@ -116,7 +123,10 @@ mm_call_get_number (MMCall *self)
* Gets the call number. In outgoing calls contains the dialing number or
* the remote number in incoming calls
*
* Returns: (transfer full): The number, or %NULL if it couldn't be retrieved. The returned value should be freed with g_free().
* Returns: (transfer full): The number, or %NULL if it couldn't be retrieved.
* The returned value should be freed with g_free().
*
* Since: 1.6
*/
gchar *
mm_call_dup_number (MMCall *self)
@@ -136,6 +146,8 @@ mm_call_dup_number (MMCall *self)
* Gets the call direction.
*
* Returns: a #MMCallDirection.
*
* Since: 1.6
*/
MMCallDirection
mm_call_get_direction (MMCall *self)
@@ -153,7 +165,9 @@ mm_call_get_direction (MMCall *self)
*
* Gets whether the call is part of a multiparty call.
*
* Returns: %TRUE if the call is part of a multiparty call, %FALSE otherwise..
* Returns: %TRUE if the call is part of a multiparty call, %FALSE otherwise.
*
* Since: 1.12
*/
gboolean
mm_call_get_multiparty (MMCall *self)
@@ -172,6 +186,8 @@ mm_call_get_multiparty (MMCall *self)
* Gets the current state of call.
*
* Returns: a #MMCallState.
*
* Since: 1.6
*/
MMCallState
mm_call_get_state (MMCall *self)
@@ -190,6 +206,8 @@ mm_call_get_state (MMCall *self)
* Gets the reason of why the call changes its state.
*
* Returns: a #MMCallStateReason.
*
* Since: 1.6
*/
MMCallStateReason
mm_call_get_state_reason (MMCall *self)
@@ -209,6 +227,8 @@ mm_call_get_state_reason (MMCall *self)
*
* Returns: (transfer none): The audio port, or %NULL if call audio is not
* routed via the host or couldn't be retrieved.
*
* Since: 1.10
*/
const gchar *
mm_call_get_audio_port (MMCall *self)
@@ -227,6 +247,8 @@ mm_call_get_audio_port (MMCall *self)
*
* Returns: (transfer full): The audio port, or %NULL if call audio is not
* routed via the host or couldn't be retrieved.
*
* Since: 1.10
*/
gchar *
mm_call_dup_audio_port (MMCall *self)
@@ -313,7 +335,10 @@ ensure_internal_audio_format (MMCall *self,
* mm_call_get_audio_format() again to get a new #MMCallAudioFormat with the
* new values.</warning>
*
* Returns: (transfer full): A #MMCallAudioFormat that must be freed with g_object_unref() or %NULL if unknown.
* Returns: (transfer full): A #MMCallAudioFormat that must be freed with
* g_object_unref() or %NULL if unknown.
*
* Since: 1.10
*/
MMCallAudioFormat *
mm_call_get_audio_format (MMCall *self)
@@ -338,7 +363,10 @@ mm_call_get_audio_format (MMCall *self)
* @self was constructed. Use mm_call_get_audio_format() if on another
* thread.</warning>
*
* Returns: (transfer none): A #MMCallAudioFormat. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): A #MMCallAudioFormat. Do not free the returned
* value, it belongs to @self.
*
* Since: 1.10
*/
MMCallAudioFormat *
mm_call_peek_audio_format (MMCall *self)
@@ -354,12 +382,15 @@ mm_call_peek_audio_format (MMCall *self)
/**
* mm_call_start_finish:
* @self: A #MMCall.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_call_start().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_call_start().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_call_start().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.6
*/
gboolean
mm_call_start_finish (MMCall *self,
@@ -375,17 +406,22 @@ mm_call_start_finish (MMCall *self,
* mm_call_start:
* @self: A #MMCall.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to queue the call.
*
* Call objects can only be executed once.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_call_start_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_call_start_finish() to get the result of the operation.
*
* See mm_call_start_sync() for the synchronous, blocking version of this method.
*
* Since: 1.6
*/
void
mm_call_start (MMCall *self,
@@ -415,6 +451,8 @@ mm_call_start (MMCall *self,
* See mm_call_start() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.6
*/
gboolean
mm_call_start_sync (MMCall *self,
@@ -433,12 +471,15 @@ mm_call_start_sync (MMCall *self,
/**
* mm_call_accept_finish:
* @self: A #MMCall.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_call_accept().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_call_accept().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_call_accept().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.6
*/
gboolean
mm_call_accept_finish (MMCall *self,
@@ -454,17 +495,22 @@ mm_call_accept_finish (MMCall *self,
* mm_call_accept:
* @self: A #MMCall.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to accept the incoming call.
*
* Call objects can only be executed once.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_call_accept_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_call_accept_finish() to get the result of the operation.
*
* See mm_call_accept_sync() for the synchronous, blocking version of this method.
*
* Since: 1.6
*/
void
mm_call_accept (MMCall *self,
@@ -494,6 +540,8 @@ mm_call_accept (MMCall *self,
* See mm_call_accept() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.6
*/
gboolean
mm_call_accept_sync (MMCall *self,
@@ -512,12 +560,15 @@ mm_call_accept_sync (MMCall *self,
/**
* mm_call_deflect_finish:
* @self: A #MMCall.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_call_deflect().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_call_deflect().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_call_deflect().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
mm_call_deflect_finish (MMCall *self,
@@ -534,17 +585,23 @@ mm_call_deflect_finish (MMCall *self,
* @self: A #MMCall.
* @number: new number where the call will be deflected.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to deflect the incoming call.
*
* This call will be considered terminated once the deflection is performed.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_call_deflect_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_call_deflect_finish() to get the result of the operation.
*
* See mm_call_deflect_sync() for the synchronous, blocking version of this method.
* See mm_call_deflect_sync() for the synchronous, blocking version of this
* method.
*
* Since: 1.12
*/
void
mm_call_deflect (MMCall *self,
@@ -577,6 +634,8 @@ mm_call_deflect (MMCall *self,
* See mm_call_deflect() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
mm_call_deflect_sync (MMCall *self,
@@ -597,12 +656,15 @@ mm_call_deflect_sync (MMCall *self,
/**
* mm_call_join_multiparty_finish:
* @self: A #MMCall.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_call_join_multiparty().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_call_join_multiparty().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_call_join_multiparty().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
mm_call_join_multiparty_finish (MMCall *self,
@@ -618,15 +680,21 @@ mm_call_join_multiparty_finish (MMCall *self,
* mm_call_join_multiparty:
* @self: A #MMCall.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Synchronously requests to join this call into a multiparty call.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_call_join_multiparty_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_call_join_multiparty_finish() to get the result of the operation.
*
* See mm_call_join_multiparty_sync() for the synchronous, blocking version of this method.
* See mm_call_join_multiparty_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.12
*/
void
mm_call_join_multiparty (MMCall *self,
@@ -654,6 +722,8 @@ mm_call_join_multiparty (MMCall *self,
* See mm_call_join_multiparty() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
mm_call_join_multiparty_sync (MMCall *self,
@@ -670,12 +740,15 @@ mm_call_join_multiparty_sync (MMCall *self,
/**
* mm_call_leave_multiparty_finish:
* @self: A #MMCall.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_call_leave_multiparty().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_call_leave_multiparty().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_call_leave_multiparty().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
mm_call_leave_multiparty_finish (MMCall *self,
@@ -691,16 +764,22 @@ mm_call_leave_multiparty_finish (MMCall *self,
* mm_call_leave_multiparty:
* @self: A #MMCall.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Synchronously requests to make this call private again by leaving the
* multiparty call.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_call_leave_multiparty_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_call_leave_multiparty_finish() to get the result of the operation.
*
* See mm_call_leave_multiparty_sync() for the synchronous, blocking version of this method.
* See mm_call_leave_multiparty_sync() for the synchronous, blocking version
* of this method.
*
* Since: 1.12
*/
void
mm_call_leave_multiparty (MMCall *self,
@@ -729,6 +808,8 @@ mm_call_leave_multiparty (MMCall *self,
* See mm_call_leave_multiparty() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
mm_call_leave_multiparty_sync (MMCall *self,
@@ -747,12 +828,15 @@ mm_call_leave_multiparty_sync (MMCall *self,
/**
* mm_call_hangup_finish:
* @self: A #MMCall.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_call_hangup().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_call_hangup().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_call_hangup().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.6
*/
gboolean
mm_call_hangup_finish (MMCall *self,
@@ -768,17 +852,23 @@ mm_call_hangup_finish (MMCall *self,
* mm_call_hangup:
* @self: A #MMCall.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to hangup the call.
*
* Call objects can only be executed once.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_call_hangup_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_call_hangup_finish() to get the result of the operation.
*
* See mm_call_hangup_sync() for the synchronous, blocking version of this method.
* See mm_call_hangup_sync() for the synchronous, blocking version of this
* method.
*
* Since: 1.6
*/
void
mm_call_hangup (MMCall *self,
@@ -808,6 +898,8 @@ mm_call_hangup (MMCall *self,
* See mm_call_hangup() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.6
*/
gboolean
mm_call_hangup_sync (MMCall *self,
@@ -826,12 +918,15 @@ mm_call_hangup_sync (MMCall *self,
/**
* mm_call_send_dtmf_finish:
* @self: A #MMCall.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_call_send_dtmf().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_call_send_dtmf().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_call_send_dtmf().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.6
*/
gboolean
mm_call_send_dtmf_finish (MMCall *self,
@@ -848,17 +943,23 @@ mm_call_send_dtmf_finish (MMCall *self,
* @self: A #MMCall.
* @dtmf: the DMTF tone.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to send a DTMF tone the call.
*
* Call objects can only be executed once.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_call_send_dtmf_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_call_send_dtmf_finish() to get the result of the operation.
*
* See mm_call_send_dtmf_sync() for the synchronous, blocking version of this method.
* See mm_call_send_dtmf_sync() for the synchronous, blocking version of this
* method.
*
* Since: 1.6
*/
void
mm_call_send_dtmf (MMCall *self,
@@ -891,6 +992,8 @@ mm_call_send_dtmf (MMCall *self,
* See mm_call_send_dtmf() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.6
*/
gboolean
mm_call_send_dtmf_sync (MMCall *self,

90
libmm-glib/mm-cdma-manual-activation-properties.c
View File

@@ -58,7 +58,10 @@ struct _MMCdmaManualActivationPropertiesPrivate {
*
* Gets the Service Programming Code.
*
* Returns: (transfer none): The SPC. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The SPC. Do not free the returned value, it is
* owned by @self.
*
* Since: 1.2
*/
const gchar *
mm_cdma_manual_activation_properties_get_spc (MMCdmaManualActivationProperties *self)
@@ -105,6 +108,8 @@ validate_spc (const gchar *spc,
* Sets the Service Programming Code.
*
* Returns: %TRUE if the SPC was successfully set, or %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_cdma_manual_activation_properties_set_spc (MMCdmaManualActivationProperties *self,
@@ -130,6 +135,8 @@ mm_cdma_manual_activation_properties_set_spc (MMCdmaManualActivationProperties *
* Gets the System Identification Number.
*
* Returns: The SID.
*
* Since: 1.2
*/
guint16
mm_cdma_manual_activation_properties_get_sid (MMCdmaManualActivationProperties *self)
@@ -145,6 +152,8 @@ mm_cdma_manual_activation_properties_get_sid (MMCdmaManualActivationProperties *
* @sid: The SID.
*
* Sets the Service Identification Number.
*
* Since: 1.2
*/
void
mm_cdma_manual_activation_properties_set_sid (MMCdmaManualActivationProperties *self,
@@ -163,7 +172,10 @@ mm_cdma_manual_activation_properties_set_sid (MMCdmaManualActivationProperties *
*
* Gets the Mobile Directory Number.
*
* Returns: (transfer none): The MDN. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The MDN. Do not free the returned value, it is
* owned by @self.
*
* Since: 1.2
*/
const gchar *
mm_cdma_manual_activation_properties_get_mdn (MMCdmaManualActivationProperties *self)
@@ -198,6 +210,8 @@ validate_mdn (const gchar *mdn,
* Sets the Mobile Directory Number.
*
* Returns: %TRUE if the MDN was successfully set, or %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_cdma_manual_activation_properties_set_mdn (MMCdmaManualActivationProperties *self,
@@ -222,7 +236,10 @@ mm_cdma_manual_activation_properties_set_mdn (MMCdmaManualActivationProperties *
*
* Gets the Mobile Indentification Number.
*
* Returns: (transfer none): The MIN. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The MIN. Do not free the returned value, it is
* owned by @self.
*
* Since: 1.2
*/
const gchar *
mm_cdma_manual_activation_properties_get_min (MMCdmaManualActivationProperties *self)
@@ -257,6 +274,8 @@ validate_min (const gchar *min,
* Sets the Mobile Identification Number.
*
* Returns: %TRUE if the MIN was successfully set, or %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_cdma_manual_activation_properties_set_min (MMCdmaManualActivationProperties *self,
@@ -281,7 +300,10 @@ mm_cdma_manual_activation_properties_set_min (MMCdmaManualActivationProperties *
*
* Gets the MN-HA key.
*
* Returns: (transfer none): The MN-HA key. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The MN-HA key. Do not free the returned value, it
* is owned by @self.
*
* Since: 1.2
*/
const gchar *
mm_cdma_manual_activation_properties_get_mn_ha_key (MMCdmaManualActivationProperties *self)
@@ -315,7 +337,10 @@ validate_mn_ha_key (const gchar *mn_ha_key,
*
* Sets the Mobile Identification Number.
*
* Returns: %TRUE if the MN-HA key was successfully set, or %FALSE if @error is set.
* Returns: %TRUE if the MN-HA key was successfully set, or %FALSE if @error
* is set.
*
* Since: 1.2
*/
gboolean
mm_cdma_manual_activation_properties_set_mn_ha_key (MMCdmaManualActivationProperties *self,
@@ -340,7 +365,10 @@ mm_cdma_manual_activation_properties_set_mn_ha_key (MMCdmaManualActivationProper
*
* Gets the MN-AAA key.
*
* Returns: (transfer none): The MN-AAA key. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The MN-AAA key. Do not free the returned value, it
* is owned by @self.
*
* Since: 1.2
*/
const gchar *
mm_cdma_manual_activation_properties_get_mn_aaa_key (MMCdmaManualActivationProperties *self)
@@ -374,7 +402,10 @@ validate_mn_aaa_key (const gchar *mn_aaa_key,
*
* Sets the Mobile Identification Number.
*
* Returns: %TRUE if the MN-AAA key was successfully set, or %FALSE if @error is set.
* Returns: %TRUE if the MN-AAA key was successfully set, or %FALSE if @error is
* set.
*
* Since: 1.2
*/
gboolean
mm_cdma_manual_activation_properties_set_mn_aaa_key (MMCdmaManualActivationProperties *self,
@@ -400,7 +431,10 @@ mm_cdma_manual_activation_properties_set_mn_aaa_key (MMCdmaManualActivationPrope
*
* Gets the Preferred Roaming List.
*
* Returns: (transfer none): The PRL. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The PRL. Do not free the returned value, it is
* owned by @self.
*
* Since: 1.2
*/
const guint8 *
mm_cdma_manual_activation_properties_get_prl (MMCdmaManualActivationProperties *self,
@@ -420,7 +454,10 @@ mm_cdma_manual_activation_properties_get_prl (MMCdmaManualActivationProperties *
*
* Gets the Preferred Roaming List.
*
* Returns: (transfer none): A #GByteArray with the PRL, or %NULL if it doesn't contain any. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): A #GByteArray with the PRL, or %NULL if it doesn't
* contain any. Do not free the returned value, it is owned by @self.
*
* Since: 1.2
*/
GByteArray *
mm_cdma_manual_activation_properties_peek_prl_bytearray (MMCdmaManualActivationProperties *self)
@@ -436,7 +473,10 @@ mm_cdma_manual_activation_properties_peek_prl_bytearray (MMCdmaManualActivationP
*
* Gets the Preferred Roaming List.
*
* Returns: (transfer full): A #GByteArray with the PRL, or %NULL if it doesn't contain any. The returned value should be freed with g_byte_array_unref().
* Returns: (transfer full): A #GByteArray with the PRL, or %NULL if it doesn't
* contain any. The returned value should be freed with g_byte_array_unref().
*
* Since: 1.2
*/
GByteArray *
mm_cdma_manual_activation_properties_get_prl_bytearray (MMCdmaManualActivationProperties *self)
@@ -472,6 +512,8 @@ validate_prl (const guint8 *prl,
* Sets the Preferred Roaming List.
*
* Returns: %TRUE if the PRL was successfully set, or %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_cdma_manual_activation_properties_set_prl (MMCdmaManualActivationProperties *self,
@@ -499,12 +541,15 @@ mm_cdma_manual_activation_properties_set_prl (MMCdmaManualActivationProperties *
/**
* mm_cdma_manual_activation_properties_set_prl_bytearray:
* @self: A #MMCdmaManualActivationProperties.
* @prl: A #GByteArray with the PRL to set. This method takes a new reference of @prl.
* @prl: A #GByteArray with the PRL to set. This method takes a new reference
* of @prl.
* @error: Return location for error or %NULL.
*
* Sets the Preferred Roaming List.
*
* Returns: %TRUE if the PRL was successfully set, or %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_cdma_manual_activation_properties_set_prl_bytearray (MMCdmaManualActivationProperties *self,
@@ -525,14 +570,6 @@ mm_cdma_manual_activation_properties_set_prl_bytearray (MMCdmaManualActivationPr
/*****************************************************************************/
/**
* mm_cdma_manual_activation_properties_get_dictionary:
* @self: A #MMCdmaManualActivationProperties.
*
* Gets a variant dictionary with the contents of @self.
*
* Returns: (transfer full): A dictionary with the properties. The returned value should be freed with g_variant_unref().
*/
GVariant *
mm_cdma_manual_activation_properties_get_dictionary (MMCdmaManualActivationProperties *self)
{
@@ -659,16 +696,6 @@ consume_variant (MMCdmaManualActivationProperties *self,
return FALSE;
}
/**
* mm_cdma_manual_activation_properties_new_from_dictionary:
* @dictionary: A variant dictionary with the properties of the image.
* @error: Return location for error or %NULL.
*
* Creates a new #MMCdmaManualActivationProperties object with the properties exposed in
* the dictionary.
*
* Returns: (transfer full): A #MMCdmaManualActivationProperties or %NULL if @error is set. The returned value should be freed with g_object_unref().
*/
MMCdmaManualActivationProperties *
mm_cdma_manual_activation_properties_new_from_dictionary (GVariant *dictionary,
GError **error)
@@ -837,7 +864,10 @@ mm_cdma_manual_activation_properties_new_from_string (const gchar *str,
*
* Creates a new #MMCdmaManualActivationProperties object.
*
* Returns: (transfer full): A #MMCdmaManualActivationProperties. The returned value should be freed with g_object_unref().
* Returns: (transfer full): A #MMCdmaManualActivationProperties. The returned
* value should be freed with g_object_unref().
*
* Since: 1.2
*/
MMCdmaManualActivationProperties *
mm_cdma_manual_activation_properties_new (void)

70
libmm-glib/mm-firmware-properties.c
View File

@@ -31,7 +31,7 @@
* or mm_modem_firmware_list_sync().
*/
G_DEFINE_TYPE (MMFirmwareProperties, mm_firmware_properties, G_TYPE_OBJECT);
G_DEFINE_TYPE (MMFirmwareProperties, mm_firmware_properties, G_TYPE_OBJECT)
#define PROPERTY_UNIQUE_ID "unique-id"
#define PROPERTY_IMAGE_TYPE "image-type"
@@ -64,7 +64,10 @@ static MMFirmwareProperties *firmware_properties_new_empty (void);
*
* Gets the unique ID of the firmare image.
*
* Returns: (transfer none): The ID of the image. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The ID of the image. Do not free the returned
* value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_firmware_properties_get_unique_id (MMFirmwareProperties *self)
@@ -83,6 +86,8 @@ mm_firmware_properties_get_unique_id (MMFirmwareProperties *self)
* Gets the type of the firmare image.
*
* Returns: A #MMFirmwareImageType specifying The type of the image.
*
* Since: 1.0
*/
MMFirmwareImageType
mm_firmware_properties_get_image_type (MMFirmwareProperties *self)
@@ -100,7 +105,10 @@ mm_firmware_properties_get_image_type (MMFirmwareProperties *self)
*
* Gets the PRI version of a firmware image of type %MM_FIRMWARE_IMAGE_TYPE_GOBI.
*
* Returns: The PRI version, or %NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: The PRI version, or %NULL if unknown. Do not free the returned value,
* it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_firmware_properties_get_gobi_pri_version (MMFirmwareProperties *self)
@@ -130,7 +138,10 @@ mm_firmware_properties_set_gobi_pri_version (MMFirmwareProperties *self,
*
* Gets the PRI info of a firmware image of type %MM_FIRMWARE_IMAGE_TYPE_GOBI.
*
* Returns: The PRI info, or %NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: The PRI info, or %NULL if unknown. Do not free the returned value,
* it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_firmware_properties_get_gobi_pri_info (MMFirmwareProperties *self)
@@ -156,9 +167,13 @@ mm_firmware_properties_set_gobi_pri_info (MMFirmwareProperties *self,
* mm_firmware_properties_get_gobi_boot_version:
* @self: a #MMFirmwareProperties.
*
* Gets the boot version of a firmware image of type %MM_FIRMWARE_IMAGE_TYPE_GOBI.
* Gets the boot version of a firmware image of type
* %MM_FIRMWARE_IMAGE_TYPE_GOBI.
*
* Returns: The boot version, or %NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: The boot version, or %NULL if unknown. Do not free the returned
* value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_firmware_properties_get_gobi_boot_version (MMFirmwareProperties *self)
@@ -186,9 +201,13 @@ mm_firmware_properties_set_gobi_boot_version (MMFirmwareProperties *self,
* mm_firmware_properties_get_gobi_pri_unique_id:
* @self: a #MMFirmwareProperties.
*
* Gets the PRI unique ID of a firmware image of type %MM_FIRMWARE_IMAGE_TYPE_GOBI.
* Gets the PRI unique ID of a firmware image of type
* %MM_FIRMWARE_IMAGE_TYPE_GOBI.
*
* Returns: The PRI unique ID, or %NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: The PRI unique ID, or %NULL if unknown. Do not free the returned
* value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_firmware_properties_get_gobi_pri_unique_id (MMFirmwareProperties *self)
@@ -216,9 +235,13 @@ mm_firmware_properties_set_gobi_pri_unique_id (MMFirmwareProperties *self,
* mm_firmware_properties_get_gobi_modem_unique_id:
* @self: a #MMFirmwareProperties.
*
* Gets the MODEM unique ID of a firmware image of type %MM_FIRMWARE_IMAGE_TYPE_GOBI.
* Gets the MODEM unique ID of a firmware image of type
* %MM_FIRMWARE_IMAGE_TYPE_GOBI.
*
* Returns: The PRI unique ID, or %NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: The PRI unique ID, or %NULL if unknown. Do not free the returned
* value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_firmware_properties_get_gobi_modem_unique_id (MMFirmwareProperties *self)
@@ -242,14 +265,6 @@ mm_firmware_properties_set_gobi_modem_unique_id (MMFirmwareProperties *self,
/*****************************************************************************/
/**
* mm_firmware_properties_get_dictionary:
* @self: A #MMFirmwareProperties.
*
* Gets a variant dictionary with the contents of @self.
*
* Returns: (transfer full): A dictionary with the image properties. The returned value should be freed with g_variant_unref().
*/
GVariant *
mm_firmware_properties_get_dictionary (MMFirmwareProperties *self)
{
@@ -346,16 +361,6 @@ consume_variant (MMFirmwareProperties *self,
return TRUE;
}
/**
* mm_firmware_properties_new_from_dictionary:
* @dictionary: A variant dictionary with the properties of the image.
* @error: Return location for error or %NULL.
*
* Creates a new #MMFirmwareProperties object with the properties exposed in
* the dictionary.
*
* Returns: (transfer full): A #MMFirmwareProperties or %NULL if @error is set. The returned value should be freed with g_object_unref().
*/
MMFirmwareProperties *
mm_firmware_properties_new_from_dictionary (GVariant *dictionary,
GError **error)
@@ -420,15 +425,6 @@ mm_firmware_properties_new_from_dictionary (GVariant *dictionary,
/*****************************************************************************/
/**
* mm_firmware_properties_new:
* @image_type: A #MMFirmwareImageType specifying the type of the image.
* @unique_id: The unique ID of the image.
*
* Creates a new #MMFirmwareProperties object with the properties specified.
*
* Returns: (transfer full): A #MMFirmwareProperties or %NULL if @error is set. The returned value should be freed with g_object_unref().
*/
MMFirmwareProperties *
mm_firmware_properties_new (MMFirmwareImageType image_type,
const gchar *unique_id)

41
libmm-glib/mm-firmware-update-settings.c
View File

@@ -52,6 +52,8 @@ struct _MMFirmwareUpdateSettingsPrivate {
* Gets the methods to use during the firmware update operation.
*
* Returns: a bitmask of #MMModemFirmwareUpdateMethod values.
*
* Since: 1.10
*/
MMModemFirmwareUpdateMethod
mm_firmware_update_settings_get_method (MMFirmwareUpdateSettings *self)
@@ -67,10 +69,13 @@ mm_firmware_update_settings_get_method (MMFirmwareUpdateSettings *self)
* mm_firmware_update_settings_get_device_ids:
* @self: a #MMFirmwareUpdateSettings.
*
* Gets the list of device ids used to identify the device during a firmware update
* operation.
* Gets the list of device ids used to identify the device during a firmware
* update operation.
*
* Returns: (transfer none): The list of device ids, or %NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The list of device ids, or %NULL if unknown. Do not
* free the returned value, it is owned by @self.
*
* Since: 1.10
*/
const gchar **
mm_firmware_update_settings_get_device_ids (MMFirmwareUpdateSettings *self)
@@ -99,7 +104,10 @@ mm_firmware_update_settings_set_device_ids (MMFirmwareUpdateSettings *self,
* Gets firmware version string.
*
*
* Returns: The version string, or %NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: The version string, or %NULL if unknown. Do not free the returned
* value, it is owned by @self.
*
* Since: 1.10
*/
const gchar *
mm_firmware_update_settings_get_version (MMFirmwareUpdateSettings *self)
@@ -128,9 +136,13 @@ mm_firmware_update_settings_set_version (MMFirmwareUpdateSettings *self,
* Gets the AT command that should be sent to the module to trigger a reset
* into fastboot mode.
*
* Only applicable if the update method includes %MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT.
* Only applicable if the update method includes
* %MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT.
*
* Returns: The AT command string, or %NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: The AT command string, or %NULL if unknown. Do not free the returned
* value, it is owned by @self.
*
* Since: 1.10
*/
const gchar *
mm_firmware_update_settings_get_fastboot_at (MMFirmwareUpdateSettings *self)
@@ -154,14 +166,6 @@ mm_firmware_update_settings_set_fastboot_at (MMFirmwareUpdateSettings *self,
/*****************************************************************************/
/**
* mm_firmware_update_settings_get_variant:
* @self: A #MMFirmwareUpdateSettings.
*
* Gets a variant with the contents of @self.
*
* Returns: (transfer full): A variant with the update settings. The returned value should be freed with g_variant_unref().
*/
GVariant *
mm_firmware_update_settings_get_variant (MMFirmwareUpdateSettings *self)
{
@@ -222,15 +226,6 @@ consume_variant (MMFirmwareUpdateSettings *self,
return TRUE;
}
/**
* mm_firmware_update_settings_new_from_variant:
* @variant: A variant with the update settings.
* @error: Return location for error or %NULL.
*
* Creates a new #MMFirmwareUpdateSettings from the input @variant.
*
* Returns: (transfer full): A #MMFirmwareUpdateSettings or %NULL if @error is set. The returned value should be freed with g_object_unref().
*/
MMFirmwareUpdateSettings *
mm_firmware_update_settings_new_from_variant (GVariant *variant,
GError **error)

2
libmm-glib/mm-helper-types.c
View File

@@ -28,6 +28,8 @@
* @array_size: length of @array.
*
* Frees an array of #MMModemPortInfo values.
*
* Since: 1.0
*/
void
mm_modem_port_info_array_free (MMModemPortInfo *array,

9
libmm-glib/mm-helper-types.h
View File

@@ -35,7 +35,10 @@
* @allowed: Mask of #MMModemMode values specifying allowed modes.
* @preferred: A single #MMModemMode value specifying the preferred mode.
*
* #MMModemModeCombination is a simple struct holding a pair of #MMModemMode values.
* #MMModemModeCombination is a simple struct holding a pair of #MMModemMode
* values.
*
* Since: 1.0
*/
typedef struct _MMModemModeCombination MMModemModeCombination;
struct _MMModemModeCombination {
@@ -49,6 +52,8 @@ struct _MMModemModeCombination {
* @type: A #MMModemPortType value.
*
* Information of a given port.
*
* Since: 1.0
*/
typedef struct _MMModemPortInfo MMModemPortInfo;
struct _MMModemPortInfo {
@@ -66,6 +71,8 @@ void mm_modem_port_info_array_free (MMModemPortInfo *array,
*
* #MMOmaPendingNetworkInitiatedSession is a simple struct specifying the
* information available for a pending network-initiated OMA session.
*
* Since: 1.2
*/
typedef struct _MMOmaPendingNetworkInitiatedSession MMOmaPendingNetworkInitiatedSession;
struct _MMOmaPendingNetworkInitiatedSession {

41
libmm-glib/mm-kernel-event-properties.c
View File

@@ -56,6 +56,8 @@ struct _MMKernelEventPropertiesPrivate {
* @action: The action to set.
*
* Sets the action.
*
* Since: 1.8
*/
void
mm_kernel_event_properties_set_action (MMKernelEventProperties *self,
@@ -73,7 +75,10 @@ mm_kernel_event_properties_set_action (MMKernelEventProperties *self,
*
* Gets the action.
*
* Returns: (transfer none): The action. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The action. Do not free the returned value, it is
* owned by @self.
*
* Since: 1.8
*/
const gchar *
mm_kernel_event_properties_get_action (MMKernelEventProperties *self)
@@ -91,6 +96,8 @@ mm_kernel_event_properties_get_action (MMKernelEventProperties *self)
* @subsystem: The subsystem to set.
*
* Sets the subsystem.
*
* Since: 1.8
*/
void
mm_kernel_event_properties_set_subsystem (MMKernelEventProperties *self,
@@ -108,7 +115,10 @@ mm_kernel_event_properties_set_subsystem (MMKernelEventProperties *self,
*
* Gets the subsystem.
*
* Returns: (transfer none): The subsystem. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The subsystem. Do not free the returned value, it
* is owned by @self.
*
* Since: 1.8
*/
const gchar *
mm_kernel_event_properties_get_subsystem (MMKernelEventProperties *self)
@@ -126,6 +136,8 @@ mm_kernel_event_properties_get_subsystem (MMKernelEventProperties *self)
* @name: The name to set.
*
* Sets the name.
*
* Since: 1.8
*/
void
mm_kernel_event_properties_set_name (MMKernelEventProperties *self,
@@ -143,7 +155,10 @@ mm_kernel_event_properties_set_name (MMKernelEventProperties *self,
*
* Gets the name.
*
* Returns: (transfer none): The name. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The name. Do not free the returned value, it is
* owned by @self.
*
* Since: 1.8
*/
const gchar *
mm_kernel_event_properties_get_name (MMKernelEventProperties *self)
@@ -161,6 +176,8 @@ mm_kernel_event_properties_get_name (MMKernelEventProperties *self)
* @uid: The uid to set.
*
* Sets the unique ID of the physical device.
*
* Since: 1.8
*/
void
mm_kernel_event_properties_set_uid (MMKernelEventProperties *self,
@@ -178,7 +195,10 @@ mm_kernel_event_properties_set_uid (MMKernelEventProperties *self,
*
* Gets the unique ID of the physical device.
*
* Returns: (transfer none): The uid. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The uid. Do not free the returned value, it is
* owned by @self.
*
* Since: 1.8
*/
const gchar *
mm_kernel_event_properties_get_uid (MMKernelEventProperties *self)
@@ -382,14 +402,6 @@ mm_kernel_event_properties_new_from_dictionary (GVariant *dictionary,
/*****************************************************************************/
/**
* mm_kernel_event_properties_dup:
* @orig: a #MMKernelEventProperties
*
* Returns a copy of @orig.
*
* Returns: (transfer full): a #MMKernelEventProperties
*/
MMKernelEventProperties *
mm_kernel_event_properties_dup (MMKernelEventProperties *orig)
{
@@ -414,7 +426,10 @@ mm_kernel_event_properties_dup (MMKernelEventProperties *orig)
*
* Creates a new empty #MMKernelEventProperties.
*
* Returns: (transfer full): a #MMKernelEventProperties. The returned value should be freed with g_object_unref().
* Returns: (transfer full): a #MMKernelEventProperties. The returned value
* should be freed with g_object_unref().
*
* Since: 1.8
*/
MMKernelEventProperties *
mm_kernel_event_properties_new (void)

10
libmm-glib/mm-location-3gpp.c
View File

@@ -58,6 +58,8 @@ struct _MMLocation3gppPrivate {
* Gets the Mobile Country Code of the 3GPP network.
*
* Returns: the MCC, or 0 if unknown.
*
* Since: 1.0
*/
guint
mm_location_3gpp_get_mobile_country_code (MMLocation3gpp *self)
@@ -94,6 +96,8 @@ mm_location_3gpp_set_mobile_country_code (MMLocation3gpp *self,
* be 0.
*
* Returns: the MNC, or 0 if unknown.
*
* Since: 1.0
*/
guint
mm_location_3gpp_get_mobile_network_code (MMLocation3gpp *self)
@@ -127,6 +131,8 @@ mm_location_3gpp_set_mobile_network_code (MMLocation3gpp *self,
* Gets the location area code of the 3GPP network.
*
* Returns: the location area code, or 0 if unknown.
*
* Since: 1.0
*/
gulong
mm_location_3gpp_get_location_area_code (MMLocation3gpp *self)
@@ -159,6 +165,8 @@ mm_location_3gpp_set_location_area_code (MMLocation3gpp *self,
* Gets the cell ID of the 3GPP network.
*
* Returns: the cell ID, or 0 if unknown.
*
* Since: 1.0
*/
gulong
mm_location_3gpp_get_cell_id (MMLocation3gpp *self)
@@ -191,6 +199,8 @@ mm_location_3gpp_set_cell_id (MMLocation3gpp *self,
* Gets the location area code of the 3GPP network.
*
* Returns: the location area code, or 0 if unknown.
*
* Since: 1.10
*/
gulong
mm_location_3gpp_get_tracking_area_code (MMLocation3gpp *self)

4
libmm-glib/mm-location-cdma-bs.c
View File

@@ -53,6 +53,8 @@ struct _MMLocationCdmaBsPrivate {
* Gets the longitude, in the [-180,180] range.
*
* Returns: the longitude, or %MM_LOCATION_LONGITUDE_UNKNOWN if unknown.
*
* Since: 1.0
*/
gdouble
mm_location_cdma_bs_get_longitude (MMLocationCdmaBs *self)
@@ -72,6 +74,8 @@ mm_location_cdma_bs_get_longitude (MMLocationCdmaBs *self)
* Gets the latitude, in the [-90,90] range.
*
* Returns: the latitude, or %MM_LOCATION_LATITUDE_UNKNOWN if unknown.
*
* Since: 1.0
*/
gdouble
mm_location_cdma_bs_get_latitude (MMLocationCdmaBs *self)

6
libmm-glib/mm-location-common.h
View File

@@ -26,6 +26,8 @@
* Identifier for an unknown longitude value.
*
* Proper longitude values fall in the [-180,180] range.
*
* Since: 1.0
*/
#define MM_LOCATION_LONGITUDE_UNKNOWN -G_MAXDOUBLE
@@ -35,6 +37,8 @@
* Identifier for an unknown latitude value.
*
* Proper latitude values fall in the [-90,90] range.
*
* Since: 1.0
*/
#define MM_LOCATION_LATITUDE_UNKNOWN -G_MAXDOUBLE
@@ -42,6 +46,8 @@
* MM_LOCATION_ALTITUDE_UNKNOWN:
*
* Identifier for an unknown altitude value.
*
* Since: 1.0
*/
#define MM_LOCATION_ALTITUDE_UNKNOWN -G_MAXDOUBLE

14
libmm-glib/mm-location-gps-nmea.c
View File

@@ -34,7 +34,7 @@
* mm_modem_location_get_full_sync().
*/
G_DEFINE_TYPE (MMLocationGpsNmea, mm_location_gps_nmea, G_TYPE_OBJECT);
G_DEFINE_TYPE (MMLocationGpsNmea, mm_location_gps_nmea, G_TYPE_OBJECT)
struct _MMLocationGpsNmeaPrivate {
GHashTable *traces;
@@ -135,7 +135,10 @@ mm_location_gps_nmea_add_trace (MMLocationGpsNmea *self,
*
* Gets the last cached value of the specific @trace_type given.
*
* Returns: the NMEA trace, or %NULL if not available. Do not free the returned value, it is owned by @self.
* Returns: the NMEA trace, or %NULL if not available. Do not free the returned
* value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_location_gps_nmea_get_trace (MMLocationGpsNmea *self,
@@ -163,7 +166,10 @@ build_full_foreach (const gchar *trace_type,
*
* Gets a compilation of all cached traces.
*
* Returns: (transfer full): a string containing all traces, or #NULL if none available. The returned value should be freed with g_free().
* Returns: (transfer full): a string containing all traces, or #NULL if none
* available. The returned value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_location_gps_nmea_build_full (MMLocationGpsNmea *self)
@@ -249,7 +255,7 @@ mm_location_gps_nmea_new (void)
static void
mm_location_gps_nmea_init (MMLocationGpsNmea *self)
{
self->priv = G_TYPE_INSTANCE_GET_PRIVATE ((self),
self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
MM_TYPE_LOCATION_GPS_NMEA,
MMLocationGpsNmeaPrivate);

15
libmm-glib/mm-location-gps-raw.c
View File

@@ -34,7 +34,7 @@
* mm_modem_location_get_full_sync().
*/
G_DEFINE_TYPE (MMLocationGpsRaw, mm_location_gps_raw, G_TYPE_OBJECT);
G_DEFINE_TYPE (MMLocationGpsRaw, mm_location_gps_raw, G_TYPE_OBJECT)
#define PROPERTY_UTC_TIME "utc-time"
#define PROPERTY_LATITUDE "latitude"
@@ -59,7 +59,10 @@ struct _MMLocationGpsRawPrivate {
*
* Gets the UTC time of the location being reported.
*
* Returns: a string with the UTC time, or #NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: a string with the UTC time, or #NULL if unknown. Do not free the
* returned value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_location_gps_raw_get_utc_time (MMLocationGpsRaw *self)
@@ -78,6 +81,8 @@ mm_location_gps_raw_get_utc_time (MMLocationGpsRaw *self)
* Gets the longitude, in the [-180,180] range.
*
* Returns: the longitude, or %MM_LOCATION_LONGITUDE_UNKNOWN if unknown.
*
* Since: 1.0
*/
gdouble
mm_location_gps_raw_get_longitude (MMLocationGpsRaw *self)
@@ -97,6 +102,8 @@ mm_location_gps_raw_get_longitude (MMLocationGpsRaw *self)
* Gets the latitude, in the [-90,90] range.
*
* Returns: the latitude, or %MM_LOCATION_LATITUDE_UNKNOWN if unknown.
*
* Since: 1.0
*/
gdouble
mm_location_gps_raw_get_latitude (MMLocationGpsRaw *self)
@@ -116,6 +123,8 @@ mm_location_gps_raw_get_latitude (MMLocationGpsRaw *self)
* Gets the altitude, in the [-90,90] range.
*
* Returns: the altitude, or %MM_LOCATION_ALTITUDE_UNKNOWN if unknown.
*
* Since: 1.0
*/
gdouble
mm_location_gps_raw_get_altitude (MMLocationGpsRaw *self)
@@ -369,7 +378,7 @@ mm_location_gps_raw_new (void)
static void
mm_location_gps_raw_init (MMLocationGpsRaw *self)
{
self->priv = G_TYPE_INSTANCE_GET_PRIVATE ((self),
self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
MM_TYPE_LOCATION_GPS_RAW,
MMLocationGpsRawPrivate);

141
libmm-glib/mm-manager.c
View File

@@ -146,12 +146,16 @@ ensure_modem_manager1_proxy (MMManager *self,
/**
* mm_manager_new_finish:
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_manager_new().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_manager_new().
* @error: Return location for error or %NULL
*
* Finishes an operation started with mm_manager_new().
*
* Returns: (transfer full) (type MMManager): The constructed object manager client or %NULL if @error is set.
* Returns: (transfer full) (type MMManager): The constructed object manager
* client or %NULL if @error is set.
*
* Since: 1.0
*/
MMManager *
mm_manager_new_finish (GAsyncResult *res,
@@ -182,7 +186,10 @@ mm_manager_new_finish (GAsyncResult *res,
*
* You can then call mm_manager_new_finish() to get the result of the operation.
*
* See mm_manager_new_sync() for the synchronous, blocking version of this constructor.
* See mm_manager_new_sync() for the synchronous, blocking version of this
* constructor.
*
* Since: 1.0
*/
void
mm_manager_new (GDBusConnection *connection,
@@ -217,7 +224,10 @@ mm_manager_new (GDBusConnection *connection,
*
* See mm_manager_new() for the asynchronous version of this constructor.
*
* Returns: (transfer full) (type MMManager): The constructed object manager client or %NULL if @error is set.
* Returns: (transfer full) (type MMManager): The constructed object manager
* client or %NULL if @error is set.
*
* Since: 1.0
*/
MMManager *
mm_manager_new_sync (GDBusConnection *connection,
@@ -244,7 +254,10 @@ mm_manager_new_sync (GDBusConnection *connection,
*
* Gets the #GDBusProxy interface of the @manager.
*
* Returns: (transfer none): The #GDBusProxy interface of @manager, or #NULL if none. Do not free the returned object, it is owned by @manager.
* Returns: (transfer none): The #GDBusProxy interface of @manager, or #NULL if
* none. Do not free the returned object, it is owned by @manager.
*
* Since: 1.0
*/
GDBusProxy *
mm_manager_peek_proxy (MMManager *manager)
@@ -263,7 +276,10 @@ mm_manager_peek_proxy (MMManager *manager)
*
* Gets the #GDBusProxy interface of the @manager.
*
* Returns: (transfer full): The #GDBusProxy interface of @manager, or #NULL if none. The returned object must be freed with g_object_unref().
* Returns: (transfer full): The #GDBusProxy interface of @manager, or #NULL if
* none. The returned object must be freed with g_object_unref().
*
* Since: 1.0
*/
GDBusProxy *
mm_manager_get_proxy (MMManager *manager)
@@ -286,7 +302,10 @@ mm_manager_get_proxy (MMManager *manager)
*
* It is safe to assume this value never changes during runtime.
*
* Returns: (transfer none): The version, or %NULL if none available. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): The version, or %NULL if none available. Do not
* free the returned value, it belongs to @self.
*
* Since: 1.0
*/
const gchar *
mm_manager_get_version (MMManager *manager)
@@ -305,12 +324,15 @@ mm_manager_get_version (MMManager *manager)
/**
* mm_manager_set_logging_finish:
* @manager: A #MMManager.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_manager_set_logging().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_manager_set_logging().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_manager_set_logging().
*
* Returns: %TRUE if the call succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_manager_set_logging_finish (MMManager *manager,
@@ -343,7 +365,8 @@ set_logging_ready (MmGdbusOrgFreedesktopModemManager1 *manager_iface_proxy,
* @manager: A #MMManager.
* @level: the login level to set.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to set the specified logging level in the daemon.
@@ -353,7 +376,10 @@ set_logging_ready (MmGdbusOrgFreedesktopModemManager1 *manager_iface_proxy,
* of the thread you are calling this method from. You can then call
* mm_manager_set_logging_finish() to get the result of the operation.
*
* See mm_manager_set_logging_sync() for the synchronous, blocking version of this method.
* See mm_manager_set_logging_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.0
*/
void
mm_manager_set_logging (MMManager *manager,
@@ -390,13 +416,15 @@ mm_manager_set_logging (MMManager *manager,
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Synchronously requests to set the specified logging level in the daemon..
* Synchronously requests to set the specified logging level in the daemon.
*
* The calling thread is blocked until a reply is received.
*
* See mm_manager_set_logging() for the asynchronous version of this method.
*
* Returns: %TRUE if the call succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_manager_set_logging_sync (MMManager *manager,
@@ -421,12 +449,15 @@ mm_manager_set_logging_sync (MMManager *manager,
/**
* mm_manager_scan_devices_finish:
* @manager: A #MMManager.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_manager_scan_devices().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_manager_scan_devices().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_manager_scan_devices().
*
* Returns: %TRUE if the call succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_manager_scan_devices_finish (MMManager *manager,
@@ -458,7 +489,8 @@ scan_devices_ready (MmGdbusOrgFreedesktopModemManager1 *manager_iface_proxy,
* mm_manager_scan_devices:
* @manager: A #MMManager.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to scan looking for devices.
@@ -468,7 +500,10 @@ scan_devices_ready (MmGdbusOrgFreedesktopModemManager1 *manager_iface_proxy,
* of the thread you are calling this method from. You can then call
* mm_manager_scan_devices_finish() to get the result of the operation.
*
* See mm_manager_scan_devices_sync() for the synchronous, blocking version of this method.
* See mm_manager_scan_devices_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.0
*/
void
mm_manager_scan_devices (MMManager *manager,
@@ -509,6 +544,8 @@ mm_manager_scan_devices (MMManager *manager,
* See mm_manager_scan_devices() for the asynchronous version of this method.
*
* Returns: %TRUE if the call succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_manager_scan_devices_sync (MMManager *manager,
@@ -531,12 +568,15 @@ mm_manager_scan_devices_sync (MMManager *manager,
/**
* mm_manager_report_kernel_event_finish:
* @manager: A #MMManager.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_manager_report_kernel_event().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_manager_report_kernel_event().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_manager_report_kernel_event().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.8
*/
gboolean
mm_manager_report_kernel_event_finish (MMManager *manager,
@@ -568,7 +608,8 @@ report_kernel_event_ready (MmGdbusOrgFreedesktopModemManager1 *manager_iface_pro
* @manager: A #MMManager.
* @properties: the properties of the kernel event.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously report kernel event.
@@ -578,7 +619,10 @@ report_kernel_event_ready (MmGdbusOrgFreedesktopModemManager1 *manager_iface_pro
* of the thread you are calling this method from. You can then call
* mm_manager_report_kernel_event_finish() to get the result of the operation.
*
* See mm_manager_report_kernel_event_sync() for the synchronous, blocking version of this method.
* See mm_manager_report_kernel_event_sync() for the synchronous, blocking
* version of this method.
*
* Since: 1.8
*/
void
mm_manager_report_kernel_event (MMManager *manager,
@@ -622,9 +666,12 @@ mm_manager_report_kernel_event (MMManager *manager,
*
* The calling thread is blocked until a reply is received.
*
* See mm_manager_report_kernel_event() for the asynchronous version of this method.
* See mm_manager_report_kernel_event() for the asynchronous version of this
* method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.8
*/
gboolean
mm_manager_report_kernel_event_sync (MMManager *manager,
@@ -723,12 +770,15 @@ common_inhibit_device_sync (MMManager *manager,
/**
* mm_manager_inhibit_device_finish:
* @manager: A #MMManager.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_manager_inhibit_device().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_manager_inhibit_device().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_manager_inhibit_device().
*
* Returns: %TRUE if the call succeeded, %FALSE if @error is set.
*
* Since: 1.10
*/
gboolean
mm_manager_inhibit_device_finish (MMManager *manager,
@@ -744,14 +794,17 @@ mm_manager_inhibit_device_finish (MMManager *manager,
* @manager: A #MMManager.
* @uid: the unique ID of the physical device.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to add an inhibition on the device identified by @uid.
* Asynchronously requests to add an inhibition on the device identified by
* @uid.
*
* The @uid must be the unique ID retrieved from an existing #MMModem using
* mm_modem_get_device(). The caller should keep track of this @uid and use it
* in the mm_manager_uninhibit_device() call when the inhibition is no longer required.
* in the mm_manager_uninhibit_device() call when the inhibition is no longer
* required.
*
* The inhibition added with this method may also be automatically removed when
* the caller program disappears from the bus (e.g. if the program ends before
@@ -762,7 +815,10 @@ mm_manager_inhibit_device_finish (MMManager *manager,
* of the thread you are calling this method from. You can then call
* mm_manager_inhibit_device_finish() to get the result of the operation.
*
* See mm_manager_inhibit_device_sync() for the synchronous, blocking version of this method.
* See mm_manager_inhibit_device_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.10
*/
void
mm_manager_inhibit_device (MMManager *manager,
@@ -786,7 +842,8 @@ mm_manager_inhibit_device (MMManager *manager,
*
* The @uid must be the unique ID retrieved from an existing #MMModem using
* mm_modem_get_device(). The caller should keep track of this @uid and use it
* in the mm_manager_uninhibit_device_sync() call when the inhibition is no longer required.
* in the mm_manager_uninhibit_device_sync() call when the inhibition is no
* longer required.
*
* The inhibition added with this method may also be automatically removed when
* the caller program disappears from the bus (e.g. if the program ends before
@@ -795,6 +852,8 @@ mm_manager_inhibit_device (MMManager *manager,
* See mm_manager_inhibit_device() for the asynchronous version of this method.
*
* Returns: %TRUE if the call succeeded, %FALSE if @error is set.
*
* Since: 1.10
*/
gboolean
mm_manager_inhibit_device_sync (MMManager *manager,
@@ -809,12 +868,15 @@ mm_manager_inhibit_device_sync (MMManager *manager,
/**
* mm_manager_uninhibit_device_finish:
* @manager: A #MMManager.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_manager_uninhibit_device().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_manager_uninhibit_device().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_manager_uninhibit_device().
*
* Returns: %TRUE if the call succeeded, %FALSE if @error is set.
*
* Since: 1.10
*/
gboolean
mm_manager_uninhibit_device_finish (MMManager *manager,
@@ -830,22 +892,27 @@ mm_manager_uninhibit_device_finish (MMManager *manager,
* @manager: A #MMManager.
* @uid: the unique ID of the physical device.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to remove an inhibition on the device identified by @uid.
* Asynchronously requests to remove an inhibition on the device identified by
* @uid.
*
* The @uid must be the same unique ID that was sent in the inhibition request.
*
* Only the same program that placed an inhibition on a given device is able to remove
* the inhibition.
* Only the same program that placed an inhibition on a given device is able to
* remove the inhibition.
*
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_manager_uninhibit_device_finish() to get the result of the operation.
*
* See mm_manager_uninhibit_device_sync() for the synchronous, blocking version of this method.
* See mm_manager_uninhibit_device_sync() for the synchronous, blocking version
* of this method.
*
* Since: 1.10
*/
void
mm_manager_uninhibit_device (MMManager *manager,
@@ -865,16 +932,20 @@ mm_manager_uninhibit_device (MMManager *manager,
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Synchronously requests to remove an inhibition on the device identified by @uid.
* Synchronously requests to remove an inhibition on the device identified by
* @uid.
*
* The @uid must be the same unique ID that was sent in the inhibition request.
*
* Only the same program that placed an inhibition on a given device is able to remove
* the inhibition.
* Only the same program that placed an inhibition on a given device is able to
* remove the inhibition.
*
* See mm_manager_uninhibit_device() for the asynchronous version of this method.
* See mm_manager_uninhibit_device() for the asynchronous version of this
* method.
*
* Returns: %TRUE if the call succeeded, %FALSE if @error is set.
*
* Since: 1.10
*/
gboolean
mm_manager_uninhibit_device_sync (MMManager *manager,
@@ -911,7 +982,7 @@ mm_manager_init (MMManager *manager)
register_dbus_errors ();
/* Setup private data */
manager->priv = G_TYPE_INSTANCE_GET_PRIVATE ((manager),
manager->priv = G_TYPE_INSTANCE_GET_PRIVATE (manager,
MM_TYPE_MANAGER,
MMManagerPrivate);
}

159
libmm-glib/mm-modem-3gpp-ussd.c
View File

@@ -49,6 +49,8 @@ G_DEFINE_TYPE (MMModem3gppUssd, mm_modem_3gpp_ussd, MM_GDBUS_TYPE_MODEM3GPP_USSD
* Gets the DBus path of the #MMObject which implements this interface.
*
* Returns: (transfer none): The DBus path of the #MMObject object.
*
* Since: 1.0
*/
const gchar *
mm_modem_3gpp_ussd_get_path (MMModem3gppUssd *self)
@@ -63,9 +65,13 @@ mm_modem_3gpp_ussd_get_path (MMModem3gppUssd *self)
* mm_modem_3gpp_ussd_dup_path:
* @self: A #MMModem3gppUssd.
*
* Gets a copy of the DBus path of the #MMObject object which implements this interface.
* Gets a copy of the DBus path of the #MMObject object which implements this
* interface.
*
* Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMObject. The returned value
* should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_3gpp_ussd_dup_path (MMModem3gppUssd *self)
@@ -90,10 +96,12 @@ mm_modem_3gpp_ussd_dup_path (MMModem3gppUssd *self)
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_3gpp_ussd_dup_network_request() if on another
* thread.</warning>
* @self was constructed. Use mm_modem_3gpp_ussd_dup_network_request() if on
* another thread.</warning>
*
* Returns: (transfer none): The network request, or %NULL if none available.
*
* Since: 1.0
*/
const gchar *
mm_modem_3gpp_ussd_get_network_request (MMModem3gppUssd *self)
@@ -110,7 +118,10 @@ mm_modem_3gpp_ussd_get_network_request (MMModem3gppUssd *self)
*
* Gets a copy of any pending network-initiated request.
*
* Returns: (transfer full): The network request, or %NULL if none available. The returned value should be freed with g_free().
* Returns: (transfer full): The network request, or %NULL if none available.
* The returned value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_3gpp_ussd_dup_network_request (MMModem3gppUssd *self)
@@ -127,14 +138,17 @@ mm_modem_3gpp_ussd_dup_network_request (MMModem3gppUssd *self)
* mm_modem_3gpp_ussd_get_network_notification:
* @self: A #MMModem3gppUssd.
*
* Gets any pending network-initiated request to which no USSD response is required.
* Gets any pending network-initiated request to which no USSD response is
* required.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_3gpp_ussd_dup_network_notification() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_modem_3gpp_ussd_dup_network_notification() if on another thread.</warning>
*
* Returns: (transfer none): The network notification, or %NULL if none available.
* Returns: (transfer none): The network notification, or %NULL if none
* available.
*
* Since: 1.0
*/
const gchar *
mm_modem_3gpp_ussd_get_network_notification (MMModem3gppUssd *self)
@@ -149,9 +163,13 @@ mm_modem_3gpp_ussd_get_network_notification (MMModem3gppUssd *self)
* mm_modem_3gpp_ussd_dup_network_notification:
* @self: A #MMModem3gppUssd.
*
* Gets a copy of any pending network-initiated request to which no USSD response is required.
* Gets a copy of any pending network-initiated request to which no USSD
* response is required.
*
* Returns: (transfer full): The network notification, or %NULL if none available. The returned value should be freed with g_free().
* Returns: (transfer full): The network notification, or %NULL if none
* available. The returned value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_3gpp_ussd_dup_network_notification (MMModem3gppUssd *self)
@@ -171,6 +189,8 @@ mm_modem_3gpp_ussd_dup_network_notification (MMModem3gppUssd *self)
* Get the state of the ongoing USSD session, if any.
*
* Returns: A #MMModem3gppUssdSessionState value, specifying the current state.
*
* Since: 1.0
*/
MMModem3gppUssdSessionState
mm_modem_3gpp_ussd_get_state (MMModem3gppUssd *self)
@@ -185,12 +205,16 @@ mm_modem_3gpp_ussd_get_state (MMModem3gppUssd *self)
/**
* mm_modem_3gpp_ussd_initiate_finish:
* @self: A #MMModem3gppUssd.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_3gpp_ussd_initiate().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_3gpp_ussd_initiate().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_3gpp_ussd_initiate().
*
* Returns: The response from the network, if any. The returned value should be freed with g_free().
* Returns: The response from the network, if any. The returned value should be
* freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_3gpp_ussd_initiate_finish (MMModem3gppUssd *self,
@@ -211,19 +235,26 @@ mm_modem_3gpp_ussd_initiate_finish (MMModem3gppUssd *self,
* @self: A #MMModem3gppUssd.
* @command: The command to start the USSD session with.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously sends a USSD command string to the network initiating a USSD session.
* Asynchronously sends a USSD command string to the network initiating a USSD
* session.
*
* When the request is handled by the network, the method returns the
* response or an appropriate error. The network may be awaiting further
* response from the ME after returning from this method and no new command.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_3gpp_ussd_initiate_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_3gpp_ussd_initiate_finish() to get the result of the operation.
*
* See mm_modem_3gpp_ussd_initiate_sync() for the synchronous, blocking version of this method.
* See mm_modem_3gpp_ussd_initiate_sync() for the synchronous, blocking version
* of this method.
*
* Since: 1.0
*/
void
mm_modem_3gpp_ussd_initiate (MMModem3gppUssd *self,
@@ -244,16 +275,20 @@ mm_modem_3gpp_ussd_initiate (MMModem3gppUssd *self,
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Synchronously sends a USSD command string to the network initiating a USSD session.
* Synchronously sends a USSD command string to the network initiating a USSD
* session.
*
* When the request is handled by the network, the method returns the
* response or an appropriate error. The network may be awaiting further
* response from the ME after returning from this method and no new command.
*
* The calling thread is blocked until a reply is received. See mm_modem_3gpp_ussd_initiate()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_3gpp_ussd_initiate() for the asynchronous version of this method.
*
* Returns: The response from the network, if any. The returned value should be freed with g_free().
* Returns: The response from the network, if any. The returned value should be
* freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_3gpp_ussd_initiate_sync (MMModem3gppUssd *self,
@@ -275,12 +310,17 @@ mm_modem_3gpp_ussd_initiate_sync (MMModem3gppUssd *self,
/**
* mm_modem_3gpp_ussd_respond_finish:
* @self: A #MMModem3gppUssd.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_3gpp_ussd_respond().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_3gpp_ussd_respond().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_3gpp_ussd_respond().
*
* Returns: The network reply to this response to the network-initiated USSD command. The reply may require further responses. The returned value should be freed with g_free().
* Returns: The network reply to this response to the network-initiated USSD
* command. The reply may require further responses. The returned value should
* be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_3gpp_ussd_respond_finish (MMModem3gppUssd *self,
@@ -299,19 +339,26 @@ mm_modem_3gpp_ussd_respond_finish (MMModem3gppUssd *self,
/**
* mm_modem_3gpp_ussd_respond:
* @self: A #MMModem3gppUssd.
* @response: The response to network-initiated USSD command, or a response to a request for further input.
* @response: The response to network-initiated USSD command, or a response to a
* request for further input.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously responds to a USSD request that is either initiated by the
* mobile network, or that is awaiting further input after a previous call to
* mm_modem_3gpp_ussd_initiate().
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_3gpp_ussd_respond_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_3gpp_ussd_respond_finish() to get the result of the operation.
*
* See mm_modem_3gpp_ussd_respond_sync() for the synchronous, blocking version of this method.
* See mm_modem_3gpp_ussd_respond_sync() for the synchronous, blocking version
* of this method.
*
* Since: 1.0
*/
void
mm_modem_3gpp_ussd_respond (MMModem3gppUssd *self,
@@ -328,7 +375,8 @@ mm_modem_3gpp_ussd_respond (MMModem3gppUssd *self,
/**
* mm_modem_3gpp_ussd_respond_sync:
* @self: A #MMModem3gppUssd.
* @response: The response to network-initiated USSD command, or a response to a request for further input.
* @response: The response to network-initiated USSD command, or a response to a
* request for further input.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
@@ -336,10 +384,14 @@ mm_modem_3gpp_ussd_respond (MMModem3gppUssd *self,
* mobile network, or that is awaiting further input after a previous call to
* mm_modem_3gpp_ussd_initiate().
*
* The calling thread is blocked until a reply is received. See mm_modem_3gpp_ussd_respond()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_3gpp_ussd_respond() for the asynchronous version of this method.
*
* Returns: The network reply to this response to the network-initiated USSD command. The reply may require further responses. The returned value should be freed with g_free().
* Returns: The network reply to this response to the network-initiated USSD
* command. The reply may require further responses. The returned value should
* be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_3gpp_ussd_respond_sync (MMModem3gppUssd *self,
@@ -361,12 +413,16 @@ mm_modem_3gpp_ussd_respond_sync (MMModem3gppUssd *self,
/**
* mm_modem_3gpp_ussd_cancel_finish:
* @self: A #MMModem3gppUssd.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_3gpp_ussd_cancel().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_3gpp_ussd_cancel().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_3gpp_ussd_cancel().
*
* Returns: %TRUE if the session was successfully cancelled, %FALSE if @error is set.
* Returns: %TRUE if the session was successfully cancelled, %FALSE if @error is
* set.
*
* Since: 1.0
*/
gboolean
mm_modem_3gpp_ussd_cancel_finish (MMModem3gppUssd *self,
@@ -382,15 +438,22 @@ mm_modem_3gpp_ussd_cancel_finish (MMModem3gppUssd *self,
* mm_modem_3gpp_ussd_cancel:
* @self: A #MMModem3gppUssd.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously cancels an ongoing USSD session, either mobile or network initiated.
* Asynchronously cancels an ongoing USSD session, either mobile or network
* initiated.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_3gpp_ussd_cancel_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_3gpp_ussd_cancel_finish() to get the result of the operation.
*
* See mm_modem_3gpp_ussd_cancel_sync() for the synchronous, blocking version of this method.
* See mm_modem_3gpp_ussd_cancel_sync() for the synchronous, blocking version
* of this method.
*
* Since: 1.0
*/
void
mm_modem_3gpp_ussd_cancel (MMModem3gppUssd *self,
@@ -409,12 +472,16 @@ mm_modem_3gpp_ussd_cancel (MMModem3gppUssd *self,
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Synchronously cancels an ongoing USSD session, either mobile or network initiated.
* Synchronously cancels an ongoing USSD session, either mobile or network
* initiated.
*
* The calling thread is blocked until a reply is received. See mm_modem_3gpp_ussd_cancel()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_3gpp_ussd_cancel() for the asynchronous version of this method.
*
* Returns: %TRUE if the session was successfully cancelled, %FALSE if @error is set.
* Returns: %TRUE if the session was successfully cancelled, %FALSE if @error is
* set.
*
* Since: 1.0
*/
gboolean
mm_modem_3gpp_ussd_cancel_sync (MMModem3gppUssd *self,

258
libmm-glib/mm-modem-3gpp.c
View File

@@ -59,6 +59,8 @@ struct _MMModem3gppPrivate {
* Gets the DBus path of the #MMObject which implements this interface.
*
* Returns: (transfer none): The DBus path of the #MMObject object.
*
* Since: 1.0
*/
const gchar *
mm_modem_3gpp_get_path (MMModem3gpp *self)
@@ -73,9 +75,13 @@ mm_modem_3gpp_get_path (MMModem3gpp *self)
* mm_modem_3gpp_dup_path:
* @self: A #MMModem3gpp.
*
* Gets a copy of the DBus path of the #MMObject object which implements this interface.
* Gets a copy of the DBus path of the #MMObject object which implements this
* interface.
*
* Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMObject. The returned value
* should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_3gpp_dup_path (MMModem3gpp *self)
@@ -105,6 +111,8 @@ mm_modem_3gpp_dup_path (MMModem3gpp *self)
* thread.</warning>
*
* Returns: (transfer none): The IMEI, or %NULL if none available.
*
* Since: 1.0
*/
const gchar *
mm_modem_3gpp_get_imei (MMModem3gpp *self)
@@ -122,7 +130,10 @@ mm_modem_3gpp_get_imei (MMModem3gpp *self)
* Gets a copy of the <ulink url="http://en.wikipedia.org/wiki/Imei">IMEI</ulink>,
* as reported by this #MMModem3gpp.
*
* Returns: (transfer full): The IMEI, or %NULL if none available. The returned value should be freed with g_free().
* Returns: (transfer full): The IMEI, or %NULL if none available. The returned
* value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_3gpp_dup_imei (MMModem3gpp *self)
@@ -139,8 +150,7 @@ mm_modem_3gpp_dup_imei (MMModem3gpp *self)
* mm_modem_3gpp_get_operator_code:
* @self: A #MMModem3gpp.
*
* Gets the code of the operator to which the mobile is
* currently registered.
* Gets the code of the operator to which the mobile is currently registered.
*
* Returned in the format <literal>"MCCMNC"</literal>, where
* <literal>MCC</literal> is the three-digit ITU E.212 Mobile Country Code
@@ -157,6 +167,8 @@ mm_modem_3gpp_dup_imei (MMModem3gpp *self)
* thread.</warning>
*
* Returns: (transfer none): The operator code, or %NULL if none available.
*
* Since: 1.0
*/
const gchar *
mm_modem_3gpp_get_operator_code (MMModem3gpp *self)
@@ -171,15 +183,18 @@ mm_modem_3gpp_get_operator_code (MMModem3gpp *self)
* mm_modem_3gpp_dup_operator_code:
* @self: A #MMModem3gpp.
*
* Gets a copy of the code of the operator to which the mobile is
* currently registered.
* Gets a copy of the code of the operator to which the mobile is currently
* registered.
*
* Returned in the format <literal>"MCCMNC"</literal>, where
* <literal>MCC</literal> is the three-digit ITU E.212 Mobile Country Code
* and <literal>MNC</literal> is the two- or three-digit GSM Mobile Network
* Code. e.g. e<literal>"31026"</literal> or <literal>"310260"</literal>.
*
* Returns: (transfer full): The operator code, or %NULL if none available. The returned value should be freed with g_free().
* Returns: (transfer full): The operator code, or %NULL if none available.
* The returned value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_3gpp_dup_operator_code (MMModem3gpp *self)
@@ -205,6 +220,8 @@ mm_modem_3gpp_dup_operator_code (MMModem3gpp *self)
* thread.</warning>
*
* Returns: (transfer none): The operator name, or %NULL if none available.
*
* Since: 1.0
*/
const gchar *
mm_modem_3gpp_get_operator_name (MMModem3gpp *self)
@@ -222,7 +239,10 @@ mm_modem_3gpp_get_operator_name (MMModem3gpp *self)
* Gets a copy of the name of the operator to which the mobile is
* currently registered.
*
* Returns: (transfer full): The operator name, or %NULL if none available. The returned value should be freed with g_free().
* Returns: (transfer full): The operator name, or %NULL if none available.
* The returned value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_3gpp_dup_operator_name (MMModem3gpp *self)
@@ -242,7 +262,10 @@ mm_modem_3gpp_dup_operator_name (MMModem3gpp *self)
* Get the the mobile registration status as defined in 3GPP TS 27.007
* section 10.1.19.
*
* Returns: A #MMModem3gppRegistrationState value, specifying the current registration state.
* Returns: A #MMModem3gppRegistrationState value, specifying the current
* registration state.
*
* Since: 1.0
*/
MMModem3gppRegistrationState
mm_modem_3gpp_get_registration_state (MMModem3gpp *self)
@@ -263,15 +286,17 @@ mm_modem_3gpp_get_registration_state (MMModem3gpp *self)
* Get the current subscription status of the account. This value is only
* available after the modem attempts to register with the network.
*
* The value of this property can only be obtained with operator specific logic (e.g.
* processing specific PCO info), and therefore it doesn't make sense to expose it in
* the ModemManager interface.
* The value of this property can only be obtained with operator specific logic
* (e.g. processing specific PCO info), and therefore it doesn't make sense to
* expose it in the ModemManager interface.
*
* Returns: A #MMModem3gppSubscriptionState value, specifying the current subscription state.
* Returns: A #MMModem3gppSubscriptionState value, specifying the current
* subscription state.
*
* Deprecated: 1.10.0. The value of this property can only be obtained with operator
* specific logic (e.g. processing specific PCO info), and therefore it doesn't make sense
* to expose it in the ModemManager interface.
* Since: 1.0
* Deprecated: 1.10.0. The value of this property can only be obtained with
* operator specific logic (e.g. processing specific PCO info), and therefore
* it doesn't make sense to expose it in the ModemManager interface.
*/
MMModem3gppSubscriptionState
mm_modem_3gpp_get_subscription_state (MMModem3gpp *self)
@@ -289,7 +314,10 @@ mm_modem_3gpp_get_subscription_state (MMModem3gpp *self)
*
* Get the list of facilities for which PIN locking is enabled.
*
* Returns: A bitmask of #MMModem3gppFacility flags, specifying which facilities have locks enabled.
* Returns: A bitmask of #MMModem3gppFacility flags, specifying which facilities
* have locks enabled.
*
* Since: 1.0
*/
MMModem3gppFacility
mm_modem_3gpp_get_enabled_facility_locks (MMModem3gpp *self)
@@ -306,6 +334,8 @@ mm_modem_3gpp_get_enabled_facility_locks (MMModem3gpp *self)
* Get the UE mode of operation for EPS.
*
* Returns: A #MMModem3gppEpsUeModeOperation.
*
* Since: 1.8
*/
MMModem3gppEpsUeModeOperation
mm_modem_3gpp_get_eps_ue_mode_operation (MMModem3gpp *self)
@@ -327,6 +357,8 @@ mm_modem_3gpp_get_eps_ue_mode_operation (MMModem3gpp *self)
* mm_pco_list_free().
*
* Returns: (element-type ModemManager.Pco) (transfer full): A list of #MMPco.
*
* Since: 1.10
*/
GList *
mm_modem_3gpp_get_pco (MMModem3gpp *self)
@@ -364,10 +396,13 @@ mm_modem_3gpp_get_pco (MMModem3gpp *self)
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_3gpp_dup_initial_eps_bearer_path() if on another
* thread.</warning>
* @self was constructed. Use mm_modem_3gpp_dup_initial_eps_bearer_path() if on
* another thread.</warning>
*
* Returns: (transfer none): The DBus path of the #MMBearer, or %NULL if none available. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): The DBus path of the #MMBearer, or %NULL if none
* available. Do not free the returned value, it belongs to @self.
*
* Since: 1.10
*/
const gchar *
mm_modem_3gpp_get_initial_eps_bearer_path (MMModem3gpp *self)
@@ -381,9 +416,13 @@ mm_modem_3gpp_get_initial_eps_bearer_path (MMModem3gpp *self)
* mm_modem_3gpp_dup_initial_eps_bearer_path:
* @self: A #MMModem3gpp.
*
* Gets a copy of the DBus path of the initial EPS #MMBearer exposed in this #MMModem3gpp.
* Gets a copy of the DBus path of the initial EPS #MMBearer exposed in this
* #MMModem3gpp.
*
* Returns: (transfer full): The DBus path of the #MMBearer, or %NULL if none available. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMBearer, or %NULL if none
* available. The returned value should be freed with g_free().
*
* Since: 1.10
*/
gchar *
mm_modem_3gpp_dup_initial_eps_bearer_path (MMModem3gpp *self)
@@ -399,12 +438,15 @@ mm_modem_3gpp_dup_initial_eps_bearer_path (MMModem3gpp *self)
/**
* mm_modem_3gpp_register_finish:
* @self: A #MMModem3gpp.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_3gpp_register().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_3gpp_register().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_3gpp_register().
*
* Returns: %TRUE if the modem was registered, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_3gpp_register_finish (MMModem3gpp *self,
@@ -419,17 +461,24 @@ mm_modem_3gpp_register_finish (MMModem3gpp *self,
/**
* mm_modem_3gpp_register:
* @self: A #MMModem3gpp.
* @network_id: The operator ID to register. An empty string can be used to register to the home network.
* @network_id: The operator ID to register. An empty string can be used to
* register to the home network.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests registration with a given mobile network.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_3gpp_register_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_3gpp_register_finish() to get the result of the operation.
*
* See mm_modem_3gpp_register_sync() for the synchronous, blocking version of this method.
* See mm_modem_3gpp_register_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.0
*/
void
mm_modem_3gpp_register (MMModem3gpp *self,
@@ -446,16 +495,19 @@ mm_modem_3gpp_register (MMModem3gpp *self,
/**
* mm_modem_3gpp_register_sync:
* @self: A #MMModem3gpp.
* @network_id: The operator ID to register. An empty string can be used to register to the home network.
* @network_id: The operator ID to register. An empty string can be used to
* register to the home network.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Synchronously requests registration with a given mobile network.
*
* The calling thread is blocked until a reply is received. See mm_modem_3gpp_register()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_3gpp_register() for the asynchronous version of this method.
*
* Returns: %TRUE if the modem was registered, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_3gpp_register_sync (MMModem3gpp *self,
@@ -483,6 +535,8 @@ struct _MMModem3gppNetwork {
* @network: A #MMModem3gppNetwork.
*
* Frees a #MMModem3gppNetwork.
*
* Since: 1.0
*/
void
mm_modem_3gpp_network_free (MMModem3gppNetwork *network)
@@ -503,6 +557,8 @@ mm_modem_3gpp_network_free (MMModem3gppNetwork *network)
* Get availability of the 3GPP network.
*
* Returns: A #MMModem3gppNetworkAvailability.
*
* Since: 1.0
*/
MMModem3gppNetworkAvailability
mm_modem_3gpp_network_get_availability (const MMModem3gppNetwork *network)
@@ -519,6 +575,8 @@ mm_modem_3gpp_network_get_availability (const MMModem3gppNetwork *network)
* Get the long operator name of the 3GPP network.
*
* Returns: (transfer none): The long operator name, or %NULL if none available.
*
* Since: 1.0
*/
const gchar *
mm_modem_3gpp_network_get_operator_long (const MMModem3gppNetwork *network)
@@ -535,6 +593,8 @@ mm_modem_3gpp_network_get_operator_long (const MMModem3gppNetwork *network)
* Get the short operator name of the 3GPP network.
*
* Returns: (transfer none): The long operator name, or %NULL if none available.
*
* Since: 1.0
*/
const gchar *
mm_modem_3gpp_network_get_operator_short (const MMModem3gppNetwork *network)
@@ -551,6 +611,8 @@ mm_modem_3gpp_network_get_operator_short (const MMModem3gppNetwork *network)
* Get the operator code (MCCMNC) of the 3GPP network.
*
* Returns: (transfer none): The operator code, or %NULL if none available.
*
* Since: 1.0
*/
const gchar *
mm_modem_3gpp_network_get_operator_code (const MMModem3gppNetwork *network)
@@ -567,6 +629,8 @@ mm_modem_3gpp_network_get_operator_code (const MMModem3gppNetwork *network)
* Get the technology used to access the 3GPP network.
*
* Returns: A #MMModemAccessTechnology.
*
* Since: 1.0
*/
MMModemAccessTechnology
mm_modem_3gpp_network_get_access_technology (const MMModem3gppNetwork *network)
@@ -648,10 +712,13 @@ ensure_internal_initial_eps_bearer_settings (MMModem3gpp *self,
*
* <warning>The values reported by @self are not updated when the values in the
* interface change. Instead, the client is expected to call
* mm_modem_3gpp_get_initial_eps_bearer_settings() again to get a new #MMBearerProperties with the
* new values.</warning>
* mm_modem_3gpp_get_initial_eps_bearer_settings() again to get a new
* #MMBearerProperties with the new values.</warning>
*
* Returns: (transfer full): A #MMBearerProperties that must be freed with g_object_unref() or %NULL if unknown.
* Returns: (transfer full): A #MMBearerProperties that must be freed with
* g_object_unref() or %NULL if unknown.
*
* Since: 1.10
*/
MMBearerProperties *
mm_modem_3gpp_get_initial_eps_bearer_settings (MMModem3gpp *self)
@@ -673,10 +740,13 @@ mm_modem_3gpp_get_initial_eps_bearer_settings (MMModem3gpp *self)
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_3gpp_get_initial_eps_bearer_settings() if on another
* thread.</warning>
* @self was constructed. Use mm_modem_3gpp_get_initial_eps_bearer_settings()
* if on another thread.</warning>
*
* Returns: (transfer none): A #MMBearerProperties. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): A #MMBearerProperties. Do not free the returned
* value, it belongs to @self.
*
* Since: 1.10
*/
MMBearerProperties *
mm_modem_3gpp_peek_initial_eps_bearer_settings (MMModem3gpp *self)
@@ -738,12 +808,18 @@ create_networks_list (GVariant *variant)
/**
* mm_modem_3gpp_scan_finish:
* @self: A #MMModem3gpp.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_3gpp_scan().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_3gpp_scan().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_3gpp_scan().
*
* Returns: (transfer full) (element-type ModemManager.Modem3gppNetwork): a list of #MMModem3gppNetwork structs, or #NULL if @error is set. The returned value should be freed with g_list_free_full() using mm_modem_3gpp_network_free() as #GDestroyNotify function.
* Returns: (transfer full) (element-type ModemManager.Modem3gppNetwork): a list
* of #MMModem3gppNetwork structs, or #NULL if @error is set. The returned value
* should be freed with g_list_free_full() using mm_modem_3gpp_network_free() as
* #GDestroyNotify function.
*
* Since: 1.0
*/
GList *
mm_modem_3gpp_scan_finish (MMModem3gpp *self,
@@ -764,15 +840,21 @@ mm_modem_3gpp_scan_finish (MMModem3gpp *self,
* mm_modem_3gpp_scan:
* @self: A #MMModem3gpp.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to scan available 3GPP networks.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_3gpp_scan_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_3gpp_scan_finish() to get the result of the operation.
*
* See mm_modem_3gpp_scan_sync() for the synchronous, blocking version of this method.
* See mm_modem_3gpp_scan_sync() for the synchronous, blocking version of this
* method.
*
* Since: 1.0
*/
void
mm_modem_3gpp_scan (MMModem3gpp *self,
@@ -793,10 +875,15 @@ mm_modem_3gpp_scan (MMModem3gpp *self,
*
* Synchronously requests to scan available 3GPP networks.
*
* The calling thread is blocked until a reply is received. See mm_modem_3gpp_scan()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_3gpp_scan() for the asynchronous version of this method.
*
* Returns: (transfer full) (element-type ModemManager.Modem3gppNetwork): a list of #MMModem3gppNetwork structs, or #NULL if @error is set. The returned value should be freed with g_list_free_full() using mm_modem_3gpp_network_free() as #GDestroyNotify function.
* Returns: (transfer full) (element-type ModemManager.Modem3gppNetwork): a list
* of #MMModem3gppNetwork structs, or #NULL if @error is set. The returned value
* should be freed with g_list_free_full() using mm_modem_3gpp_network_free() as
* #GDestroyNotify function.
*
* Since: 1.0
*/
GList *
mm_modem_3gpp_scan_sync (MMModem3gpp *self,
@@ -818,12 +905,15 @@ mm_modem_3gpp_scan_sync (MMModem3gpp *self,
/**
* mm_modem_3gpp_set_eps_ue_mode_operation_finish:
* @self: A #MMModem3gpp.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_3gpp_set_eps_ue_mode_operation().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_3gpp_set_eps_ue_mode_operation().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_3gpp_set_eps_ue_mode_operation().
*
* Returns: %TRUE if the operation was successful, %FALSE if @error is set.
*
* Since: 1.8
*/
gboolean
mm_modem_3gpp_set_eps_ue_mode_operation_finish (MMModem3gpp *self,
@@ -840,7 +930,8 @@ mm_modem_3gpp_set_eps_ue_mode_operation_finish (MMModem3gpp *self,
* @self: A #MMModem3gpp.
* @mode: A #MMModem3gppEpsUeModeOperation.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to update the EPS UE mode of operation.
@@ -848,10 +939,14 @@ mm_modem_3gpp_set_eps_ue_mode_operation_finish (MMModem3gpp *self,
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_3gpp_set_eps_ue_mode_operation_finish() to get the result of the operation.
* mm_modem_3gpp_set_eps_ue_mode_operation_finish() to get the result of the
* operation.
*
* See mm_modem_3gpp_set_eps_ue_mode_operation_sync() for the synchronous, blocking
* version of this method. The calling thread is blocked until a reply is received.
* See mm_modem_3gpp_set_eps_ue_mode_operation_sync() for the synchronous,
* blocking version of this method. The calling thread is blocked until a reply
* is received.
*
* Since: 1.8
*/
void
mm_modem_3gpp_set_eps_ue_mode_operation (MMModem3gpp *self,
@@ -880,6 +975,8 @@ mm_modem_3gpp_set_eps_ue_mode_operation (MMModem3gpp *self,
* of this method.
*
* Returns: %TRUE if the operation was successful, %FALSE if @error is set.
*
* Since: 1.8
*/
gboolean
mm_modem_3gpp_set_eps_ue_mode_operation_sync (MMModem3gpp *self,
@@ -898,12 +995,16 @@ mm_modem_3gpp_set_eps_ue_mode_operation_sync (MMModem3gpp *se
/**
* mm_modem_3gpp_get_initial_eps_bearer_finish:
* @self: A #MMModem3gpp.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_3gpp_get_initial_eps_bearer().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_3gpp_get_initial_eps_bearer().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_3gpp_get_initial_eps_bearer().
*
* Returns: (transfer full): a #MMSim or #NULL if @error is set. The returned value should be freed with g_object_unref().
* Returns: (transfer full): a #MMSim or #NULL if @error is set. The returned
* value should be freed with g_object_unref().
*
* Since: 1.10
*/
MMBearer *
mm_modem_3gpp_get_initial_eps_bearer_finish (MMModem3gpp *self,
@@ -940,15 +1041,23 @@ modem_3gpp_get_initial_eps_bearer_ready (GDBusConnection *connection,
* mm_modem_3gpp_get_initial_eps_bearer:
* @self: A #MMModem3gpp.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously gets the initial EPS #MMBearer object exposed by this #MMModem3gpp.
* Asynchronously gets the initial EPS #MMBearer object exposed by this
* #MMModem3gpp.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_3gpp_get_initial_eps_bearer_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_3gpp_get_initial_eps_bearer_finish() to get the result of the
* operation.
*
* See mm_modem_3gpp_get_initial_eps_bearer_sync() for the synchronous, blocking version of this method.
* See mm_modem_3gpp_get_initial_eps_bearer_sync() for the synchronous, blocking
* version of this method.
*
* Since: 1.10
*/
void
mm_modem_3gpp_get_initial_eps_bearer (MMModem3gpp *self,
@@ -992,12 +1101,17 @@ mm_modem_3gpp_get_initial_eps_bearer (MMModem3gpp *self,
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Synchronously gets the initial EPS #MMBearer object exposed by this #MMModem3gpp.
* Synchronously gets the initial EPS #MMBearer object exposed by this
* #MMModem3gpp.
*
* The calling thread is blocked until a reply is received. See mm_modem_3gpp_get_initial_eps_bearer()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_3gpp_get_initial_eps_bearer() for the asynchronous version of this
* method.
*
* Returns: (transfer full): a #MMBearer or #NULL if @error is set. The returned value should be freed with g_object_unref().
* Returns: (transfer full): a #MMBearer or #NULL if @error is set. The returned
* value should be freed with g_object_unref().
*
* Since: 1.10
*/
MMBearer *
mm_modem_3gpp_get_initial_eps_bearer_sync (MMModem3gpp *self,
@@ -1036,12 +1150,16 @@ mm_modem_3gpp_get_initial_eps_bearer_sync (MMModem3gpp *self,
/**
* mm_modem_3gpp_set_initial_eps_bearer_settings_finish:
* @self: A #MMModem3gpp.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_3gpp_set_initial_eps_bearer_settings().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_3gpp_set_initial_eps_bearer_settings().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_3gpp_set_initial_eps_bearer_settings().
* Finishes an operation started with
* mm_modem_3gpp_set_initial_eps_bearer_settings().
*
* Returns: %TRUE if the operation was successful, %FALSE if @error is set.
*
* Since: 1.10
*/
gboolean
mm_modem_3gpp_set_initial_eps_bearer_settings_finish (MMModem3gpp *self,
@@ -1056,7 +1174,8 @@ mm_modem_3gpp_set_initial_eps_bearer_settings_finish (MMModem3gpp *self,
* @self: A #MMModem3gpp.
* @config: A #MMBearerProperties object with the properties to use.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously configures the settings for the initial LTE default bearer.
@@ -1064,7 +1183,10 @@ mm_modem_3gpp_set_initial_eps_bearer_settings_finish (MMModem3gpp *self,
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_3gpp_set_initial_eps_bearer_settings_finish() to get the result of the operation.
* mm_modem_3gpp_set_initial_eps_bearer_settings_finish() to get the result of
* the operation.
*
* Since: 1.10
*/
void
mm_modem_3gpp_set_initial_eps_bearer_settings (MMModem3gpp *self,
@@ -1098,6 +1220,8 @@ mm_modem_3gpp_set_initial_eps_bearer_settings (MMModem3gpp *self,
* version of this method.
*
* Returns: %TRUE if the operation was successful, %FALSE if @error is set.
*
* Since: 1.10
*/
gboolean
mm_modem_3gpp_set_initial_eps_bearer_settings_sync (MMModem3gpp *self,

117
libmm-glib/mm-modem-cdma.c
View File

@@ -50,6 +50,8 @@ G_DEFINE_TYPE (MMModemCdma, mm_modem_cdma, MM_GDBUS_TYPE_MODEM_CDMA_PROXY)
* Gets the DBus path of the #MMObject which implements this interface.
*
* Returns: (transfer none): The DBus path of the #MMObject object.
*
* Since: 1.0
*/
const gchar *
mm_modem_cdma_get_path (MMModemCdma *self)
@@ -64,9 +66,13 @@ mm_modem_cdma_get_path (MMModemCdma *self)
* mm_modem_cdma_dup_path:
* @self: A #MMModemCdma.
*
* Gets a copy of the DBus path of the #MMObject object which implements this interface.
* Gets a copy of the DBus path of the #MMObject object which implements this
* interface.
*
* Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMObject. The returned value
* should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_cdma_dup_path (MMModemCdma *self)
@@ -87,15 +93,17 @@ mm_modem_cdma_dup_path (MMModemCdma *self)
* mm_modem_cdma_get_meid:
* @self: A #MMModemCdma.
*
* Gets the <ulink url="http://en.wikipedia.org/wiki/MEID">Mobile Equipment Identifier</ulink>,
* Gets the
* <ulink url="http://en.wikipedia.org/wiki/MEID">Mobile Equipment Identifier</ulink>,
* as reported by this #MMModemCdma.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_cdma_dup_meid() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_modem_cdma_dup_meid() if on another thread.</warning>
*
* Returns: (transfer none): The MEID, or %NULL if none available.
*
* Since: 1.0
*/
const gchar *
mm_modem_cdma_get_meid (MMModemCdma *self)
@@ -110,10 +118,14 @@ mm_modem_cdma_get_meid (MMModemCdma *self)
* mm_modem_cdma_dup_meid:
* @self: A #MMModemCdma.
*
* Gets a copy of the <ulink url="http://en.wikipedia.org/wiki/MEID">Mobile Equipment Identifier</ulink>,
* Gets a copy of the
* <ulink url="http://en.wikipedia.org/wiki/MEID">Mobile Equipment Identifier</ulink>,
* as reported by this #MMModemCdma.
*
* Returns: (transfer full): The MEID, or %NULL if none available. The returned value should be freed with g_free().
* Returns: (transfer full): The MEID, or %NULL if none available. The returned
* value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_cdma_dup_meid (MMModemCdma *self)
@@ -130,17 +142,19 @@ mm_modem_cdma_dup_meid (MMModemCdma *self)
* mm_modem_cdma_get_esn:
* @self: A #MMModemCdma.
*
* Gets the <ulink url="http://en.wikipedia.org/wiki/Electronic_serial_number">Electronic Serial Number</ulink>,
* Gets the
* <ulink url="http://en.wikipedia.org/wiki/Electronic_serial_number">Electronic Serial Number</ulink>,
* as reported by this #MMModemCdma.
*
* The ESN is superceded by MEID, but still used in older devices.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_cdma_dup_esn() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_modem_cdma_dup_esn() if on another thread.</warning>
*
* Returns: (transfer none): The ESN, or %NULL if none available.
*
* Since: 1.0
*/
const gchar *
mm_modem_cdma_get_esn (MMModemCdma *self)
@@ -155,12 +169,16 @@ mm_modem_cdma_get_esn (MMModemCdma *self)
* mm_modem_cdma_dup_esn:
* @self: A #MMModemCdma.
*
* Gets a copy of the <ulink url="http://en.wikipedia.org/wiki/Electronic_serial_number">Electronic Serial Number</ulink>,
* Gets a copy of the
* <ulink url="http://en.wikipedia.org/wiki/Electronic_serial_number">Electronic Serial Number</ulink>,
* as reported by this #MMModemCdma.
*
* The ESN is superceded by MEID, but still used in older devices.
*
* Returns: (transfer full): The ESN, or %NULL if none available. The returned value should be freed with g_free().
* Returns: (transfer full): The ESN, or %NULL if none available. The returned
* value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_cdma_dup_esn (MMModemCdma *self)
@@ -177,11 +195,14 @@ mm_modem_cdma_dup_esn (MMModemCdma *self)
* mm_modem_cdma_get_sid:
* @self: A #MMModemCdma.
*
* Gets the <ulink url="http://en.wikipedia.org/wiki/System_Identification_Number">System Identifier</ulink>
* Gets the
* <ulink url="http://en.wikipedia.org/wiki/System_Identification_Number">System Identifier</ulink>
* of the serving CDMA 1x network, if known, and if the modem is registered with
* a CDMA 1x network.
*
* Returns: The SID, or %MM_MODEM_CDMA_SID_UNKNOWN.
*
* Since: 1.0
*/
guint
mm_modem_cdma_get_sid (MMModemCdma *self)
@@ -197,11 +218,14 @@ mm_modem_cdma_get_sid (MMModemCdma *self)
* mm_modem_cdma_get_nid:
* @self: A #MMModemCdma.
*
* Gets the <ulink url="http://en.wikipedia.org/wiki/Network_Identification_Number">Network Identifier</ulink>
* Gets the
* <ulink url="http://en.wikipedia.org/wiki/Network_Identification_Number">Network Identifier</ulink>
* of the serving CDMA 1x network, if known, and if the modem is registered with
* a CDMA 1x network.
*
* Returns: The NID, or %MM_MODEM_CDMA_NID_UNKNOWN.
*
* Since: 1.0
*/
guint
mm_modem_cdma_get_nid (MMModemCdma *self)
@@ -220,6 +244,8 @@ mm_modem_cdma_get_nid (MMModemCdma *self)
* Gets the state of the registration in the CDMA 1x network.
*
* Returns: a #MMModemCdmaRegistrationState.
*
* Since: 1.0
*/
MMModemCdmaRegistrationState
mm_modem_cdma_get_cdma1x_registration_state (MMModemCdma *self)
@@ -236,6 +262,8 @@ mm_modem_cdma_get_cdma1x_registration_state (MMModemCdma *self)
* Gets the state of the registration in the EV-DO network.
*
* Returns: a #MMModemCdmaRegistrationState.
*
* Since: 1.0
*/
MMModemCdmaRegistrationState
mm_modem_cdma_get_evdo_registration_state (MMModemCdma *self)
@@ -254,6 +282,8 @@ mm_modem_cdma_get_evdo_registration_state (MMModemCdma *self)
* Gets the state of the activation in the 3GPP2 network.
*
* Returns: a #MMModemCdmaActivationState.
*
* Since: 1.0
*/
MMModemCdmaActivationState
mm_modem_cdma_get_activation_state (MMModemCdma *self)
@@ -268,12 +298,15 @@ mm_modem_cdma_get_activation_state (MMModemCdma *self)
/**
* mm_modem_cdma_activate_finish:
* @self: A #MMModemCdma.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_cdma_activate().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_cdma_activate().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_cdma_activate().
*
* Returns: %TRUE if the activation was successful, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_cdma_activate_finish (MMModemCdma *self,
@@ -290,16 +323,22 @@ mm_modem_cdma_activate_finish (MMModemCdma *self,
* @self: A #MMModemCdma.
* @carrier: Name of the carrier.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to provision the modem for use with a given carrier
* using the modem's OTA activation functionality, if any.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_cdma_activate_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_cdma_activate_finish() to get the result of the operation.
*
* See mm_modem_cdma_activate_sync() for the synchronous, blocking version of this method.
* See mm_modem_cdma_activate_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.0
*/
void
mm_modem_cdma_activate (MMModemCdma *self,
@@ -323,10 +362,12 @@ mm_modem_cdma_activate (MMModemCdma *self,
* Synchronously requests to provision the modem for use with a given carrier
* using the modem's OTA activation functionality, if any.
*
* The calling thread is blocked until a reply is received. See mm_modem_cdma_activate()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_cdma_activate() for the asynchronous version of this method.
*
* Returns: %TRUE if the activation was successful, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_cdma_activate_sync (MMModemCdma *self,
@@ -344,12 +385,15 @@ mm_modem_cdma_activate_sync (MMModemCdma *self,
/**
* mm_modem_cdma_activate_manual_finish:
* @self: A #MMModemCdma.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_cdma_activate_manual().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_cdma_activate_manual().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_cdma_activate_manual().
*
* Returns: %TRUE if the activation was successful, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_cdma_activate_manual_finish (MMModemCdma *self,
@@ -366,15 +410,22 @@ mm_modem_cdma_activate_manual_finish (MMModemCdma *self,
* @self: A #MMModemCdma.
* @properties: A #MMCdmaManualActivationProperties.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to provision the modem with the given properties.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_cdma_activate_manual_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from.
* You can then call mm_modem_cdma_activate_manual_finish() to get the result of
* the operation.
*
* See mm_modem_cdma_activate_manual_sync() for the synchronous, blocking version of this method.
* See mm_modem_cdma_activate_manual_sync() for the synchronous, blocking
* version of this method.
*
* Since: 1.0
*/
void
mm_modem_cdma_activate_manual (MMModemCdma *self,
@@ -405,10 +456,12 @@ mm_modem_cdma_activate_manual (MMModemCdma *self,
*
* Synchronously requests to provision the modem with the given properties.
*
* The calling thread is blocked until a reply is received. See mm_modem_cdma_activate_manual()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_cdma_activate_manual() for the asynchronous version of this method.
*
* Returns: %TRUE if the activation was successful, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_cdma_activate_manual_sync (MMModemCdma *self,

92
libmm-glib/mm-modem-firmware.c
View File

@@ -55,6 +55,8 @@ struct _MMModemFirmwarePrivate {
* Gets the DBus path of the #MMObject which implements this interface.
*
* Returns: (transfer none): The DBus path of the #MMObject object.
*
* Since: 1.0
*/
const gchar *
mm_modem_firmware_get_path (MMModemFirmware *self)
@@ -69,9 +71,13 @@ mm_modem_firmware_get_path (MMModemFirmware *self)
* mm_modem_firmware_dup_path:
* @self: A #MMModemFirmware.
*
* Gets a copy of the DBus path of the #MMObject object which implements this interface.
* Gets a copy of the DBus path of the #MMObject object which implements this
* interface.
*
* Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMObject. The returned value
* should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_firmware_dup_path (MMModemFirmware *self)
@@ -157,10 +163,13 @@ ensure_internal_update_settings (MMModemFirmware *self,
*
* <warning>The values reported by @self are not updated when the values in the
* interface change. Instead, the client is expected to call
* mm_modem_firmware_get_update_settings() again to get a new #MMFirmwareUpdateSettings
* with the new values.</warning>
* mm_modem_firmware_get_update_settings() again to get a new
* #MMFirmwareUpdateSettings with the new values.</warning>
*
* Returns: (transfer full): A #MMFirmwareUpdateSettings that must be freed with g_object_unref() or %NULL if unknown.
* Returns: (transfer full): A #MMFirmwareUpdateSettings that must be freed with
* g_object_unref() or %NULL if unknown.
*
* Since: 1.10
*/
MMFirmwareUpdateSettings *
mm_modem_firmware_get_update_settings (MMModemFirmware *self)
@@ -185,7 +194,10 @@ mm_modem_firmware_get_update_settings (MMModemFirmware *self)
* @self was constructed. Use mm_modem_firmware_get_update_settings() if on
* another thread.</warning>
*
* Returns: (transfer none): A #MMFirmwareUpdateSettings. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): A #MMFirmwareUpdateSettings. Do not free the
* returned value, it belongs to @self.
*
* Since: 1.10
*/
MMFirmwareUpdateSettings *
mm_modem_firmware_peek_update_settings (MMModemFirmware *self)
@@ -201,12 +213,15 @@ mm_modem_firmware_peek_update_settings (MMModemFirmware *self)
/**
* mm_modem_firmware_select_finish:
* @self: A #MMModemFirmware.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_firmware_select().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_firmware_select().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_firmware_select().
*
* Returns: %TRUE if the selection was successful, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_firmware_select_finish (MMModemFirmware *self,
@@ -223,7 +238,8 @@ mm_modem_firmware_select_finish (MMModemFirmware *self,
* @self: A #MMModemFirmware.
* @unique_id: Unique ID of the firmware image to select.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously selects a firmware image to boot.
@@ -231,10 +247,15 @@ mm_modem_firmware_select_finish (MMModemFirmware *self,
* <warning>The modem will possibly disappear once this action is run, as it
* needs to reboot in order to select the new image.</warning>
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_firmware_select_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_firmware_select_finish() to get the result of the operation.
*
* See mm_modem_firmware_select_sync() for the synchronous, blocking version of this method.
* See mm_modem_firmware_select_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.0
*/
void
mm_modem_firmware_select (MMModemFirmware *self,
@@ -261,10 +282,12 @@ mm_modem_firmware_select (MMModemFirmware *self,
* <warning>The modem will possibly disappear once this action is run, as it
* needs to reboot in order to select the new image.</warning>
*
* The calling thread is blocked until a reply is received. See mm_modem_firmware_select()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_firmware_select() for the asynchronous version of this method.
*
* Returns: %TRUE if the selection was successful, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_firmware_select_sync (MMModemFirmware *self,
@@ -360,14 +383,22 @@ build_results (const gchar *str_selected,
/**
* mm_modem_firmware_list_finish:
* @self: A #MMModemFirmware.
* @selected: (out) (allow-none) (transfer full): The selected firmware slot, or NULL if no slot is selected (such as if all slots are empty, or no slots exist). The returned value should be freed with g_object_unref().
* @installed: (out) (allow-none) (transfer full) (element-type ModemManager.FirmwareProperties): A list of #MMFirmwareProperties objects specifying the installed images. The returned value should be freed with g_list_free_full() using g_object_unref() as #GDestroyNotify.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_firmware_list().
* @selected: (out) (allow-none) (transfer full): The selected firmware slot, or
* %NULL if no slot is selected (such as if all slots are empty, or no slots
* exist). The returned value should be freed with g_object_unref().
* @installed: (out) (allow-none) (transfer full) (element-type ModemManager.FirmwareProperties):
* A list of #MMFirmwareProperties objects specifying the installed images. The
* returned value should be freed with g_list_free_full() using
* g_object_unref() as #GDestroyNotify.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_firmware_list().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_firmware_list().
*
* Returns: %TRUE if the list was correctly retrieved, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_firmware_list_finish (MMModemFirmware *self,
@@ -409,15 +440,21 @@ mm_modem_firmware_list_finish (MMModemFirmware *self,
* mm_modem_firmware_list:
* @self: A #MMModemFirmware.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously gets the list of available firmware images.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_firmware_list_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_firmware_list_finish() to get the result of the operation.
*
* See mm_modem_firmware_list_sync() for the synchronous, blocking version of this method.
* See mm_modem_firmware_list_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.0
*/
void
mm_modem_firmware_list (MMModemFirmware *self,
@@ -436,17 +473,24 @@ mm_modem_firmware_list (MMModemFirmware *self,
/**
* mm_modem_firmware_list_sync:
* @self: A #MMModemFirmware.
* @selected: (out) (allow-none) (transfer full): The selected firmware slot, or NULL if no slot is selected (such as if all slots are empty, or no slots exist). The returned value should be freed with g_object_unref().
* @installed: (out) (allow-none) (transfer full) (element-type ModemManager.FirmwareProperties): A list of #MMFirmwareProperties objects specifying the installed images. The returned value should be freed with g_list_free_full() using g_object_unref() as #GDestroyNotify.
* @selected: (out) (allow-none) (transfer full): The selected firmware slot,
* or NULL if no slot is selected (such as if all slots are empty, or no slots
* exist). The returned value should be freed with g_object_unref().
* @installed: (out) (allow-none) (transfer full) (element-type ModemManager.FirmwareProperties):
* A list of #MMFirmwareProperties objects specifying the installed images. The
* returned value should be freed with g_list_free_full() using
* g_object_unref() as #GDestroyNotify.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return firmware for error or %NULL.
*
* Synchronously gets the list of available firmware images.
*
* The calling thread is blocked until a reply is received. See mm_modem_firmware_list()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_firmware_list() for the asynchronous version of this method.
*
* Returns: %TRUE if the list was correctly retrieved, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_firmware_list_sync (MMModemFirmware *self,

368
libmm-glib/mm-modem-location.c
View File

@@ -49,6 +49,8 @@ G_DEFINE_TYPE (MMModemLocation, mm_modem_location, MM_GDBUS_TYPE_MODEM_LOCATION_
* Gets the DBus path of the #MMObject which implements this interface.
*
* Returns: (transfer none): The DBus path of the #MMObject object.
*
* Since: 1.0
*/
const gchar *
mm_modem_location_get_path (MMModemLocation *self)
@@ -63,9 +65,13 @@ mm_modem_location_get_path (MMModemLocation *self)
* mm_modem_location_dup_path:
* @self: A #MMModemLocation.
*
* Gets a copy of the DBus path of the #MMObject object which implements this interface.
* Gets a copy of the DBus path of the #MMObject object which implements this
* interface.
*
* Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMObject. The returned value
* should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_location_dup_path (MMModemLocation *self)
@@ -86,9 +92,12 @@ mm_modem_location_dup_path (MMModemLocation *self)
* mm_modem_location_get_capabilities:
* @self: A #MMModemLocation.
*
* Gets a bitmask of the location capabilities supported by this #MMModemLocation.
* Gets a bitmask of the location capabilities supported by this
* #MMModemLocation.
*
* Returns: A #MMModemLocationSource.
*
* Since: 1.0
*/
MMModemLocationSource
mm_modem_location_get_capabilities (MMModemLocation *self)
@@ -107,6 +116,8 @@ mm_modem_location_get_capabilities (MMModemLocation *self)
* Gets a bitmask of the supported assistance data types.
*
* Returns: A #MMModemLocationAssistanceDataType.
*
* Since: 1.10
*/
MMModemLocationAssistanceDataType
mm_modem_location_get_supported_assistance_data (MMModemLocation *self)
@@ -125,6 +136,8 @@ mm_modem_location_get_supported_assistance_data (MMModemLocation *self)
* Gets a bitmask of the location capabilities which are enabled in this #MMModemLocation.
*
* Returns: A #MMModemLocationSource.
*
* Since: 1.0
*/
MMModemLocationSource
mm_modem_location_get_enabled (MMModemLocation *self)
@@ -142,7 +155,9 @@ mm_modem_location_get_enabled (MMModemLocation *self)
*
* Gets the status of the location signaling in the #MMModemLocation.
*
* Returns: %TRUE if location changes are signaled, %FALSE otherwise..
* Returns: %TRUE if location changes are signaled, %FALSE otherwise.
*
* Since: 1.0
*/
gboolean
mm_modem_location_signals_location (MMModemLocation *self)
@@ -163,6 +178,8 @@ mm_modem_location_signals_location (MMModemLocation *self)
* Finishes an operation started with mm_modem_location_setup().
*
* Returns: %TRUE if the setup was successful, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_location_setup_finish (MMModemLocation *self,
@@ -177,19 +194,26 @@ mm_modem_location_setup_finish (MMModemLocation *self,
/**
* mm_modem_location_setup:
* @self: A #MMModemLocation.
* @sources: Bitmask of #MMModemLocationSource values specifying which locations should get enabled.
* @sources: Bitmask of #MMModemLocationSource values specifying which locations
* should get enabled.
* @signal_location: Flag to enable or disable location signaling.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously configures the location sources to use when gathering location
* information. Also enable or disable location information gathering.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_location_setup_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_location_setup_finish() to get the result of the operation.
*
* See mm_modem_location_setup_sync() for the synchronous, blocking version of this method.
* See mm_modem_location_setup_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.0
*/
void
mm_modem_location_setup (MMModemLocation *self,
@@ -212,7 +236,8 @@ mm_modem_location_setup (MMModemLocation *self,
/**
* mm_modem_location_setup_sync:
* @self: A #MMModemLocation.
* @sources: Bitmask of #MMModemLocationSource values specifying which locations should get enabled.
* @sources: Bitmask of #MMModemLocationSource values specifying which locations
* should get enabled.
* @signal_location: Flag to enable or disable location signaling.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
@@ -220,10 +245,12 @@ mm_modem_location_setup (MMModemLocation *self,
* Synchronously configures the location sources to use when gathering location
* information. Also enable or disable location information gathering.
*
* The calling thread is blocked until a reply is received. See mm_modem_location_setup()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_location_setup() for the asynchronous version of this method.
*
* Returns: %TRUE if the setup was successful, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_location_setup_sync (MMModemLocation *self,
@@ -246,12 +273,16 @@ mm_modem_location_setup_sync (MMModemLocation *self,
/**
* mm_modem_location_set_supl_server_finish:
* @self: A #MMModemLocation.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_location_set_supl_server().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_location_set_supl_server().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_location_set_supl_server().
*
* Returns: %TRUE if setting the SUPL server was successful, %FALSE if @error is set.
* Returns: %TRUE if setting the SUPL server was successful, %FALSE if @error is
* set.
*
* Since: 1.6
*/
gboolean
mm_modem_location_set_supl_server_finish (MMModemLocation *self,
@@ -268,15 +299,21 @@ mm_modem_location_set_supl_server_finish (MMModemLocation *self,
* @self: A #MMModemLocation.
* @supl: The SUPL server address, given as IP:PORT or with a full URL.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously configures the address of the SUPL server for A-GPS operation.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_location_set_supl_server_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_location_set_supl_server_finish() to get the result of the operation.
*
* See mm_modem_location_set_supl_server_sync() for the synchronous, blocking version of this method.
* See mm_modem_location_set_supl_server_sync() for the synchronous, blocking
* version of this method.
*
* Since: 1.6
*/
void
mm_modem_location_set_supl_server (MMModemLocation *self,
@@ -303,10 +340,14 @@ mm_modem_location_set_supl_server (MMModemLocation *self,
*
* Synchronously configures the address of the SUPL server for A-GPS operation.
*
* The calling thread is blocked until a reply is received. See mm_modem_location_set_supl_server()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_location_set_supl_server() for the asynchronous version of this
* method.
*
* Returns: %TRUE if setting the SUPL server was successful, %FALSE if @error is set.
* Returns: %TRUE if setting the SUPL server was successful, %FALSE if @error is
* set.
*
* Since: 1.6
*/
gboolean
mm_modem_location_set_supl_server_sync (MMModemLocation *self,
@@ -327,12 +368,16 @@ mm_modem_location_set_supl_server_sync (MMModemLocation *self,
/**
* mm_modem_location_inject_assistance_data_finish:
* @self: A #MMModemLocation.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_location_inject_assistance_data().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_location_inject_assistance_data().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_location_inject_assistance_data().
* Finishes an operation started with
* mm_modem_location_inject_assistance_data().
*
* Returns: %TRUE if the injection was successful, %FALSE if @error is set.
*
* Since: 1.10
*/
gboolean
mm_modem_location_inject_assistance_data_finish (MMModemLocation *self,
@@ -350,15 +395,22 @@ mm_modem_location_inject_assistance_data_finish (MMModemLocation *self,
* @data: (array length=data_size): Data to inject.
* @data_size: size of @data.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Aynchronously injects assistance data to the GNSS module.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_location_inject_assistance_data_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_location_inject_assistance_data_finish() to get the result of the
* operation.
*
* See mm_modem_location_inject_assistance_data_sync() for the synchronous, blocking version of this method.
* See mm_modem_location_inject_assistance_data_sync() for the synchronous,
* blocking version of this method.
*
* Since: 1.10
*/
void
mm_modem_location_inject_assistance_data (MMModemLocation *self,
@@ -387,10 +439,13 @@ mm_modem_location_inject_assistance_data (MMModemLocation *self,
*
* Synchronously injects assistance data to the GNSS module.
*
* The calling thread is blocked until a reply is received. See mm_modem_location_inject_assistance_data()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_location_inject_assistance_data() for the asynchronous version of
* this method.
*
* Returns: %TRUE if the injection was successful, %FALSE if @error is set.
*
* Since: 1.10
*/
gboolean
mm_modem_location_inject_assistance_data_sync (MMModemLocation *self,
@@ -412,12 +467,16 @@ mm_modem_location_inject_assistance_data_sync (MMModemLocation *self,
/**
* mm_modem_location_set_gps_refresh_rate_finish:
* @self: A #MMModemLocation.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_location_set_gps_refresh_rate().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_location_set_gps_refresh_rate().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_location_set_gps_refresh_rate().
*
* Returns: %TRUE if setting the GPS refresh rate was successful, %FALSE if @error is set.
* Returns: %TRUE if setting the GPS refresh rate was successful, %FALSE if
* @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_location_set_gps_refresh_rate_finish (MMModemLocation *self,
@@ -439,12 +498,19 @@ mm_modem_location_set_gps_refresh_rate_finish (MMModemLocation *self,
*
* Asynchronously configures the GPS refresh rate.
* If a 0 rate is used, the GPS location updates will be immediately propagated to the interface.
* If a 0 rate is used, the GPS location updates will be immediately propagated
* to the interface.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_location_set_gps_refresh_rate_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_location_set_gps_refresh_rate_finish() to get the result of the
* operation.
*
* See mm_modem_location_set_gps_refresh_rate_sync() for the synchronous, blocking version of this method.
* See mm_modem_location_set_gps_refresh_rate_sync() for the synchronous,
* blocking version of this method.
*
* Since: 1.0
*/
void
mm_modem_location_set_gps_refresh_rate (MMModemLocation *self,
@@ -471,12 +537,17 @@ mm_modem_location_set_gps_refresh_rate (MMModemLocation *self,
*
* Synchronously configures the GPS refresh rate.
*
* If a 0 rate is used, the GPS location updates will be immediately propagated to the interface.
* If a 0 rate is used, the GPS location updates will be immediately propagated
* to the interface.
*
* The calling thread is blocked until a reply is received. See mm_modem_location_set_gps_refresh_rate()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_location_set_gps_refresh_rate() for the asynchronous version of this
* method.
*
* Returns: %TRUE if setting the refresh rate was successful, %FALSE if @error is set.
* Returns: %TRUE if setting the refresh rate was successful, %FALSE if @error
* is set.
*
* Since: 1.0
*/
gboolean
mm_modem_location_set_gps_refresh_rate_sync (MMModemLocation *self,
@@ -554,16 +625,27 @@ build_locations (GVariant *dictionary,
/**
* mm_modem_location_get_full_finish:
* @self: A #MMModemLocation.
* @location_3gpp: (out) (allow-none) (transfer full): Return location for a #MMLocation3gpp if 3GPP location is requested, or #NULL if not required. The returned value should be freed with g_object_unref().
* @location_gps_nmea: (out) (allow-none) (transfer full): Return location for a #MMLocationGpsNmea if GPS NMEA location is requested, or #NULL if not required. The returned value should be freed with g_object_unref().
* @location_gps_raw: (out) (allow-none) (transfer full): Return location for a #MMLocationGpsRaw if GPS raw location is requested, or #NULL if not required. The returned value should be freed with g_object_unref().
* @location_cdma_bs: (out) (allow-none) (transfer full): Return location for a #MMLocationCdmaBs if CDMA Base Station location is requested, or #NULL if not required. The returned value should be freed with g_object_unref().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_location_get_full().
* @location_3gpp: (out) (allow-none) (transfer full): Return location for a
* #MMLocation3gpp if 3GPP location is requested, or #NULL if not required. The
* returned value should be freed with g_object_unref().
* @location_gps_nmea: (out) (allow-none) (transfer full): Return location for a
* #MMLocationGpsNmea if GPS NMEA location is requested, or #NULL if not
* required. The returned value should be freed with g_object_unref().
* @location_gps_raw: (out) (allow-none) (transfer full): Return location for a
* #MMLocationGpsRaw if GPS raw location is requested, or #NULL if not required.
* The returned value should be freed with g_object_unref().
* @location_cdma_bs: (out) (allow-none) (transfer full): Return location for a
* #MMLocationCdmaBs if CDMA Base Station location is requested, or #NULL if
* not required. The returned value should be freed with g_object_unref().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_location_get_full().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_location_get_full().
*
* Returns: %TRUE if the retrieval was successful, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_location_get_full_finish (MMModemLocation *self,
@@ -588,15 +670,21 @@ mm_modem_location_get_full_finish (MMModemLocation *self,
* mm_modem_location_get_full:
* @self: A #MMModemLocation.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously gets the current location information.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_location_get_full_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_location_get_full_finish() to get the result of the operation.
*
* See mm_modem_location_get_full_sync() for the synchronous, blocking version of this method.
* See mm_modem_location_get_full_sync() for the synchronous, blocking version
* of this method.
*
* Since: 1.0
*/
void
mm_modem_location_get_full (MMModemLocation *self,
@@ -615,19 +703,29 @@ mm_modem_location_get_full (MMModemLocation *self,
/**
* mm_modem_location_get_full_sync:
* @self: A #MMModemLocation.
* @location_3gpp: (out) (allow-none) (transfer full): Return location for a #MMLocation3gpp if 3GPP location is requested, or #NULL if not required. The returned value should be freed with g_object_unref().
* @location_gps_nmea: (out) (allow-none) (transfer full): Return location for a #MMLocationGpsNmea if GPS NMEA location is requested, or #NULL if not required. The returned value should be freed with g_object_unref().
* @location_gps_raw: (out) (allow-none) (transfer full): Return location for a #MMLocationGpsRaw if GPS raw location is requested, or #NULL if not required. The returned value should be freed with g_object_unref().
* @location_cdma_bs: (out) (allow-none) (transfer full): Return location for a #MMLocationCdmaBs if CDMA Base Station location is requested, or #NULL if not required. The returned value should be freed with g_object_unref().
* @location_3gpp: (out) (allow-none) (transfer full): Return location for a
* #MMLocation3gpp if 3GPP location is requested, or #NULL if not required. The
* returned value should be freed with g_object_unref().
* @location_gps_nmea: (out) (allow-none) (transfer full): Return location for a
* #MMLocationGpsNmea if GPS NMEA location is requested, or #NULL if not
* required. The returned value should be freed with g_object_unref().
* @location_gps_raw: (out) (allow-none) (transfer full): Return location for a
* #MMLocationGpsRaw if GPS raw location is requested, or #NULL if not required.
* The returned value should be freed with g_object_unref().
* @location_cdma_bs: (out) (allow-none) (transfer full): Return location for a
* #MMLocationCdmaBs if CDMA Base Station location is requested, or #NULL if
* not required. The returned value should be freed with g_object_unref().
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Synchronously gets the current location information.
*
* The calling thread is blocked until a reply is received. See mm_modem_location_get_full()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_location_get_full() for the asynchronous version of this method.
*
* Returns: %TRUE if the setup was successful, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_location_get_full_sync (MMModemLocation *self,
@@ -653,12 +751,16 @@ mm_modem_location_get_full_sync (MMModemLocation *self,
/**
* mm_modem_location_get_3gpp_finish:
* @self: A #MMModemLocation.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_location_get_3gpp().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_location_get_3gpp().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_location_get_3gpp().
*
* Returns: (transfer full): A #MMLocation3gpp, or #NULL if not available. The returned value should be freed with g_object_unref().
* Returns: (transfer full): A #MMLocation3gpp, or #NULL if not available. The
* returned value should be freed with g_object_unref().
*
* Since: 1.0
*/
MMLocation3gpp *
mm_modem_location_get_3gpp_finish (MMModemLocation *self,
@@ -676,15 +778,21 @@ mm_modem_location_get_3gpp_finish (MMModemLocation *self,
* mm_modem_location_get_3gpp:
* @self: A #MMModemLocation.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously gets the current 3GPP location information.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_location_get_3gpp_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_location_get_3gpp_finish() to get the result of the operation.
*
* See mm_modem_location_get_3gpp_sync() for the synchronous, blocking version of this method.
* See mm_modem_location_get_3gpp_sync() for the synchronous, blocking version
* of this method.
*
* Since: 1.0
*/
void
mm_modem_location_get_3gpp (MMModemLocation *self,
@@ -703,10 +811,13 @@ mm_modem_location_get_3gpp (MMModemLocation *self,
*
* Synchronously gets the current 3GPP location information.
*
* The calling thread is blocked until a reply is received. See mm_modem_location_get_3gpp()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_location_get_3gpp() for the asynchronous version of this method.
*
* Returns: (transfer full): A #MMLocation3gpp, or #NULL if not available. The returned value should be freed with g_object_unref().
* Returns: (transfer full): A #MMLocation3gpp, or #NULL if not available. The
* returned value should be freed with g_object_unref().
*
* Since: 1.0
*/
MMLocation3gpp *
mm_modem_location_get_3gpp_sync (MMModemLocation *self,
@@ -725,12 +836,16 @@ mm_modem_location_get_3gpp_sync (MMModemLocation *self,
/**
* mm_modem_location_get_gps_nmea_finish:
* @self: A #MMModemLocation.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_location_get_gps_nmea().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_location_get_gps_nmea().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_location_get_gps_nmea().
*
* Returns: (transfer full): A #MMLocationGpsNmea, or #NULL if not available. The returned value should be freed with g_object_unref().
* Returns: (transfer full): A #MMLocationGpsNmea, or #NULL if not available.
* The returned value should be freed with g_object_unref().
*
* Since: 1.0
*/
MMLocationGpsNmea *
mm_modem_location_get_gps_nmea_finish (MMModemLocation *self,
@@ -748,15 +863,21 @@ mm_modem_location_get_gps_nmea_finish (MMModemLocation *self,
* mm_modem_location_get_gps_nmea:
* @self: A #MMModemLocation.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously gets the current GPS NMEA location information.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_location_get_gps_nmea_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_location_get_gps_nmea_finish() to get the result of the operation.
*
* See mm_modem_location_get_gps_nmea_sync() for the synchronous, blocking version of this method.
* See mm_modem_location_get_gps_nmea_sync() for the synchronous, blocking
* version of this method.
*
* Since: 1.0
*/
void
mm_modem_location_get_gps_nmea (MMModemLocation *self,
@@ -775,10 +896,13 @@ mm_modem_location_get_gps_nmea (MMModemLocation *self,
*
* Synchronously gets the current GPS NMEA location information.
*
* The calling thread is blocked until a reply is received. See mm_modem_location_get_gps_nmea()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_location_get_gps_nmea() for the asynchronous version of this method.
*
* Returns: (transfer full): A #MMLocationGpsNmea, or #NULL if not available. The returned value should be freed with g_object_unref().
* Returns: (transfer full): A #MMLocationGpsNmea, or #NULL if not available.
* The returned value should be freed with g_object_unref().
*
* Since: 1.0
*/
MMLocationGpsNmea *
mm_modem_location_get_gps_nmea_sync (MMModemLocation *self,
@@ -797,12 +921,16 @@ mm_modem_location_get_gps_nmea_sync (MMModemLocation *self,
/**
* mm_modem_location_get_gps_raw_finish:
* @self: A #MMModemLocation.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_location_get_gps_raw().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_location_get_gps_raw().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_location_get_gps_raw().
*
* Returns: (transfer full): A #MMLocationGpsRaw, or #NULL if not available. The returned value should be freed with g_object_unref().
* Returns: (transfer full): A #MMLocationGpsRaw, or #NULL if not available.
* The returned value should be freed with g_object_unref().
*
* Since: 1.0
*/
MMLocationGpsRaw *
mm_modem_location_get_gps_raw_finish (MMModemLocation *self,
@@ -820,15 +948,21 @@ mm_modem_location_get_gps_raw_finish (MMModemLocation *self,
* mm_modem_location_get_gps_raw:
* @self: A #MMModemLocation.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously gets the current GPS raw location information.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_location_get_gps_raw_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_location_get_gps_raw_finish() to get the result of the operation.
*
* See mm_modem_location_get_gps_raw_sync() for the synchronous, blocking version of this method.
* See mm_modem_location_get_gps_raw_sync() for the synchronous, blocking
* version of this method.
*
* Since: 1.0
*/
void
mm_modem_location_get_gps_raw (MMModemLocation *self,
@@ -847,10 +981,13 @@ mm_modem_location_get_gps_raw (MMModemLocation *self,
*
* Synchronously gets the current GPS raw location information.
*
* The calling thread is blocked until a reply is received. See mm_modem_location_get_gps_raw()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_location_get_gps_raw() for the asynchronous version of this method.
*
* Returns: (transfer full): A #MMLocationGpsRaw, or #NULL if not available. The returned value should be freed with g_object_unref().
* Returns: (transfer full): A #MMLocationGpsRaw, or #NULL if not available.
* The returned value should be freed with g_object_unref().
*
* Since: 1.0
*/
MMLocationGpsRaw *
mm_modem_location_get_gps_raw_sync (MMModemLocation *self,
@@ -869,12 +1006,16 @@ mm_modem_location_get_gps_raw_sync (MMModemLocation *self,
/**
* mm_modem_location_get_cdma_bs_finish:
* @self: A #MMModemLocation.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_location_get_cdma_bs().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_location_get_cdma_bs().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_location_get_cdma_bs().
*
* Returns: (transfer full): A #MMLocationCdmaBs, or #NULL if not available. The returned value should be freed with g_object_unref().
* Returns: (transfer full): A #MMLocationCdmaBs, or #NULL if not available.
* The returned value should be freed with g_object_unref().
*
* Since: 1.0
*/
MMLocationCdmaBs *
mm_modem_location_get_cdma_bs_finish (MMModemLocation *self,
@@ -892,15 +1033,21 @@ mm_modem_location_get_cdma_bs_finish (MMModemLocation *self,
* mm_modem_location_get_cdma_bs:
* @self: A #MMModemLocation.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously gets the current CDMA base station location information.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_location_get_cdma_bs_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_location_get_cdma_bs_finish() to get the result of the operation.
*
* See mm_modem_location_get_cdma_bs_sync() for the synchronous, blocking version of this method.
* See mm_modem_location_get_cdma_bs_sync() for the synchronous, blocking
* version of this method.
*
* Since: 1.0
*/
void
mm_modem_location_get_cdma_bs (MMModemLocation *self,
@@ -919,10 +1066,13 @@ mm_modem_location_get_cdma_bs (MMModemLocation *self,
*
* Synchronously gets the current CDMA base station location information.
*
* The calling thread is blocked until a reply is received. See mm_modem_location_get_cdma_bs()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_location_get_cdma_bs() for the asynchronous version of this method.
*
* Returns: (transfer full): A #MMLocationCdmaBs, or #NULL if not available. The returned value should be freed with g_object_unref().
* Returns: (transfer full): A #MMLocationCdmaBs, or #NULL if not available.
* The returned value should be freed with g_object_unref().
*
* Since: 1.0
*/
MMLocationCdmaBs *
mm_modem_location_get_cdma_bs_sync (MMModemLocation *self,
@@ -944,12 +1094,14 @@ mm_modem_location_get_cdma_bs_sync (MMModemLocation *self,
*
* Gets the address of the SUPL server.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_location_dup_supl_server() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_modem_location_dup_supl_server() if on another thread.</warning>
*
* Returns: (transfer none): The SUPL server address, or %NULL if none available. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): The SUPL server address, or %NULL if none
* available. Do not free the returned value, it belongs to @self.
*
* Since: 1.6
*/
const gchar *
mm_modem_location_get_supl_server (MMModemLocation *self)
@@ -966,7 +1118,10 @@ mm_modem_location_get_supl_server (MMModemLocation *self)
*
* Gets the address of the SUPL server.
*
* Returns: (transfer full): The SUPL server address, or %NULL if none available. The returned value should be freed with g_free().
* Returns: (transfer full): The SUPL server address, or %NULL if none
* available. The returned value should be freed with g_free().
*
* Since: 1.6
*/
gchar *
mm_modem_location_dup_supl_server (MMModemLocation *self)
@@ -985,12 +1140,15 @@ mm_modem_location_dup_supl_server (MMModemLocation *self)
*
* Gets the list of assistance data servers.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_location_dup_assistance_data_servers() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_modem_location_dup_assistance_data_servers() if on another thread.
* </warning>
*
* Returns: (transfer none): a %NULL-terminated array of server addresses, or %NULL if none available. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): a %NULL-terminated array of server addresses, or
* %NULL if none available. Do not free the returned value, it belongs to @self.
*
* Since: 1.10
*/
const gchar **
mm_modem_location_get_assistance_data_servers (MMModemLocation *self)
@@ -1010,7 +1168,11 @@ mm_modem_location_get_assistance_data_servers (MMModemLocation *self)
*
* Gets the list of assistance data servers.
*
* Returns: (transfer full): a %NULL-terminated array of server addresses, or %NULL if none available. The returned value should be freed with g_strfreev().
* Returns: (transfer full): a %NULL-terminated array of server addresses, or
* %NULL if none available. The returned value should be freed with
* g_strfreev().
*
* Since: 1.10
*/
gchar **
mm_modem_location_dup_assistance_data_servers (MMModemLocation *self)
@@ -1036,6 +1198,8 @@ mm_modem_location_dup_assistance_data_servers (MMModemLocation *self)
* Gets the GPS refresh rate, in seconds.
*
* Returns: The GPS refresh rate, or 0 if no fixed rate is used.
*
* Since: 1.0
*/
guint
mm_modem_location_get_gps_refresh_rate (MMModemLocation *self)

114
libmm-glib/mm-modem-messaging.c
View File

@@ -57,6 +57,8 @@ struct _MMModemMessagingPrivate {
* Gets the DBus path of the #MMObject which implements this interface.
*
* Returns: (transfer none): The DBus path of the #MMObject object.
*
* Since: 1.0
*/
const gchar *
mm_modem_messaging_get_path (MMModemMessaging *self)
@@ -71,9 +73,13 @@ mm_modem_messaging_get_path (MMModemMessaging *self)
* mm_modem_messaging_dup_path:
* @self: A #MMModemMessaging.
*
* Gets a copy of the DBus path of the #MMObject object which implements this interface.
* Gets a copy of the DBus path of the #MMObject object which implements this
* interface.
*
* Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMObject. The returned value
* should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_messaging_dup_path (MMModemMessaging *self)
@@ -143,12 +149,16 @@ ensure_internal_supported_storages (MMModemMessaging *self,
/**
* mm_modem_messaging_get_supported_storages:
* @self: A #MMModem.
* @storages: (out) (array length=n_storages): Return location for the array of #MMSmsStorage values. The returned array should be freed with g_free() when no longer needed.
* @storages: (out) (array length=n_storages): Return location for the array of
* #MMSmsStorage values. The returned array should be freed with g_free() when
* no longer needed.
* @n_storages: (out): Return location for the number of values in @storages.
*
* Gets the list of SMS storages supported by the #MMModem.
*
* Returns: %TRUE if @storages and @n_storages are set, %FALSE otherwise.
*
* Since: 1.0
*/
gboolean
mm_modem_messaging_get_supported_storages (MMModemMessaging *self,
@@ -173,12 +183,15 @@ mm_modem_messaging_get_supported_storages (MMModemMessaging *self,
/**
* mm_modem_messaging_peek_supported_storages:
* @self: A #MMModem.
* @storages: (out): Return location for the array of #MMSmsStorage values. Do not free the returned array, it is owned by @self.
* @storages: (out): Return location for the array of #MMSmsStorage values. Do
* not free the returned array, it is owned by @self.
* @n_storages: (out): Return location for the number of values in @storages.
*
* Gets the list of SMS storages supported by the #MMModem.
*
* Returns: %TRUE if @storages and @n_storages are set, %FALSE otherwise.
*
* Since: 1.0
*/
gboolean
mm_modem_messaging_peek_supported_storages (MMModemMessaging *self,
@@ -207,6 +220,8 @@ mm_modem_messaging_peek_supported_storages (MMModemMessaging *self,
* Gets the default SMS storage used when storing or receiving SMS messages.
*
* Returns: the default #MMSmsStorage.
*
* Since: 1.0
*/
MMSmsStorage
mm_modem_messaging_get_default_storage (MMModemMessaging *self)
@@ -241,12 +256,18 @@ list_sms_context_free (ListSmsContext *ctx)
/**
* mm_modem_messaging_list_finish:
* @self: A #MMModem.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_messaging_list().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_messaging_list().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_messaging_list().
*
* Returns: (element-type ModemManager.Sms) (transfer full): A list of #MMSms objects, or #NULL if either not found or @error is set. The returned value should be freed with g_list_free_full() using g_object_unref() as #GDestroyNotify function.
* Returns: (element-type ModemManager.Sms) (transfer full): A list of #MMSms
* objects, or #NULL if either not found or @error is set. The returned value
* should be freed with g_list_free_full() using g_object_unref() as
* #GDestroyNotify function.
*
* Since: 1.0
*/
GList *
mm_modem_messaging_list_finish (MMModemMessaging *self,
@@ -325,15 +346,21 @@ create_next_sms (GTask *task)
* mm_modem_messaging_list:
* @self: A #MMModemMessaging.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously lists the #MMSms objects in the modem.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_messaging_list_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_messaging_list_finish() to get the result of the operation.
*
* See mm_modem_messaging_list_sync() for the synchronous, blocking version of this method.
* See mm_modem_messaging_list_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.0
*/
void
mm_modem_messaging_list (MMModemMessaging *self,
@@ -372,10 +399,15 @@ mm_modem_messaging_list (MMModemMessaging *self,
*
* Synchronously lists the #MMSms objects in the modem.
*
* The calling thread is blocked until a reply is received. See mm_modem_messaging_list()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_messaging_list() for the asynchronous version of this method.
*
* Returns: (element-type ModemManager.Sms) (transfer full): A list of #MMSms objects, or #NULL if either not found or @error is set. The returned value should be freed with g_list_free_full() using g_object_unref() as #GDestroyNotify function.
* Returns: (element-type ModemManager.Sms) (transfer full): A list of #MMSms
* objects, or #NULL if either not found or @error is set. The returned value
* should be freed with g_list_free_full() using g_object_unref() as
* #GDestroyNotify function.
*
* Since: 1.0
*/
GList *
mm_modem_messaging_list_sync (MMModemMessaging *self,
@@ -425,12 +457,16 @@ mm_modem_messaging_list_sync (MMModemMessaging *self,
/**
* mm_modem_messaging_create_finish:
* @self: A #MMModemMessaging.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_messaging_create().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_messaging_create().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_messaging_create().
*
* Returns: (transfer full): A newly created #MMSms, or %NULL if @error is set. The returned value should be freed with g_object_unref().
* Returns: (transfer full): A newly created #MMSms, or %NULL if @error is set.
* The returned value should be freed with g_object_unref().
*
* Since: 1.0
*/
MMSms *
mm_modem_messaging_create_finish (MMModemMessaging *self,
@@ -500,15 +536,21 @@ create_sms_ready (MMModemMessaging *self,
* @self: A #MMModemMessaging.
* @properties: A ##MMSmsProperties object with the properties to use.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously creates a new #MMSms in the modem.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_messaging_create_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_messaging_create_finish() to get the result of the operation.
*
* See mm_modem_messaging_create_sync() for the synchronous, blocking version of this method.
* See mm_modem_messaging_create_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.0
*/
void
mm_modem_messaging_create (MMModemMessaging *self,
@@ -543,10 +585,13 @@ mm_modem_messaging_create (MMModemMessaging *self,
*
* Synchronously creates a new #MMSms in the modem.
*
* The calling thread is blocked until a reply is received. See mm_modem_messaging_create()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_messaging_create() for the asynchronous version of this method.
*
* Returns: (transfer full): A newly created #MMSms, or %NULL if @error is set. The returned value should be freed with g_object_unref().
* Returns: (transfer full): A newly created #MMSms, or %NULL if @error is set.
* The returned value should be freed with g_object_unref().
*
* Since: 1.0
*/
MMSms *
mm_modem_messaging_create_sync (MMModemMessaging *self,
@@ -589,12 +634,15 @@ mm_modem_messaging_create_sync (MMModemMessaging *self,
/**
* mm_modem_messaging_delete_finish:
* @self: A #MMModemMessaging.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_messaging_delete().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_messaging_delete().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_messaging_delete().
*
* Returns: %TRUE if the sms was deleted, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_messaging_delete_finish (MMModemMessaging *self,
@@ -611,15 +659,21 @@ mm_modem_messaging_delete_finish (MMModemMessaging *self,
* @self: A #MMModemMessaging.
* @sms: Path of the #MMSms to delete.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously deletes a given #MMSms from the modem.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_messaging_delete_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_messaging_delete_finish() to get the result of the operation.
*
* See mm_modem_messaging_delete_sync() for the synchronous, blocking version of this method.
* See mm_modem_messaging_delete_sync() for the synchronous, blocking version
* of this method.
*
* Since: 1.0
*/
void
mm_modem_messaging_delete (MMModemMessaging *self,
@@ -646,10 +700,12 @@ mm_modem_messaging_delete (MMModemMessaging *self,
* Synchronously deletes a given #MMSms from the modem.
*
* The calling thread is blocked until a reply is received. See mm_modem_messaging_delete()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_messaging_delete() for the asynchronous version of this method.
*
* Returns: %TRUE if the SMS was deleted, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_modem_messaging_delete_sync (MMModemMessaging *self,

141
libmm-glib/mm-modem-oma.c
View File

@@ -36,7 +36,8 @@
* The #MMModemOma is an object providing access to the methods, signals and
* properties of the OMA interface.
*
* The OMA interface is exposed whenever a modem has OMA device management capabilities.
* The OMA interface is exposed whenever a modem has OMA device management
* capabilities.
*/
G_DEFINE_TYPE (MMModemOma, mm_modem_oma, MM_GDBUS_TYPE_MODEM_OMA_PROXY)
@@ -57,6 +58,8 @@ struct _MMModemOmaPrivate {
* Gets the DBus path of the #MMObject which implements this interface.
*
* Returns: (transfer none): The DBus path of the #MMObject object.
*
* Since: 1.2
*/
const gchar *
mm_modem_oma_get_path (MMModemOma *self)
@@ -71,9 +74,13 @@ mm_modem_oma_get_path (MMModemOma *self)
* mm_modem_oma_dup_path:
* @self: A #MMModemOma.
*
* Gets a copy of the DBus path of the #MMObject object which implements this interface.
* Gets a copy of the DBus path of the #MMObject object which implements this
* interface.
*
* Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMObject. The returned value
* should be freed with g_free().
*
* Since: 1.2
*/
gchar *
mm_modem_oma_dup_path (MMModemOma *self)
@@ -93,12 +100,15 @@ mm_modem_oma_dup_path (MMModemOma *self)
/**
* mm_modem_oma_setup_finish:
* @self: A #MMModemOma.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_oma_setup().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_oma_setup().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_oma_setup().
*
* Returns: %TRUE if the setup was successful, %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_modem_oma_setup_finish (MMModemOma *self,
@@ -115,15 +125,21 @@ mm_modem_oma_setup_finish (MMModemOma *self,
* @self: A #MMModemOma.
* @features: Mask of #MMOmaFeature values to enable.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously sets up the OMA device management service.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_oma_setup_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_oma_setup_finish() to get the result of the operation.
*
* See mm_modem_oma_setup_sync() for the synchronous, blocking version of this method.
* See mm_modem_oma_setup_sync() for the synchronous, blocking version of this
* method.
*
* Since: 1.2
*/
void
mm_modem_oma_setup (MMModemOma *self,
@@ -146,10 +162,12 @@ mm_modem_oma_setup (MMModemOma *self,
*
* Synchronously sets up the OMA device management service.
*
* The calling thread is blocked until a reply is received. See mm_modem_oma_setup()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_oma_setup() for the asynchronous version of this method.
*
* Returns: %TRUE if the setup was successful, %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_modem_oma_setup_sync (MMModemOma *self,
@@ -167,12 +185,16 @@ mm_modem_oma_setup_sync (MMModemOma *self,
/**
* mm_modem_oma_start_client_initiated_session_finish:
* @self: A #MMModemOma.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_oma_start_client_initiated_session().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_oma_start_client_initiated_session().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_oma_start_client_initiated_session().
* Finishes an operation started with
* mm_modem_oma_start_client_initiated_session().
*
* Returns: %TRUE if the session was started, %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_modem_oma_start_client_initiated_session_finish (MMModemOma *self,
@@ -189,15 +211,22 @@ mm_modem_oma_start_client_initiated_session_finish (MMModemOma *self,
* @self: A #MMModemOma.
* @session_type: A #MMOmaSessionType.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously starts a client-initiated OMA device management session.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_oma_start_client_initiated_session_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_oma_start_client_initiated_session_finish() to get the result of the
* operation.
*
* See mm_modem_oma_start_client_initiated_session_sync() for the synchronous, blocking version of this method.
* See mm_modem_oma_start_client_initiated_session_sync() for the synchronous,
* blocking version of this method.
*
* Since: 1.2
*/
void
mm_modem_oma_start_client_initiated_session (MMModemOma *self,
@@ -220,10 +249,13 @@ mm_modem_oma_start_client_initiated_session (MMModemOma *self,
*
* Synchronously starts a client-initiated OMA device management session.
*
* The calling thread is blocked until a reply is received. See mm_modem_oma_start_client_initiated_session()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_oma_start_client_initiated_session() for the asynchronous version
* of this method.
*
* Returns: %TRUE if the session was started, %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_modem_oma_start_client_initiated_session_sync (MMModemOma *self,
@@ -241,12 +273,16 @@ mm_modem_oma_start_client_initiated_session_sync (MMModemOma *self,
/**
* mm_modem_oma_accept_network_initiated_session_finish:
* @self: A #MMModemOma.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_oma_accept_network_initiated_session().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_oma_accept_network_initiated_session().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_oma_accept_network_initiated_session().
* Finishes an operation started with
* mm_modem_oma_accept_network_initiated_session().
*
* Returns: %TRUE if the session was started, %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_modem_oma_accept_network_initiated_session_finish (MMModemOma *self,
@@ -264,15 +300,22 @@ mm_modem_oma_accept_network_initiated_session_finish (MMModemOma *self,
* @session_id: The unique ID of the network-initiated session.
* @accept: %TRUE if the session is to be accepted, %FALSE otherwise.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously accepts a nework-initiated OMA device management session.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_oma_accept_network_initiated_session_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_oma_accept_network_initiated_session_finish() to get the result of
* the operation.
*
* See mm_modem_oma_accept_network_initiated_session_sync() for the synchronous, blocking version of this method.
* See mm_modem_oma_accept_network_initiated_session_sync() for the synchronous,
* blocking version of this method.
*
* Since: 1.2
*/
void
mm_modem_oma_accept_network_initiated_session (MMModemOma *self,
@@ -297,10 +340,13 @@ mm_modem_oma_accept_network_initiated_session (MMModemOma *self,
*
* Synchronously accepts a nework-initiated OMA device management session.
*
* The calling thread is blocked until a reply is received. See mm_modem_oma_accept_network_initiated_session()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_oma_accept_network_initiated_session() for the asynchronous version
* of this method.
*
* Returns: %TRUE if the session was started, %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_modem_oma_accept_network_initiated_session_sync (MMModemOma *self,
@@ -319,12 +365,15 @@ mm_modem_oma_accept_network_initiated_session_sync (MMModemOma *self,
/**
* mm_modem_oma_cancel_session_finish:
* @self: A #MMModemOma.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_oma_cancel_session().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_oma_cancel_session().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_oma_cancel_session().
*
* Returns: %TRUE if the session was started, %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_modem_oma_cancel_session_finish (MMModemOma *self,
@@ -340,15 +389,21 @@ mm_modem_oma_cancel_session_finish (MMModemOma *self,
* mm_modem_oma_cancel_session:
* @self: A #MMModemOma.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously cancels the current OMA device management session.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_oma_cancel_session_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_oma_cancel_session_finish() to get the result of the operation.
*
* See mm_modem_oma_cancel_session_sync() for the synchronous, blocking version of this method.
* See mm_modem_oma_cancel_session_sync() for the synchronous, blocking version
* of this method.
*
* Since: 1.2
*/
void
mm_modem_oma_cancel_session (MMModemOma *self,
@@ -369,10 +424,12 @@ mm_modem_oma_cancel_session (MMModemOma *self,
*
* Synchronously cancels the current OMA device management session.
*
* The calling thread is blocked until a reply is received. See mm_modem_oma_cancel_session()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_oma_cancel_session() for the asynchronous version of this method.
*
* Returns: %TRUE if the session was started, %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_modem_oma_cancel_session_sync (MMModemOma *self,
@@ -393,6 +450,8 @@ mm_modem_oma_cancel_session_sync (MMModemOma *self,
* Gets the currently enabled OMA features.
*
* Returns: a bitmask of #MMOmaFeature values.
*
* Since: 1.2
*/
MMOmaFeature
mm_modem_oma_get_features (MMModemOma *self)
@@ -411,6 +470,8 @@ mm_modem_oma_get_features (MMModemOma *self)
* Gets the type of the current OMA device management session.
*
* Returns: a #MMOmaSessionType.
*
* Since: 1.2
*/
MMOmaSessionType
mm_modem_oma_get_session_type (MMModemOma *self)
@@ -429,6 +490,8 @@ mm_modem_oma_get_session_type (MMModemOma *self)
* Gets the state of the current OMA device management session.
*
* Returns: a #MMOmaSessionState.
*
* Since: 1.2
*/
MMOmaSessionState
mm_modem_oma_get_session_state (MMModemOma *self)
@@ -510,12 +573,16 @@ ensure_internal_pending_network_initiated_sessions (MMModemOma *self,
/**
* mm_modem_get_pending_network_initiated_sessions:
* @self: A #MMModem.
* @sessions: (out) (array length=n_sessions): Return location for the array of #MMOmaPendingNetworkInitiatedSession structs. The returned array should be freed with g_free() when no longer needed.
* @sessions: (out) (array length=n_sessions): Return location for the array of
* #MMOmaPendingNetworkInitiatedSession structs. The returned array should be
* freed with g_free() when no longer needed.
* @n_sessions: (out): Return location for the number of values in @sessions.
*
* Gets the list of pending network-initiated OMA sessions.
*
* Returns: %TRUE if @sessions and @n_sessions are set, %FALSE otherwise.
*
* Since: 1.2
*/
gboolean
mm_modem_get_pending_network_initiated_sessions (MMModemOma *self,
@@ -532,12 +599,16 @@ mm_modem_get_pending_network_initiated_sessions (MMModemOma *self,
/**
* mm_modem_peek_pending_network_initiated_sessions:
* @self: A #MMModem.
* @sessions: (out) (array length=n_sessions): Return location for the array of #MMOmaPendingNetworkInitiatedSession values. Do not free the returned array, it is owned by @self.
* @sessions: (out) (array length=n_sessions): Return location for the array of
* #MMOmaPendingNetworkInitiatedSession values. Do not free the returned array,
* it is owned by @self.
* @n_sessions: (out): Return location for the number of values in @sessions.
*
* Gets the list of pending network-initiated OMA sessions.
*
* Returns: %TRUE if @sessions and @n_sessions are set, %FALSE otherwise.
*
* Since: 1.2
*/
gboolean
mm_modem_peek_pending_network_initiated_sessions (MMModemOma *self,

142
libmm-glib/mm-modem-signal.c
View File

@@ -35,8 +35,8 @@
* The #MMModemSignal is an object providing access to the methods, signals and
* properties of the Signal interface.
*
* The Signal interface is exposed whenever a modem has extended signal retrieval
* capabilities.
* The Signal interface is exposed whenever a modem has extended signal
* retrieval capabilities.
*/
G_DEFINE_TYPE (MMModemSignal, mm_modem_signal, MM_GDBUS_TYPE_MODEM_SIGNAL_PROXY)
@@ -69,6 +69,8 @@ struct _MMModemSignalPrivate {
* Gets the DBus path of the #MMObject which implements this interface.
*
* Returns: (transfer none): The DBus path of the #MMObject object.
*
* Since: 1.2
*/
const gchar *
mm_modem_signal_get_path (MMModemSignal *self)
@@ -83,9 +85,13 @@ mm_modem_signal_get_path (MMModemSignal *self)
* mm_modem_signal_dup_path:
* @self: A #MMModemSignal.
*
* Gets a copy of the DBus path of the #MMObject object which implements this interface.
* Gets a copy of the DBus path of the #MMObject object which implements this
* interface.
*
* Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMObject. The returned value
* should be freed with g_free().
*
* Since: 1.2
*/
gchar *
mm_modem_signal_dup_path (MMModemSignal *self)
@@ -105,12 +111,15 @@ mm_modem_signal_dup_path (MMModemSignal *self)
/**
* mm_modem_signal_setup_finish:
* @self: A #MMModemSignal.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_signal_setup().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_signal_setup().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_signal_setup().
*
* Returns: %TRUE if the setup was successful, %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_modem_signal_setup_finish (MMModemSignal *self,
@@ -127,15 +136,21 @@ mm_modem_signal_setup_finish (MMModemSignal *self,
* @self: A #MMModemSignal.
* @rate: Rate to use when refreshing signal values.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously setups the extended signal quality retrieval.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_signal_setup_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_signal_setup_finish() to get the result of the operation.
*
* See mm_modem_signal_setup_sync() for the synchronous, blocking version of this method.
* See mm_modem_signal_setup_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.2
*/
void
mm_modem_signal_setup (MMModemSignal *self,
@@ -158,10 +173,12 @@ mm_modem_signal_setup (MMModemSignal *self,
*
* Synchronously setups the extended signal quality retrieval.
*
* The calling thread is blocked until a reply is received. See mm_modem_signal_setup()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_signal_setup() for the asynchronous version of this method.
*
* Returns: %TRUE if the setup was successful, %FALSE if @error is set.
*
* Since: 1.2
*/
gboolean
mm_modem_signal_setup_sync (MMModemSignal *self,
@@ -183,6 +200,8 @@ mm_modem_signal_setup_sync (MMModemSignal *self,
* Gets the currently configured refresh rate.
*
* Returns: the refresh rate, in seconds.
*
* Since: 1.2
*/
guint
mm_modem_signal_get_rate (MMModemSignal *self)
@@ -321,10 +340,13 @@ ensure_internal (MMModemSignal *self,
*
* <warning>The values reported by @self are not updated when the values in the
* interface change. Instead, the client is expected to call
* mm_modem_signal_get_cdma() again to get a new #MMSignal with the
* new values.</warning>
* mm_modem_signal_get_cdma() again to get a new #MMSignal with the new values.
* </warning>
*
* Returns: (transfer full): A #MMSignal that must be freed with g_object_unref() or %NULL if unknown.
* Returns: (transfer full): A #MMSignal that must be freed with
* g_object_unref() or %NULL if unknown.
*
* Since: 1.2
*/
MMSignal *
mm_modem_signal_get_cdma (MMModemSignal *self)
@@ -343,12 +365,14 @@ mm_modem_signal_get_cdma (MMModemSignal *self)
*
* Gets a #MMSignal object specifying the CDMA signal information.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_signal_get_cdma() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_modem_signal_get_cdma() if on another thread.</warning>
*
* Returns: (transfer none): A #MMSignal. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): A #MMSignal. Do not free the returned value, it
* belongs to @self.
*
* Since: 1.2
*/
MMSignal *
mm_modem_signal_peek_cdma (MMModemSignal *self)
@@ -369,10 +393,13 @@ mm_modem_signal_peek_cdma (MMModemSignal *self)
*
* <warning>The values reported by @self are not updated when the values in the
* interface change. Instead, the client is expected to call
* mm_modem_signal_get_evdo() again to get a new #MMSignal with the
* new values.</warning>
* mm_modem_signal_get_evdo() again to get a new #MMSignal with the new values.
* </warning>
*
* Returns: (transfer full): A #MMSignal that must be freed with g_object_unref() or %NULL if unknown.
* Returns: (transfer full): A #MMSignal that must be freed with
* g_object_unref() or %NULL if unknown.
*
* Since: 1.2
*/
MMSignal *
mm_modem_signal_get_evdo (MMModemSignal *self)
@@ -391,12 +418,14 @@ mm_modem_signal_get_evdo (MMModemSignal *self)
*
* Gets a #MMSignal object specifying the EV-DO signal information.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_signal_get_evdo() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_modem_signal_get_evdo() if on another thread.</warning>
*
* Returns: (transfer none): A #MMSignal. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): A #MMSignal. Do not free the returned value, it
* belongs to @self.
*
* Since: 1.2
*/
MMSignal *
mm_modem_signal_peek_evdo (MMModemSignal *self)
@@ -420,7 +449,10 @@ mm_modem_signal_peek_evdo (MMModemSignal *self)
* mm_modem_signal_get_gsm() again to get a new #MMSignal with the
* new values.</warning>
*
* Returns: (transfer full): A #MMSignal that must be freed with g_object_unref() or %NULL if unknown.
* Returns: (transfer full): A #MMSignal that must be freed with
* g_object_unref() or %NULL if unknown.
*
* Since: 1.2
*/
MMSignal *
mm_modem_signal_get_gsm (MMModemSignal *self)
@@ -439,12 +471,14 @@ mm_modem_signal_get_gsm (MMModemSignal *self)
*
* Gets a #MMSignal object specifying the GSM signal information.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_signal_get_gsm() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_modem_signal_get_gsm() if on another thread.</warning>
*
* Returns: (transfer none): A #MMSignal. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): A #MMSignal. Do not free the returned value, it
* belongs to @self.
*
* Since: 1.2
*/
MMSignal *
mm_modem_signal_peek_gsm (MMModemSignal *self)
@@ -465,10 +499,13 @@ mm_modem_signal_peek_gsm (MMModemSignal *self)
*
* <warning>The values reported by @self are not updated when the values in the
* interface change. Instead, the client is expected to call
* mm_modem_signal_get_umts() again to get a new #MMSignal with the
* new values.</warning>
* mm_modem_signal_get_umts() again to get a new #MMSignal with the new values.
* </warning>
*
* Returns: (transfer full): A #MMSignal that must be freed with g_object_unref() or %NULL if unknown.
* Returns: (transfer full): A #MMSignal that must be freed with
* g_object_unref() or %NULL if unknown.
*
* Since: 1.2
*/
MMSignal *
mm_modem_signal_get_umts (MMModemSignal *self)
@@ -487,12 +524,14 @@ mm_modem_signal_get_umts (MMModemSignal *self)
*
* Gets a #MMSignal object specifying the UMTS signal information.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_signal_get_umts() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_modem_signal_get_umts() if on another thread.</warning>
*
* Returns: (transfer none): A #MMSignal. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): A #MMSignal. Do not free the returned value, it
* belongs to @self.
*
* Since: 1.2
*/
MMSignal *
mm_modem_signal_peek_umts (MMModemSignal *self)
@@ -513,10 +552,13 @@ mm_modem_signal_peek_umts (MMModemSignal *self)
*
* <warning>The values reported by @self are not updated when the values in the
* interface change. Instead, the client is expected to call
* mm_modem_signal_get_lte() again to get a new #MMSignal with the
* new values.</warning>
* mm_modem_signal_get_lte() again to get a new #MMSignal with the new values.
* </warning>
*
* Returns: (transfer full): A #MMSignal that must be freed with g_object_unref() or %NULL if unknown.
* Returns: (transfer full): A #MMSignal that must be freed with
* g_object_unref() or %NULL if unknown.
*
* Since: 1.2
*/
MMSignal *
mm_modem_signal_get_lte (MMModemSignal *self)
@@ -535,12 +577,14 @@ mm_modem_signal_get_lte (MMModemSignal *self)
*
* Gets a #MMSignal object specifying the LTE signal information.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_signal_get_lte() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_modem_signal_get_lte() if on another thread.</warning>
*
* Returns: (transfer none): A #MMSignal. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): A #MMSignal. Do not free the returned value, it
* belongs to @self.
*
* Since: 1.2
*/
MMSignal *
mm_modem_signal_peek_lte (MMModemSignal *self)

112
libmm-glib/mm-modem-simple.c
View File

@@ -35,7 +35,8 @@
* The #MMModemSimple is an object providing access to the methods, signals and
* properties of the Simple interface.
*
* The Simple interface is exposed on modems which are not in %MM_MODEM_STATE_FAILED state.
* The Simple interface is exposed on modems which are not in
* %MM_MODEM_STATE_FAILED state.
*/
G_DEFINE_TYPE (MMModemSimple, mm_modem_simple, MM_GDBUS_TYPE_MODEM_SIMPLE_PROXY)
@@ -49,6 +50,8 @@ G_DEFINE_TYPE (MMModemSimple, mm_modem_simple, MM_GDBUS_TYPE_MODEM_SIMPLE_PROXY)
* Gets the DBus path of the #MMObject which implements this interface.
*
* Returns: (transfer none): The DBus path of the #MMObject object.
*
* Since: 1.0
*/
const gchar *
mm_modem_simple_get_path (MMModemSimple *self)
@@ -63,9 +66,13 @@ mm_modem_simple_get_path (MMModemSimple *self)
* mm_modem_simple_dup_path:
* @self: A #MMModemSimple.
*
* Gets a copy of the DBus path of the #MMObject object which implements this interface.
* Gets a copy of the DBus path of the #MMObject object which implements this
* interface.
*
* Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMObject. The returned value
* should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_simple_dup_path (MMModemSimple *self)
@@ -85,12 +92,16 @@ mm_modem_simple_dup_path (MMModemSimple *self)
/**
* mm_modem_simple_connect_finish:
* @self: A #MMModemSimple.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_simple_connect().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_simple_connect().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_simple_connect().
*
* Returns: (transfer full): A #MMBearer, or %FALSE if @error is set. The returned value must be freed with g_object_ref().
* Returns: (transfer full): A #MMBearer, or %FALSE if @error is set. The
* returned value must be freed with g_object_ref().
*
* Since: 1.0
*/
MMBearer *
mm_modem_simple_connect_finish (MMModemSimple *self,
@@ -159,15 +170,21 @@ simple_connect_ready (MMModemSimple *self,
* @self: A #MMModemSimple.
* @properties: (transfer none): A #MMSimpleConnectProperties bundle.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to connect the modem using the given @properties.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_simple_connect_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_simple_connect_finish() to get the result of the operation.
*
* See mm_modem_simple_connect_sync() for the synchronous, blocking version of this method.
* See mm_modem_simple_connect_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.0
*/
void
mm_modem_simple_connect (MMModemSimple *self,
@@ -203,10 +220,13 @@ mm_modem_simple_connect (MMModemSimple *self,
*
* Synchronously requests to connect the modem using the given @properties.
*
* The calling thread is blocked until a reply is received. See mm_modem_simple_connect()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_simple_connect() for the asynchronous version of this method.
*
* Returns: (transfer full): A #MMBearer, or %FALSE if @error is set. The returned value must be freed with g_object_ref().
* Returns: (transfer full): A #MMBearer, or %FALSE if @error is set. The
* returned value must be freed with g_object_ref().
*
* Since: 1.0
*/
MMBearer *
mm_modem_simple_connect_sync (MMModemSimple *self,
@@ -249,12 +269,16 @@ mm_modem_simple_connect_sync (MMModemSimple *self,
/**
* mm_modem_simple_disconnect_finish:
* @self: A #MMModemSimple.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_simple_disconnect().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_simple_disconnect().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_simple_disconnect().
*
* Returns: %TRUE if the modem is successfully disconnected, %FALSE if @error is set.
* Returns: %TRUE if the modem is successfully disconnected, %FALSE if @error is
* set.
*
* Since: 1.0
*/
gboolean
mm_modem_simple_disconnect_finish (MMModemSimple *self,
@@ -269,17 +293,24 @@ mm_modem_simple_disconnect_finish (MMModemSimple *self,
/**
* mm_modem_simple_disconnect:
* @self: A #MMModemSimple.
* @bearer: (allow-none): Path of the bearer to disconnect, or %NULL to disconnect all connected bearers.
* @bearer: (allow-none): Path of the bearer to disconnect, or %NULL to
* disconnect all connected bearers.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to disconnect the modem.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_simple_disconnect_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_simple_disconnect_finish() to get the result of the operation.
*
* See mm_modem_simple_disconnect_sync() for the synchronous, blocking version of this method.
* See mm_modem_simple_disconnect_sync() for the synchronous, blocking version
* of this method.
*
* Since: 1.0
*/
void
mm_modem_simple_disconnect (MMModemSimple *self,
@@ -300,16 +331,20 @@ mm_modem_simple_disconnect (MMModemSimple *self,
/**
* mm_modem_simple_disconnect_sync:
* @self: A #MMModemSimple.
* @bearer: (allow-none): Path of the bearer to disconnect, or %NULL to disconnect all connected bearers.
* @bearer: (allow-none): Path of the bearer to disconnect, or %NULL to
* disconnect all connected bearers.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Synchronously requests to disconnect the modem.
*
* The calling thread is blocked until a reply is received. See mm_modem_simple_disconnect()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_simple_disconnect() for the asynchronous version of this method.
*
* Returns: %TRUE if the modem is successfully disconnected, %FALSE if @error is set.
* Returns: %TRUE if the modem is successfully disconnected, %FALSE if @error is
* set.
*
* Since: 1.0
*/
gboolean
mm_modem_simple_disconnect_sync (MMModemSimple *self,
@@ -330,12 +365,16 @@ mm_modem_simple_disconnect_sync (MMModemSimple *self,
/**
* mm_modem_simple_get_status_finish:
* @self: A #MMModemSimple.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_simple_connect().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_simple_connect().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_simple_get_status().
*
* Returns: (transfer full): A #MMSimpleStatus, or %FALSE if @error is set. The returned value must be freed with g_object_ref().
* Returns: (transfer full): A #MMSimpleStatus, or %FALSE if @error is set. The
* returned value must be freed with g_object_ref().
*
* Since: 1.0
*/
MMSimpleStatus *
mm_modem_simple_get_status_finish (MMModemSimple *self,
@@ -359,15 +398,21 @@ mm_modem_simple_get_status_finish (MMModemSimple *self,
* mm_modem_simple_get_status:
* @self: A #MMModemSimple.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests a compilation of the status of the modem.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_simple_get_status_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_simple_get_status_finish() to get the result of the operation.
*
* See mm_modem_simple_get_status_sync() for the synchronous, blocking version of this method.
* See mm_modem_simple_get_status_sync() for the synchronous, blocking version
* of this method.
*
* Since: 1.0
*/
void
mm_modem_simple_get_status (MMModemSimple *self,
@@ -391,10 +436,13 @@ mm_modem_simple_get_status (MMModemSimple *self,
*
* Synchronously requests a compilation of the status of the modem.
*
* The calling thread is blocked until a reply is received. See mm_modem_simple_get_status()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_simple_get_status() for the asynchronous version of this method.
*
* Returns: (transfer full): A #MMSimpleStatus, or %FALSE if @error is set. The returned value must be freed with g_object_ref().
* Returns: (transfer full): A #MMSimpleStatus, or %FALSE if @error is set. The
* returned value must be freed with g_object_ref().
*
* Since: 1.0
*/
MMSimpleStatus *
mm_modem_simple_get_status_sync (MMModemSimple *self,

62
libmm-glib/mm-modem-time.c
View File

@@ -56,6 +56,8 @@ struct _MMModemTimePrivate {
* Gets the DBus path of the #MMObject which implements this interface.
*
* Returns: (transfer none): The DBus path of the #MMObject object.
*
* Since: 1.0
*/
const gchar *
mm_modem_time_get_path (MMModemTime *self)
@@ -70,9 +72,13 @@ mm_modem_time_get_path (MMModemTime *self)
* mm_modem_time_dup_path:
* @self: A #MMModemTime.
*
* Gets a copy of the DBus path of the #MMObject object which implements this interface.
* Gets a copy of the DBus path of the #MMObject object which implements this
* interface.
*
* Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMObject. The returned value
* should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_time_dup_path (MMModemTime *self)
@@ -92,12 +98,16 @@ mm_modem_time_dup_path (MMModemTime *self)
/**
* mm_modem_time_get_network_time_finish:
* @self: A #MMModemTime.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_enable().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_enable().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_time_get_network_time().
*
* Returns: (transfer full): A string containing the network time, or %NULL if @error is set. The returned value should be freed with g_free().
* Returns: (transfer full): A string containing the network time, or %NULL if
* @error is set. The returned value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_time_get_network_time_finish (MMModemTime *self,
@@ -118,15 +128,21 @@ mm_modem_time_get_network_time_finish (MMModemTime *self,
* mm_modem_time_get_network_time:
* @self: A #MMModemTime.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests the current network time.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_time_get_network_time_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_time_get_network_time_finish() to get the result of the operation.
*
* See mm_modem_time_get_network_time_sync() for the synchronous, blocking version of this method.
* See mm_modem_time_get_network_time_sync() for the synchronous, blocking
* version of this method.
*
* Since: 1.0
*/
void
mm_modem_time_get_network_time (MMModemTime *self,
@@ -150,10 +166,13 @@ mm_modem_time_get_network_time (MMModemTime *self,
*
* Synchronously requests the current network time.
*
* The calling thread is blocked until a reply is received. See mm_modem_time_get_network_time()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_time_get_network_time() for the asynchronous version of this method.
*
* Returns: (transfer full): A string containing the network time, or %NULL if @error is set. The returned value should be freed with g_free().
* Returns: (transfer full): A string containing the network time, or %NULL if
* @error is set. The returned value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_modem_time_get_network_time_sync (MMModemTime *self,
@@ -228,10 +247,13 @@ ensure_internal_timezone (MMModemTime *self,
*
* <warning>The values reported by @self are not updated when the values in the
* interface change. Instead, the client is expected to call
* mm_modem_time_get_network_timezone() again to get a new #MMNetworkTimezone with the
* new values.</warning>
* mm_modem_time_get_network_timezone() again to get a new #MMNetworkTimezone
* with the new values.</warning>
*
* Returns: (transfer full): A #MMNetworkTimezone that must be freed with g_object_unref() or %NULL if unknown.
* Returns: (transfer full): A #MMNetworkTimezone that must be freed with
* g_object_unref() or %NULL if unknown.
*
* Since: 1.0
*/
MMNetworkTimezone *
mm_modem_time_get_network_timezone (MMModemTime *self)
@@ -250,12 +272,14 @@ mm_modem_time_get_network_timezone (MMModemTime *self)
*
* Gets the network timezone information.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_modem_time_get_network_timezone() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_modem_time_get_network_timezone() if on another thread.</warning>
*
* Returns: (transfer none): A #MMNetworkTimezone. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): A #MMNetworkTimezone. Do not free the returned
* value, it belongs to @self.
*
* Since: 1.0
*/
MMNetworkTimezone *
mm_modem_time_peek_network_timezone (MMModemTime *self)

247
libmm-glib/mm-modem-voice.c
View File

@@ -50,6 +50,8 @@ G_DEFINE_TYPE (MMModemVoice, mm_modem_voice, MM_GDBUS_TYPE_MODEM_VOICE_PROXY)
* Gets the DBus path of the #MMObject which implements this interface.
*
* Returns: (transfer none): The DBus path of the #MMObject object.
*
* Since: 1.6
*/
const gchar *
mm_modem_voice_get_path (MMModemVoice *self)
@@ -64,9 +66,13 @@ mm_modem_voice_get_path (MMModemVoice *self)
* mm_modem_voice_dup_path:
* @self: A #MMModemVoice.
*
* Gets a copy of the DBus path of the #MMObject object which implements this interface.
* Gets a copy of the DBus path of the #MMObject object which implements this
* interface.
*
* Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMObject. The returned value
* should be freed with g_free().
*
* Since: 1.6
*/
gchar *
mm_modem_voice_dup_path (MMModemVoice *self)
@@ -87,7 +93,9 @@ mm_modem_voice_dup_path (MMModemVoice *self)
*
* Checks whether emergency calls only are allowed.
*
* Returns: %TRUE if only emergency calls are allowed, %FALSE otherwise..
* Returns: %TRUE if only emergency calls are allowed, %FALSE otherwise.
*
* Since: 1.12
*/
gboolean
mm_modem_voice_get_emergency_only (MMModemVoice *self)
@@ -120,12 +128,18 @@ list_call_context_free (ListCallsContext *ctx)
/**
* mm_modem_voice_list_calls_finish:
* @self: A #MMModem.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_voice_list_calls().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_voice_list_calls().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_voice_list_calls().
*
* Returns: (element-type ModemManager.Call) (transfer full): A list of #MMCall objects, or #NULL if either not found or @error is set. The returned value should be freed with g_list_free_full() using g_object_unref() as #GDestroyNotify function.
* Returns: (element-type ModemManager.Call) (transfer full): A list of #MMCall
* objects, or #NULL if either not found or @error is set. The returned value
* should be freed with g_list_free_full() using g_object_unref() as
* #GDestroyNotify function.
*
* Since: 1.6
*/
GList *
mm_modem_voice_list_calls_finish (MMModemVoice *self,
@@ -204,15 +218,21 @@ create_next_call (GTask *task)
* mm_modem_voice_list_calls:
* @self: A #MMModemVoice.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously lists the #MMCall objects in the modem.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_voice_list_calls_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_voice_list_calls_finish() to get the result of the operation.
*
* See mm_modem_voice_list_calls_sync() for the synchronous, blocking version of this method.
* See mm_modem_voice_list_calls_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.6
*/
void
mm_modem_voice_list_calls (MMModemVoice *self,
@@ -251,10 +271,15 @@ mm_modem_voice_list_calls (MMModemVoice *self,
*
* Synchronously lists the #MMCall objects in the modem.
*
* The calling thread is blocked until a reply is received. See mm_modem_voice_list_calls()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_voice_list_calls() for the asynchronous version of this method.
*
* Returns: (element-type ModemManager.Call) (transfer full): A list of #MMCall objects, or #NULL if either not found or @error is set. The returned value should be freed with g_list_free_full() using g_object_unref() as #GDestroyNotify function.
* Returns: (element-type ModemManager.Call) (transfer full): A list of #MMCall
* objects, or #NULL if either not found or @error is set. The returned value
* should be freed with g_list_free_full() using g_object_unref() as
* #GDestroyNotify function.
*
* Since: 1.6
*/
GList *
mm_modem_voice_list_calls_sync (MMModemVoice *self,
@@ -304,12 +329,16 @@ mm_modem_voice_list_calls_sync (MMModemVoice *self,
/**
* mm_modem_voice_create_call_finish:
* @self: A #MMModemVoice.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_voice_create_call().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_voice_create_call().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_voice_create_call().
*
* Returns: (transfer full): A newly created #MMCall, or %NULL if @error is set. The returned value should be freed with g_object_unref().
* Returns: (transfer full): A newly created #MMCall, or %NULL if @error is set.
* The returned value should be freed with g_object_unref().
*
* Since: 1.6
*/
MMCall *
mm_modem_voice_create_call_finish (MMModemVoice *self,
@@ -379,15 +408,21 @@ create_call_ready (MMModemVoice *self,
* @self: A #MMModemVoice.
* @properties: A ##MMCallProperties object with the properties to use.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously creates a new #MMCall in the modem.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_voice_create_call_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_voice_create_call_finish() to get the result of the operation.
*
* See mm_modem_voice_create_call_sync() for the synchronous, blocking version of this method.
* See mm_modem_voice_create_call_sync() for the synchronous, blocking version
* of this method.
*
* Since: 1.6
*/
void
mm_modem_voice_create_call (MMModemVoice *self,
@@ -422,10 +457,13 @@ mm_modem_voice_create_call (MMModemVoice *self,
*
* Synchronously creates a new #MMCall in the modem.
*
* The calling thread is blocked until a reply is received. See mm_modem_voice_create_call()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_voice_create_call() for the asynchronous version of this method.
*
* Returns: (transfer full): A newly created #MMCall, or %NULL if @error is set. The returned value should be freed with g_object_unref().
* Returns: (transfer full): A newly created #MMCall, or %NULL if @error is set.
* The returned value should be freed with g_object_unref().
*
* Since: 1.6
*/
MMCall *
mm_modem_voice_create_call_sync (MMModemVoice *self,
@@ -468,12 +506,15 @@ mm_modem_voice_create_call_sync (MMModemVoice *self,
/**
* mm_modem_voice_delete_call_finish:
* @self: A #MMModemVoice.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_voice_delete_call().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_voice_delete_call().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_voice_delete_call().
*
* Returns: %TRUE if the call was deleted, %FALSE if @error is set.
*
* Since: 1.6
*/
gboolean
mm_modem_voice_delete_call_finish (MMModemVoice *self,
@@ -490,15 +531,21 @@ mm_modem_voice_delete_call_finish (MMModemVoice *self,
* @self: A #MMModemVoice.
* @call: Path of the #MMCall to delete.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously deletes a given #MMCall from the modem.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_voice_delete_call_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_voice_delete_call_finish() to get the result of the operation.
*
* See mm_modem_voice_delete_call_sync() for the synchronous, blocking version of this method.
* See mm_modem_voice_delete_call_sync() for the synchronous, blocking version
* of this method.
*
* Since: 1.6
*/
void
mm_modem_voice_delete_call (MMModemVoice *self,
@@ -525,10 +572,12 @@ mm_modem_voice_delete_call (MMModemVoice *self,
* Synchronously deletes a given #MMCall from the modem.
*
* The calling thread is blocked until a reply is received. See mm_modem_voice_delete_call()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_voice_delete_call() for the asynchronous version of this method.
*
* Returns: %TRUE if the CALL was deleted, %FALSE if @error is set.
*
* Since: 1.6
*/
gboolean
mm_modem_voice_delete_call_sync (MMModemVoice *self,
@@ -549,12 +598,14 @@ mm_modem_voice_delete_call_sync (MMModemVoice *self,
/**
* mm_modem_voice_hold_and_accept_finish:
* @self: A #MMModemVoice.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_voice_hold_and_accept().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_voice_hold_and_accept().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_voice_hold_and_accept().
*
* Returns: %TRUE if the operation was successful, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
@@ -571,15 +622,20 @@ mm_modem_voice_hold_and_accept_finish (MMModemVoice *self,
* mm_modem_voice_hold_and_accept:
* @self: A #MMModemVoice.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously puts all active calls on hold and accepts the next waiting or held call.
* Asynchronously puts all active calls on hold and accepts the next waiting or
* held call.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_voice_hold_and_accept_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_voice_hold_and_accept_finish() to get the result of the operation.
*
* See mm_modem_voice_hold_and_accept_sync() for the synchronous, blocking version of this method.
* See mm_modem_voice_hold_and_accept_sync() for the synchronous, blocking
* version of this method.
*
* Since: 1.12
*/
@@ -603,12 +659,14 @@ mm_modem_voice_hold_and_accept (MMModemVoice *self,
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Synchronously puts all active calls on hold and accepts the next waiting or held call.
* Synchronously puts all active calls on hold and accepts the next waiting or
* held call.
*
* The calling thread is blocked until a reply is received. See mm_modem_voice_hold_and_accept()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_voice_hold_and_accept() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation was successful, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
@@ -628,12 +686,14 @@ mm_modem_voice_hold_and_accept_sync (MMModemVoice *self,
/**
* mm_modem_voice_hangup_and_accept_finish:
* @self: A #MMModemVoice.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_voice_hangup_and_accept().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_voice_hangup_and_accept().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_voice_hangup_and_accept().
*
* Returns: %TRUE if the operation was successful, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
@@ -650,15 +710,20 @@ mm_modem_voice_hangup_and_accept_finish (MMModemVoice *self,
* mm_modem_voice_hangup_and_accept:
* @self: A #MMModemVoice.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously hangs up all active calls and accepts the next waiting or held call.
* Asynchronously hangs up all active calls and accepts the next waiting or held
* call.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_voice_hangup_and_accept_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_voice_hangup_and_accept_finish() to get the result of the operation.
*
* See mm_modem_voice_hangup_and_accept_sync() for the synchronous, blocking version of this method.
* See mm_modem_voice_hangup_and_accept_sync() for the synchronous, blocking
* version of this method.
*
* Since: 1.12
*/
@@ -682,12 +747,14 @@ mm_modem_voice_hangup_and_accept (MMModemVoice *self,
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Synchronously hangs up all active calls and accepts the next waiting or held call.
* Synchronously hangs up all active calls and accepts the next waiting or held
* call.
*
* The calling thread is blocked until a reply is received. See mm_modem_voice_hangup_and_accept()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_voice_hangup_and_accept() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation was successful, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
@@ -707,12 +774,14 @@ mm_modem_voice_hangup_and_accept_sync (MMModemVoice *self,
/**
* mm_modem_voice_hangup_all_finish:
* @self: A #MMModemVoice.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_voice_hangup_all().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_voice_hangup_all().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_voice_hangup_all().
*
* Returns: %TRUE if the operation was successful, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
@@ -729,15 +798,19 @@ mm_modem_voice_hangup_all_finish (MMModemVoice *self,
* mm_modem_voice_hangup_all:
* @self: A #MMModemVoice.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously hangs up all ongoing (active, waiting, held) calls.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_voice_hangup_all_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_voice_hangup_all_finish() to get the result of the operation.
*
* See mm_modem_voice_hangup_all_sync() for the synchronous, blocking version of this method.
* See mm_modem_voice_hangup_all_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.12
*/
@@ -763,10 +836,11 @@ mm_modem_voice_hangup_all (MMModemVoice *self,
*
* Synchronously hangs up all ongoing (active, waiting, held) calls.
*
* The calling thread is blocked until a reply is received. See mm_modem_voice_hangup_all()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_voice_hangup_all() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation was successful, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
@@ -786,12 +860,14 @@ mm_modem_voice_hangup_all_sync (MMModemVoice *self,
/**
* mm_modem_voice_transfer_finish:
* @self: A #MMModemVoice.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_voice_transfer().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_voice_transfer().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_voice_transfer().
*
* Returns: %TRUE if the operation was successful, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
@@ -808,15 +884,19 @@ mm_modem_voice_transfer_finish (MMModemVoice *self,
* mm_modem_voice_transfer:
* @self: A #MMModemVoice.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously joins all active and held calls, and disconnects from them.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_voice_transfer_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_voice_transfer_finish() to get the result of the operation.
*
* See mm_modem_voice_transfer_sync() for the synchronous, blocking version of this method.
* See mm_modem_voice_transfer_sync() for the synchronous, blocking version of
* this method.
*
* Since: 1.12
*/
@@ -842,10 +922,11 @@ mm_modem_voice_transfer (MMModemVoice *self,
*
* Synchronously joins all active and held calls, and disconnects from them.
*
* The calling thread is blocked until a reply is received. See mm_modem_voice_transfer()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_voice_transfer() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation was successful, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
@@ -865,12 +946,14 @@ mm_modem_voice_transfer_sync (MMModemVoice *self,
/**
* mm_modem_voice_call_waiting_setup_finish:
* @self: A #MMModemVoice.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_voice_call_waiting_setup().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_voice_call_waiting_setup().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_voice_call_waiting_setup().
*
* Returns: %TRUE if @status is set, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
@@ -888,15 +971,20 @@ mm_modem_voice_call_waiting_setup_finish (MMModemVoice *self,
* @self: A #MMModemVoice.
* @enable: Whether the call waiting service should be enabled.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously enables or disables the call waiting network service.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_voice_call_waiting_setup_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_voice_call_waiting_setup_finish() to get the result of the
* operation.
*
* See mm_modem_voice_call_waiting_setup_sync() for the synchronous, blocking version of this method.
* See mm_modem_voice_call_waiting_setup_sync() for the synchronous, blocking
* version of this method.
*
* Since: 1.12
*/
@@ -925,10 +1013,12 @@ mm_modem_voice_call_waiting_setup (MMModemVoice *self,
*
* Synchronously enables or disables the call waiting network service.
*
* The calling thread is blocked until a reply is received. See mm_modem_voice_call_waiting_setup()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_voice_call_waiting_setup() for the asynchronous version of this
* method.
*
* Returns: %TRUE if the operation is successful, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
@@ -950,13 +1040,15 @@ mm_modem_voice_call_waiting_setup_sync (MMModemVoice *self,
/**
* mm_modem_voice_call_waiting_query_finish:
* @self: A #MMModemVoice.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_voice_call_waiting_query().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_modem_voice_call_waiting_query().
* @status: Output location where to store the status.
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_modem_voice_call_waiting_query().
*
* Returns: %TRUE if @status is set, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean
@@ -974,15 +1066,20 @@ mm_modem_voice_call_waiting_query_finish (MMModemVoice *self,
* mm_modem_voice_call_waiting_query:
* @self: A #MMModemVoice.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously queries the status of the call waiting network service.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_modem_voice_call_waiting_query_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_modem_voice_call_waiting_query_finish() to get the result of the
* operation.
*
* See mm_modem_voice_call_waiting_query_sync() for the synchronous, blocking version of this method.
* See mm_modem_voice_call_waiting_query_sync() for the synchronous, blocking
* version of this method.
*
* Since: 1.12
*/
@@ -1009,10 +1106,12 @@ mm_modem_voice_call_waiting_query (MMModemVoice *self,
*
* Synchronously queries the status of the call waiting network service.
*
* The calling thread is blocked until a reply is received. See mm_modem_voice_call_waiting_query()
* for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_modem_voice_call_waiting_query() for the asynchronous version of this
* method.
*
* Returns: %TRUE if @status is set, %FALSE if @error is set.
*
* Since: 1.12
*/
gboolean

891
libmm-glib/mm-modem.c
View File

File diff suppressed because it is too large Load Diff

11
libmm-glib/mm-network-timezone.c
View File

@@ -47,6 +47,8 @@ struct _MMNetworkTimezonePrivate {
* Gets the timezone offset (in minutes) reported by the network.
*
* Returns: the offset, or %MM_NETWORK_TIMEZONE_OFFSET_UNKNOWN if unknown.
*
* Since: 1.0
*/
gint
mm_network_timezone_get_offset (MMNetworkTimezone *self)
@@ -76,6 +78,8 @@ mm_network_timezone_set_offset (MMNetworkTimezone *self,
* the network.
*
* Returns: the offset, or %MM_NETWORK_TIMEZONE_OFFSET_UNKNOWN if unknown.
*
* Since: 1.0
*/
gint
mm_network_timezone_get_dst_offset (MMNetworkTimezone *self)
@@ -103,7 +107,10 @@ mm_network_timezone_set_dst_offset (MMNetworkTimezone *self,
*
* Gets the number of leap seconds (TAI-UTC), as reported by the network.
*
* Returns: the number of leap seconds, or %MM_NETWORK_TIMEZONE_LEAP_SECONDS_UNKNOWN if unknown.
* Returns: the number of leap seconds, or
* %MM_NETWORK_TIMEZONE_LEAP_SECONDS_UNKNOWN if unknown.
*
* Since: 1.0
*/
gint
mm_network_timezone_get_leap_seconds (MMNetworkTimezone *self)
@@ -236,7 +243,7 @@ mm_network_timezone_new (void)
static void
mm_network_timezone_init (MMNetworkTimezone *self)
{
self->priv = G_TYPE_INSTANCE_GET_PRIVATE ((self),
self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
MM_TYPE_NETWORK_TIMEZONE,
MMNetworkTimezonePrivate);

6
libmm-glib/mm-network-timezone.h
View File

@@ -36,13 +36,17 @@ G_BEGIN_DECLS
* MM_NETWORK_TIMEZONE_OFFSET_UNKNOWN:
*
* Identifier for an unknown timezone offset.
*
* Since: 1.0
*/
#define MM_NETWORK_TIMEZONE_OFFSET_UNKNOWN G_MAXINT32
#define MM_NETWORK_TIMEZONE_OFFSET_UNKNOWN G_MAXINT32
/**
* MM_NETWORK_TIMEZONE_LEAP_SECONDS_UNKNOWN:
*
* Identifier for an unknown leap seconds value.
*
* Since: 1.0
*/
#define MM_NETWORK_TIMEZONE_LEAP_SECONDS_UNKNOWN G_MAXINT32

242
libmm-glib/mm-object.c
View File

@@ -47,6 +47,8 @@ G_DEFINE_TYPE (MMObject, mm_object, MM_GDBUS_TYPE_OBJECT_PROXY)
* Gets the DBus path of the #MMObject object.
*
* Returns: (transfer none): The DBus path of the #MMObject object.
*
* Since: 1.0
*/
const gchar *
mm_object_get_path (MMObject *self)
@@ -62,7 +64,10 @@ mm_object_get_path (MMObject *self)
*
* Gets a copy of the DBus path of the #MMObject object.
*
* Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMObject. The returned value
* should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_object_dup_path (MMObject *self)
@@ -84,9 +89,13 @@ mm_object_dup_path (MMObject *self)
* mm_object_get_modem:
* @self: A #MMModem
*
* Gets the #MMModem instance for the D-Bus interface org.freedesktop.ModemManager1.Modem on @self, if any.
* Gets the #MMModem instance for the D-Bus interface
* org.freedesktop.ModemManager1.Modem on @self, if any.
*
* Returns: (transfer full): A #MMModem that must be freed with g_object_unref() or %NULL if @self does not implement the interface.
* Returns: (transfer full): A #MMModem that must be freed with g_object_unref()
* or %NULL if @self does not implement the interface.
*
* Since: 1.0
*/
MMModem *
mm_object_get_modem (MMObject *self)
@@ -104,11 +113,16 @@ mm_object_get_modem (MMObject *self)
* mm_object_peek_modem: (skip)
* @self: A #MMObject.
*
* Like mm_object_get_modem() but doesn't increase the reference count on the returned object.
* Like mm_object_get_modem() but doesn't increase the reference count on the
* returned object.
*
* <warning>It is not safe to use the returned object if you are on another thread than the one where the #MMManager is running.</warning>
* <warning>It is not safe to use the returned object if you are on another
* thread than the one where the #MMManager is running.</warning>
*
* Returns: (transfer none): A #MMModem or %NULL if @self does not implement the interface. Do not free the returned object, it is owned by @self.
* Returns: (transfer none): A #MMModem or %NULL if @self does not implement
* the interface. Do not free the returned object, it is owned by @self.
*
* Since: 1.0
*/
MMModem *
mm_object_peek_modem (MMObject *self)
@@ -128,9 +142,13 @@ mm_object_peek_modem (MMObject *self)
* mm_object_get_modem_3gpp:
* @self: A #MMObject.
*
* Gets the #MMModem3gpp instance for the D-Bus interface org.freedesktop.ModemManager1.Modem.Modem3gpp on @self, if any.
* Gets the #MMModem3gpp instance for the D-Bus interface
* org.freedesktop.ModemManager1.Modem.Modem3gpp on @self, if any.
*
* Returns: (transfer full): A #MMModem3gpp that must be freed with g_object_unref() or %NULL if @self does not implement the interface.
* Returns: (transfer full): A #MMModem3gpp that must be freed with
* g_object_unref() or %NULL if @self does not implement the interface.
*
* Since: 1.0
*/
MMModem3gpp *
mm_object_get_modem_3gpp (MMObject *self)
@@ -144,11 +162,16 @@ mm_object_get_modem_3gpp (MMObject *self)
* mm_object_peek_modem_3gpp: (skip)
* @self: A #MMObject.
*
* Like mm_object_get_modem_3gpp() but doesn't increase the reference count on the returned object.
* Like mm_object_get_modem_3gpp() but doesn't increase the reference count on
* the returned object.
*
* <warning>It is not safe to use the returned object if you are on another thread than the one where the #MMManager is running.</warning>
* <warning>It is not safe to use the returned object if you are on another
* thread than the one where the #MMManager is running.</warning>
*
* Returns: (transfer none): A #MMModem3gpp or %NULL if @self does not implement the interface. Do not free the returned object, it is owned by @self.
* Returns: (transfer none): A #MMModem3gpp or %NULL if @self does not implement
* the interface. Do not free the returned object, it is owned by @self.
*
* Since: 1.0
*/
MMModem3gpp *
mm_object_peek_modem_3gpp (MMObject *self)
@@ -164,9 +187,13 @@ mm_object_peek_modem_3gpp (MMObject *self)
* mm_object_get_modem_3gpp_ussd:
* @self: A #MMObject.
*
* Gets the #MMModem3gppUssd instance for the D-Bus interface org.freedesktop.ModemManager1.Modem.Modem3gpp-Ussd on @self, if any.
* Gets the #MMModem3gppUssd instance for the D-Bus interface
* org.freedesktop.ModemManager1.Modem.Modem3gpp-Ussd on @self, if any.
*
* Returns: (transfer full): A #MMModem3gppUssd that must be freed with g_object_unref() or %NULL if @self does not implement the interface.
* Returns: (transfer full): A #MMModem3gppUssd that must be freed with
* g_object_unref() or %NULL if @self does not implement the interface.
*
* Since: 1.0
*/
MMModem3gppUssd *
mm_object_get_modem_3gpp_ussd (MMObject *self)
@@ -180,11 +207,17 @@ mm_object_get_modem_3gpp_ussd (MMObject *self)
* mm_object_peek_modem_3gpp_ussd: (skip)
* @self: A #MMObject.
*
* Like mm_object_get_modem_3gpp_ussd() but doesn't increase the reference count on the returned object.
* Like mm_object_get_modem_3gpp_ussd() but doesn't increase the reference count
* on the returned object.
*
* <warning>It is not safe to use the returned object if you are on another thread than the one where the #MMManager is running.</warning>
* <warning>It is not safe to use the returned object if you are on another
* thread than the one where the #MMManager is running.</warning>
*
* Returns: (transfer none): A #MMModem3gppUssd or %NULL if @self does not implement the interface. Do not free the returned object, it is owned by @self.
* Returns: (transfer none): A #MMModem3gppUssd or %NULL if @self does not
* implement the interface. Do not free the returned object, it is owned by
* @self.
*
* Since: 1.0
*/
MMModem3gppUssd *
mm_object_peek_modem_3gpp_ussd (MMObject *self)
@@ -200,9 +233,13 @@ mm_object_peek_modem_3gpp_ussd (MMObject *self)
* mm_object_get_modem_cdma:
* @self: A #MMObject.
*
* Gets the #MMModemCdma instance for the D-Bus interface org.freedesktop.ModemManager1.Modem.ModemCdma on @self, if any.
* Gets the #MMModemCdma instance for the D-Bus interface
* org.freedesktop.ModemManager1.Modem.ModemCdma on @self, if any.
*
* Returns: (transfer full): A #MMModemCdma that must be freed with g_object_unref() or %NULL if @self does not implement the interface.
* Returns: (transfer full): A #MMModemCdma that must be freed with
* g_object_unref() or %NULL if @self does not implement the interface.
*
* Since: 1.0
*/
MMModemCdma *
mm_object_get_modem_cdma (MMObject *self)
@@ -216,11 +253,16 @@ mm_object_get_modem_cdma (MMObject *self)
* mm_object_peek_modem_cdma: (skip)
* @self: A #MMObject.
*
* Like mm_object_get_modem_cdma() but doesn't increase the reference count on the returned object.
* Like mm_object_get_modem_cdma() but doesn't increase the reference count on
* the returned object.
*
* <warning>It is not safe to use the returned object if you are on another thread than the one where the #MMManager is running.</warning>
* <warning>It is not safe to use the returned object if you are on another
* thread than the one where the #MMManager is running.</warning>
*
* Returns: (transfer none): A #MMModemCdma or %NULL if @self does not implement the interface. Do not free the returned object, it is owned by @self.
* Returns: (transfer none): A #MMModemCdma or %NULL if @self does not implement
* the interface. Do not free the returned object, it is owned by @self.
*
* Since: 1.0
*/
MMModemCdma *
mm_object_peek_modem_cdma (MMObject *self)
@@ -236,9 +278,13 @@ mm_object_peek_modem_cdma (MMObject *self)
* mm_object_get_modem_simple:
* @self: A #MMObject.
*
* Gets the #MMModemSimple instance for the D-Bus interface org.freedesktop.ModemManager1.Modem.Modemsimple on @self, if any.
* Gets the #MMModemSimple instance for the D-Bus interface
* org.freedesktop.ModemManager1.Modem.Modemsimple on @self, if any.
*
* Returns: (transfer full): A #MMModemSimple that must be freed with g_object_unref() or %NULL if @self does not implement the interface.
* Returns: (transfer full): A #MMModemSimple that must be freed with
* g_object_unref() or %NULL if @self does not implement the interface.
*
* Since: 1.0
*/
MMModemSimple *
mm_object_get_modem_simple (MMObject *self)
@@ -252,11 +298,17 @@ mm_object_get_modem_simple (MMObject *self)
* mm_object_peek_modem_simple: (skip)
* @self: A #MMObject.
*
* Like mm_object_get_modem_simple() but doesn't increase the reference count on the returned object.
* Like mm_object_get_modem_simple() but doesn't increase the reference count on
* the returned object.
*
* <warning>It is not safe to use the returned object if you are on another thread than the one where the #MMManager is running.</warning>
* <warning>It is not safe to use the returned object if you are on another
* thread than the one where the #MMManager is running.</warning>
*
* Returns: (transfer none): A #MMModemSimple or %NULL if @self does not implement the interface. Do not free the returned object, it is owned by @self.
* Returns: (transfer none): A #MMModemSimple or %NULL if @self does not
* implement the interface. Do not free the returned object, it is owned by
* @self.
*
* Since: 1.0
*/
MMModemSimple *
mm_object_peek_modem_simple (MMObject *self)
@@ -272,9 +324,13 @@ mm_object_peek_modem_simple (MMObject *self)
* mm_object_get_modem_location:
* @self: A #MMObject.
*
* Gets the #MMModemLocation instance for the D-Bus interface org.freedesktop.ModemManager1.Modem.Modemlocation on @self, if any.
* Gets the #MMModemLocation instance for the D-Bus interface
* org.freedesktop.ModemManager1.Modem.Modemlocation on @self, if any.
*
* Returns: (transfer full): A #MMModemLocation that must be freed with g_object_unref() or %NULL if @self does not implement the interface.
* Returns: (transfer full): A #MMModemLocation that must be freed with
* g_object_unref() or %NULL if @self does not implement the interface.
*
* Since: 1.0
*/
MMModemLocation *
mm_object_get_modem_location (MMObject *self)
@@ -288,11 +344,17 @@ mm_object_get_modem_location (MMObject *self)
* mm_object_peek_modem_location: (skip)
* @self: A #MMObject.
*
* Like mm_object_get_modem_location() but doesn't increase the reference count on the returned object.
* Like mm_object_get_modem_location() but doesn't increase the reference count
* on the returned object.
*
* <warning>It is not safe to use the returned object if you are on another thread than the one where the #MMManager is running.</warning>
* <warning>It is not safe to use the returned object if you are on another
* thread than the one where the #MMManager is running.</warning>
*
* Returns: (transfer none): A #MMModemLocation or %NULL if @self does not implement the interface. Do not free the returned object, it is owned by @self.
* Returns: (transfer none): A #MMModemLocation or %NULL if @self does not
* implement the interface. Do not free the returned object, it is owned by
* @self.
*
* Since: 1.0
*/
MMModemLocation *
mm_object_peek_modem_location (MMObject *self)
@@ -308,9 +370,13 @@ mm_object_peek_modem_location (MMObject *self)
* mm_object_get_modem_messaging:
* @self: A #MMObject.
*
* Gets the #MMModemMessaging instance for the D-Bus interface org.freedesktop.ModemManager1.Modem.Modemmessaging on @self, if any.
* Gets the #MMModemMessaging instance for the D-Bus interface
* org.freedesktop.ModemManager1.Modem.Modemmessaging on @self, if any.
*
* Returns: (transfer full): A #MMModemMessaging that must be freed with g_object_unref() or %NULL if @self does not implement the interface.
* Returns: (transfer full): A #MMModemMessaging that must be freed with
* g_object_unref() or %NULL if @self does not implement the interface.
*
* Since: 1.0
*/
MMModemMessaging *
mm_object_get_modem_messaging (MMObject *self)
@@ -324,11 +390,17 @@ mm_object_get_modem_messaging (MMObject *self)
* mm_object_peek_modem_messaging: (skip)
* @self: A #MMObject.
*
* Like mm_object_get_modem_messaging() but doesn't increase the reference count on the returned object.
* Like mm_object_get_modem_messaging() but doesn't increase the reference count
* on the returned object.
*
* <warning>It is not safe to use the returned object if you are on another thread than the one where the #MMManager is running.</warning>
* <warning>It is not safe to use the returned object if you are on another
* thread than the one where the #MMManager is running.</warning>
*
* Returns: (transfer none): A #MMModemMessaging or %NULL if @self does not implement the interface. Do not free the returned object, it is owned by @self.
* Returns: (transfer none): A #MMModemMessaging or %NULL if @self does not
* implement the interface. Do not free the returned object, it is owned by
* @self.
*
* Since: 1.0
*/
MMModemMessaging *
mm_object_peek_modem_messaging (MMObject *self)
@@ -344,9 +416,13 @@ mm_object_peek_modem_messaging (MMObject *self)
* mm_object_get_modem_voice:
* @self: A #MMObject.
*
* Gets the #MMModemVoice instance for the D-Bus interface org.freedesktop.ModemManager1.Modem.Modemvoice on @self, if any.
* Gets the #MMModemVoice instance for the D-Bus interface
* org.freedesktop.ModemManager1.Modem.Modemvoice on @self, if any.
*
* Returns: (transfer full): A #MMModemVoice that must be freed with g_object_unref() or %NULL if @self does not implement the interface.
* Returns: (transfer full): A #MMModemVoice that must be freed with
* g_object_unref() or %NULL if @self does not implement the interface.
*
* Since: 1.6
*/
MMModemVoice *
mm_object_get_modem_voice (MMObject *self)
@@ -360,11 +436,17 @@ mm_object_get_modem_voice (MMObject *self)
* mm_object_peek_modem_voice: (skip)
* @self: A #MMObject.
*
* Like mm_object_get_modem_voice() but doesn't increase the reference count on the returned object.
* Like mm_object_get_modem_voice() but doesn't increase the reference count on
* the returned object.
*
* <warning>It is not safe to use the returned object if you are on another thread than the one where the #MMManager is running.</warning>
* <warning>It is not safe to use the returned object if you are on another
* thread than the one where the #MMManager is running.</warning>
*
* Returns: (transfer none): A #MMModemVoice or %NULL if @self does not implement the interface. Do not free the returned object, it is owned by @self.
* Returns: (transfer none): A #MMModemVoice or %NULL if @self does not
* implement the interface. Do not free the returned object, it is owned by
* @self.
*
* Since: 1.6
*/
MMModemVoice *
mm_object_peek_modem_voice (MMObject *self)
@@ -380,9 +462,13 @@ mm_object_peek_modem_voice (MMObject *self)
* mm_object_get_modem_time:
* @self: A #MMObject.
*
* Gets the #MMModemTime instance for the D-Bus interface org.freedesktop.ModemManager1.Modem.Time on @self, if any.
* Gets the #MMModemTime instance for the D-Bus interface
* org.freedesktop.ModemManager1.Modem.Time on @self, if any.
*
* Returns: (transfer full): A #MMModemTime that must be freed with g_object_unref() or %NULL if @self does not implement the interface.
* Returns: (transfer full): A #MMModemTime that must be freed with
* g_object_unref() or %NULL if @self does not implement the interface.
*
* Since: 1.0
*/
MMModemTime *
mm_object_get_modem_time (MMObject *self)
@@ -396,11 +482,16 @@ mm_object_get_modem_time (MMObject *self)
* mm_object_peek_modem_time: (skip)
* @self: A #MMObject.
*
* Like mm_object_get_modem_time() but doesn't increase the reference count on the returned object.
* Like mm_object_get_modem_time() but doesn't increase the reference count on
* the returned object.
*
* <warning>It is not safe to use the returned object if you are on another thread than the one where the #MMManager is running.</warning>
* <warning>It is not safe to use the returned object if you are on another
* thread than the one where the #MMManager is running.</warning>
*
* Returns: (transfer none): A #MMModemTime or %NULL if @self does not implement the interface. Do not free the returned object, it is owned by @self.
* Returns: (transfer none): A #MMModemTime or %NULL if @self does not implement
* the interface. Do not free the returned object, it is owned by @self.
*
* Since: 1.0
*/
MMModemTime *
mm_object_peek_modem_time (MMObject *self)
@@ -416,9 +507,13 @@ mm_object_peek_modem_time (MMObject *self)
* mm_object_get_modem_firmware:
* @self: A #MMObject.
*
* Gets the #MMModemFirmware instance for the D-Bus interface org.freedesktop.ModemManager1.Modem.Firmware on @self, if any.
* Gets the #MMModemFirmware instance for the D-Bus interface
* org.freedesktop.ModemManager1.Modem.Firmware on @self, if any.
*
* Returns: (transfer full): A #MMModemFirmware that must be freed with g_object_unref() or %NULL if @self does not implement the interface.
* Returns: (transfer full): A #MMModemFirmware that must be freed with
* g_object_unref() or %NULL if @self does not implement the interface.
*
* Since: 1.0
*/
MMModemFirmware *
mm_object_get_modem_firmware (MMObject *self)
@@ -432,11 +527,17 @@ mm_object_get_modem_firmware (MMObject *self)
* mm_object_peek_modem_firmware: (skip)
* @self: A #MMObject.
*
* Like mm_object_get_modem_firmware() but doesn't increase the reference count on the returned object.
* Like mm_object_get_modem_firmware() but doesn't increase the reference count
* on the returned object.
*
* <warning>It is not safe to use the returned object if you are on another thread than the one where the #MMManager is running.</warning>
* <warning>It is not safe to use the returned object if you are on another
* thread than the one where the #MMManager is running.</warning>
*
* Returns: (transfer none): A #MMModemFirmware or %NULL if @self does not implement the interface. Do not free the returned object, it is owned by @self.
* Returns: (transfer none): A #MMModemFirmware or %NULL if @self does not
* implement the interface. Do not free the returned object, it is owned by
* @self.
*
* Since: 1.0
*/
MMModemFirmware *
mm_object_peek_modem_firmware (MMObject *self)
@@ -452,9 +553,13 @@ mm_object_peek_modem_firmware (MMObject *self)
* mm_object_get_modem_signal:
* @self: A #MMObject.
*
* Gets the #MMModemSignal instance for the D-Bus interface org.freedesktop.ModemManager1.Modem.Signal on @self, if any.
* Gets the #MMModemSignal instance for the D-Bus interface
* org.freedesktop.ModemManager1.Modem.Signal on @self, if any.
*
* Returns: (transfer full): A #MMModemSignal that must be freed with g_object_unref() or %NULL if @self does not implement the interface.
* Returns: (transfer full): A #MMModemSignal that must be freed with
* g_object_unref() or %NULL if @self does not implement the interface.
*
* Since: 1.2
*/
MMModemSignal *
mm_object_get_modem_signal (MMObject *self)
@@ -468,11 +573,17 @@ mm_object_get_modem_signal (MMObject *self)
* mm_object_peek_modem_signal: (skip)
* @self: A #MMObject.
*
* Like mm_object_get_modem_signal() but doesn't increase the reference count on the returned object.
* Like mm_object_get_modem_signal() but doesn't increase the reference count on
* the returned object.
*
* <warning>It is not safe to use the returned object if you are on another thread than the one where the #MMManager is running.</warning>
* <warning>It is not safe to use the returned object if you are on another
* thread than the one where the #MMManager is running.</warning>
*
* Returns: (transfer none): A #MMModemSignal or %NULL if @self does not implement the interface. Do not free the returned object, it is owned by @self.
* Returns: (transfer none): A #MMModemSignal or %NULL if @self does not
* implement the interface. Do not free the returned object, it is owned by
* @self.
*
* Since: 1.2
*/
MMModemSignal *
mm_object_peek_modem_signal (MMObject *self)
@@ -488,9 +599,13 @@ mm_object_peek_modem_signal (MMObject *self)
* mm_object_get_modem_oma:
* @self: A #MMObject.
*
* Gets the #MMModemOma instance for the D-Bus interface org.freedesktop.ModemManager1.Modem.Oma on @self, if any.
* Gets the #MMModemOma instance for the D-Bus interface
* org.freedesktop.ModemManager1.Modem.Oma on @self, if any.
*
* Returns: (transfer full): A #MMModemOma that must be freed with g_object_unref() or %NULL if @self does not implement the interface.
* Returns: (transfer full): A #MMModemOma that must be freed with
* g_object_unref() or %NULL if @self does not implement the interface.
*
* Since: 1.2
*/
MMModemOma *
mm_object_get_modem_oma (MMObject *self)
@@ -504,11 +619,16 @@ mm_object_get_modem_oma (MMObject *self)
* mm_object_peek_modem_oma: (skip)
* @self: A #MMObject.
*
* Like mm_object_get_modem_oma() but doesn't increase the reference count on the returned object.
* Like mm_object_get_modem_oma() but doesn't increase the reference count on
* the returned object.
*
* <warning>It is not safe to use the returned object if you are on another thread than the one where the #MMManager is running.</warning>
* <warning>It is not safe to use the returned object if you are on another
* thread than the one where the #MMManager is running.</warning>
*
* Returns: (transfer none): A #MMModemOma or %NULL if @self does not implement the interface. Do not free the returned object, it is owned by @self.
* Returns: (transfer none): A #MMModemOma or %NULL if @self does not implement
* the interface. Do not free the returned object, it is owned by @self.
*
* Since: 1.2
*/
MMModemOma *
mm_object_peek_modem_oma (MMObject *self)

34
libmm-glib/mm-pco.c
View File

@@ -32,7 +32,7 @@
* This object is retrieved with mm_modem_3gpp_get_pco().
*/
G_DEFINE_TYPE (MMPco, mm_pco, G_TYPE_OBJECT);
G_DEFINE_TYPE (MMPco, mm_pco, G_TYPE_OBJECT)
struct _MMPcoPrivate {
/* Session ID, signature 'u' */
@@ -77,6 +77,8 @@ _g_variant_get_bytes (GVariant *variant)
* Gets the session ID associated with the PCO.
*
* Returns: the session ID.
*
* Since: 1.10
*/
guint32
mm_pco_get_session_id (MMPco *self)
@@ -104,7 +106,10 @@ mm_pco_set_session_id (MMPco *self,
* Gets the complete flag that indicates whether the PCO data contains the
* complete PCO structure received from the network.
*
* Returns: %TRUE if the PCO data contains the complete PCO structure, %FALSE otherwise.
* Returns: %TRUE if the PCO data contains the complete PCO structure, %FALSE
* otherwise.
*
* Since: 1.10
*/
gboolean
mm_pco_is_complete (MMPco *self)
@@ -133,6 +138,8 @@ mm_pco_set_complete (MMPco *self,
* Gets the PCO data in raw bytes.
*
* Returns: (transfer none): the PCO data, or %NULL if it doesn't contain any.
*
* Since: 1.10
*/
const guint8 *
mm_pco_get_data (MMPco *self,
@@ -158,16 +165,6 @@ mm_pco_set_data (MMPco *self,
/*****************************************************************************/
/**
* mm_pco_from_variant:
* @variant: A variant with the PCO information.
* @error: Return location for error or %NULL.
*
* Creates a new #MMPco object with the values exposed in
* the variant.
*
* Returns: (transfer full): A #MMPco or %NULL if @error is set. The returned value should be freed with g_object_unref().
*/
MMPco *
mm_pco_from_variant (GVariant *variant,
GError **error)
@@ -203,14 +200,6 @@ mm_pco_from_variant (GVariant *variant,
/*****************************************************************************/
/**
* mm_pco_to_variant:
* @self: a #MMPco.
*
* Gets a GVariant representation with signature "(ubay)" of @self.
*
* Returns: (transfer full): A #GVariant representation of the #MMPco object. The returned value should be freed with g_variant_unref().
*/
GVariant *
mm_pco_to_variant (MMPco *self)
{
@@ -244,9 +233,12 @@ mm_pco_to_variant (MMPco *self)
/**
* mm_pco_list_free:
* @pco_list: (transfer full)(element-type ModemManager.Pco): a #GList of #MMPco.
* @pco_list: (transfer full)(element-type ModemManager.Pco): a #GList of
* #MMPco.
*
* Frees all of the memory used by a #GList of #MMPco.
*
* Since: 1.10
*/
void
mm_pco_list_free (GList *pco_list)

34
libmm-glib/mm-signal.c
View File

@@ -60,6 +60,8 @@ struct _MMSignalPrivate {
* Gets the RSSI (Received Signal Strength Indication), in dBm.
*
* Returns: the RSSI, or %MM_SIGNAL_UNKNOWN if unknown.
*
* Since: 1.2
*/
gdouble
mm_signal_get_rssi (MMSignal *self)
@@ -87,6 +89,8 @@ mm_signal_set_rssi (MMSignal *self,
* Gets the RSCP (Received Signal Code Power), in dBm.
*
* Returns: the RSCP, or %MM_SIGNAL_UNKNOWN if unknown.
*
* Since: 1.2
*/
gdouble
mm_signal_get_rscp (MMSignal *self)
@@ -116,6 +120,8 @@ mm_signal_set_rscp (MMSignal *self,
* Only applicable to CDMA1x, CDMA EV-DO and UMTS (WCDMA).
*
* Returns: the ECIO, or %MM_SIGNAL_UNKNOWN if unknown.
*
* Since: 1.2
*/
gdouble
mm_signal_get_ecio (MMSignal *self)
@@ -145,6 +151,8 @@ mm_signal_set_ecio (MMSignal *self,
* Only applicable to CDMA EV-DO.
*
* Returns: the SINR, or %MM_SIGNAL_UNKNOWN if unknown.
*
* Since: 1.2
*/
gdouble
mm_signal_get_sinr (MMSignal *self)
@@ -174,6 +182,8 @@ mm_signal_set_sinr (MMSignal *self,
* Only applicable to CDMA EV-DO.
*
* Returns: the Io, or %MM_SIGNAL_UNKNOWN if unknown.
*
* Since: 1.2
*/
gdouble
mm_signal_get_io (MMSignal *self)
@@ -203,6 +213,8 @@ mm_signal_set_io (MMSignal *self,
* Only applicable to LTE.
*
* Returns: the RSRP, or %MM_SIGNAL_UNKNOWN if unknown.
*
* Since: 1.2
*/
gdouble
mm_signal_get_rsrp (MMSignal *self)
@@ -232,6 +244,8 @@ mm_signal_set_rsrp (MMSignal *self,
* Only applicable to LTE.
*
* Returns: the RSRQ, or %MM_SIGNAL_UNKNOWN if unknown.
*
* Since: 1.2
*/
gdouble
mm_signal_get_rsrq (MMSignal *self)
@@ -261,6 +275,8 @@ mm_signal_set_rsrq (MMSignal *self,
* Only applicable to LTE.
*
* Returns: the S/R ratio, or %MM_SIGNAL_UNKNOWN if unknown.
*
* Since: 1.2
*/
gdouble
mm_signal_get_snr (MMSignal *self)
@@ -281,14 +297,6 @@ mm_signal_set_snr (MMSignal *self,
/*****************************************************************************/
/**
* mm_signal_get_dictionary:
* @self: A #MMSignal.
*
* Gets a variant dictionary with the contents of @self.
*
* Returns: (transfer full): A dictionary with the signal values. The returned value should be freed with g_variant_unref().
*/
GVariant *
mm_signal_get_dictionary (MMSignal *self)
{
@@ -390,16 +398,6 @@ consume_variant (MMSignal *self,
return TRUE;
}
/**
* mm_signal_new_from_dictionary:
* @dictionary: A variant dictionary with the signal information.
* @error: Return location for error or %NULL.
*
* Creates a new #MMSignal object with the values exposed in
* the dictionary.
*
* Returns: (transfer full): A #MMSignal or %NULL if @error is set. The returned value should be freed with g_object_unref().
*/
MMSignal *
mm_signal_new_from_dictionary (GVariant *dictionary,
GError **error)

2
libmm-glib/mm-signal.h
View File

@@ -29,6 +29,8 @@ G_BEGIN_DECLS
* MM_SIGNAL_UNKNOWN:
*
* Identifier for an unknown signal value.
*
* Since: 1.2
*/
#define MM_SIGNAL_UNKNOWN -G_MAXDOUBLE

209
libmm-glib/mm-sim.c
View File

@@ -47,6 +47,8 @@ G_DEFINE_TYPE (MMSim, mm_sim, MM_GDBUS_TYPE_SIM_PROXY)
* Gets the DBus path of the #MMSim object.
*
* Returns: (transfer none): The DBus path of the #MMSim object.
*
* Since: 1.0
*/
const gchar *
mm_sim_get_path (MMSim *self)
@@ -63,7 +65,10 @@ mm_sim_get_path (MMSim *self)
*
* Gets a copy of the DBus path of the #MMSim object.
*
* Returns: (transfer full): The DBus path of the #MMSim object. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMSim object. The returned
* value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_sim_dup_path (MMSim *self)
@@ -87,12 +92,14 @@ mm_sim_dup_path (MMSim *self)
*
* Gets the unique SIM identifier of the #MMSim object.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_sim_dup_identifier() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_sim_dup_identifier() if on another thread.</warning>
*
* Returns: (transfer none): The unique identifier of the #MMSim object, or %NULL if it couldn't be retrieved.
* Returns: (transfer none): The unique identifier of the #MMSim object, or
* %NULL if it couldn't be retrieved.
*
* Since: 1.0
*/
const gchar *
mm_sim_get_identifier (MMSim *self)
@@ -109,7 +116,11 @@ mm_sim_get_identifier (MMSim *self)
*
* Gets a copy of the unique SIM identifier of the #MMSim object.
*
* Returns: (transfer full): The unique identifier of the #MMSim object, or %NULL if it couldn't be retrieved. The returned value should be freed with g_free().
* Returns: (transfer full): The unique identifier of the #MMSim object, or
* %NULL if it couldn't be retrieved. The returned value should be freed with
* g_free().
*
* Since: 1.0
*/
gchar *
mm_sim_dup_identifier (MMSim *self)
@@ -126,14 +137,17 @@ mm_sim_dup_identifier (MMSim *self)
* mm_sim_get_imsi:
* @self: A #MMSim.
*
* Gets the International Mobile Subscriber Identity (IMSI) of the #MMSim object.
* Gets the International Mobile Subscriber Identity (IMSI) of the #MMSim
* object.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_sim_dup_imsi() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_sim_dup_imsi() if on another thread.</warning>
*
* Returns: (transfer none): The IMSI of the #MMSim object, or %NULL if it couldn't be retrieved.
* Returns: (transfer none): The IMSI of the #MMSim object, or %NULL if it
* couldn't be retrieved.
*
* Since: 1.0
*/
const gchar *
mm_sim_get_imsi (MMSim *self)
@@ -148,9 +162,13 @@ mm_sim_get_imsi (MMSim *self)
* mm_sim_dup_imsi:
* @self: A #MMSim.
*
* Gets a copy of the International Mobile Subscriber Identity (IMSI) of the #MMSim object.
* Gets a copy of the International Mobile Subscriber Identity (IMSI) of the
* #MMSim object.
*
* Returns: (transfer full): The IMSI of the #MMSim object, or %NULL if it couldn't be retrieved. The returned value should be freed with g_free().
* Returns: (transfer full): The IMSI of the #MMSim object, or %NULL if it
* couldn't be retrieved. The returned value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_sim_dup_imsi (MMSim *self)
@@ -169,12 +187,14 @@ mm_sim_dup_imsi (MMSim *self)
*
* Gets the Operator Identifier of the #MMSim object.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_sim_dup_operator_identifier() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_sim_dup_operator_identifier() if on another thread.</warning>
*
* Returns: (transfer none): The Operator Identifier of the #MMSim object, or %NULL if it couldn't be retrieved.
* Returns: (transfer none): The Operator Identifier of the #MMSim object, or
* %NULL if it couldn't be retrieved.
*
* Since: 1.0
*/
const gchar *
mm_sim_get_operator_identifier (MMSim *self)
@@ -191,7 +211,11 @@ mm_sim_get_operator_identifier (MMSim *self)
*
* Gets a copy of the Operator Identifier of the #MMSim object.
*
* Returns: (transfer full): The Operator Identifier of the #MMSim object, or %NULL if it couldn't be retrieved. The returned value should be freed with g_free().
* Returns: (transfer full): The Operator Identifier of the #MMSim object, or
* %NULL if it couldn't be retrieved. The returned value should be freed with
* g_free().
*
* Since: 1.0
*/
gchar *
mm_sim_dup_operator_identifier (MMSim *self)
@@ -210,12 +234,14 @@ mm_sim_dup_operator_identifier (MMSim *self)
*
* Gets the Operator Name of the #MMSim object.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_sim_dup_operator_name() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_sim_dup_operator_name() if on another thread.</warning>
*
* Returns: (transfer none): The Operator Name of the #MMSim object, or %NULL if it couldn't be retrieved.
* Returns: (transfer none): The Operator Name of the #MMSim object, or %NULL if
* it couldn't be retrieved.
*
* Since: 1.0
*/
const gchar *
mm_sim_get_operator_name (MMSim *self)
@@ -232,7 +258,10 @@ mm_sim_get_operator_name (MMSim *self)
*
* Gets a copy of the Operator Name of the #MMSim object.
*
* Returns: (transfer full): The Operator Name of the #MMSim object, or %NULL if it couldn't be retrieved. The returned value should be freed with g_free().
* Returns: (transfer full): The Operator Name of the #MMSim object, or %NULL if
* it couldn't be retrieved. The returned value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_sim_dup_operator_name (MMSim *self)
@@ -251,12 +280,14 @@ mm_sim_dup_operator_name (MMSim *self)
*
* Gets the list of emergency call numbers programmed in the SIM card.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_sim_dup_emergency_numbers() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_sim_dup_emergency_numbers() if on another thread.</warning>
*
* Returns: (transfer none): The emergency numbers, or %NULL if none available. Do not free the returned value, it belongs to @self.
* Returns: (transfer none): The emergency numbers, or %NULL if none available.
* Do not free the returned value, it belongs to @self.
*
* Since: 1.12
*/
const gchar * const *
mm_sim_get_emergency_numbers (MMSim *self)
@@ -272,7 +303,10 @@ mm_sim_get_emergency_numbers (MMSim *self)
*
* Gets a copy of the list of emergency call numbers programmed in the SIM card.
*
* Returns: (transfer full): The emergency numbers, or %NULL if none available. The returned value should be freed with g_strfreev().
* Returns: (transfer full): The emergency numbers, or %NULL if none available.
* The returned value should be freed with g_strfreev().
*
* Since: 1.12
*/
gchar **
mm_sim_dup_emergency_numbers (MMSim *self)
@@ -287,12 +321,15 @@ mm_sim_dup_emergency_numbers (MMSim *self)
/**
* mm_sim_send_pin_finish:
* @self: A #MMSim.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_sim_send_pin().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_sim_send_pin().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_sim_send_pin().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_sim_send_pin_finish (MMSim *self,
@@ -309,15 +346,21 @@ mm_sim_send_pin_finish (MMSim *self,
* @self: A #MMSim.
* @pin: The PIN code.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously sends the PIN code to the SIM card.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_sim_send_pin_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_sim_send_pin_finish() to get the result of the operation.
*
* See mm_sim_send_pin_sync() for the synchronous, blocking version of this method.
* See mm_sim_send_pin_sync() for the synchronous, blocking version of this
* method.
*
* Since: 1.0
*/
void
mm_sim_send_pin (MMSim *self,
@@ -344,10 +387,12 @@ mm_sim_send_pin (MMSim *self,
*
* Synchronously sends the PIN to the SIM card.
*
* The calling thread is blocked until a reply is received.
* See mm_sim_send_pin() for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See
* mm_sim_send_pin() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_sim_send_pin_sync (MMSim *self,
@@ -368,12 +413,15 @@ mm_sim_send_pin_sync (MMSim *self,
/**
* mm_sim_send_puk_finish:
* @self: A #MMSim.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_sim_send_puk().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_sim_send_puk().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_sim_send_puk().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_sim_send_puk_finish (MMSim *self,
@@ -391,15 +439,21 @@ mm_sim_send_puk_finish (MMSim *self,
* @puk: The PUK code.
* @pin: The PIN code.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously sends the PUK code to the SIM card.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_sim_send_puk_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_sim_send_puk_finish() to get the result of the operation.
*
* See mm_sim_send_puk_sync() for the synchronous, blocking version of this method.
* See mm_sim_send_puk_sync() for the synchronous, blocking version of this
* method.
*
* Since: 1.0
*/
void
mm_sim_send_puk (MMSim *self,
@@ -433,6 +487,8 @@ mm_sim_send_puk (MMSim *self,
* See mm_sim_send_puk() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_sim_send_puk_sync (MMSim *self,
@@ -455,12 +511,15 @@ mm_sim_send_puk_sync (MMSim *self,
/**
* mm_sim_enable_pin_finish:
* @self: A #MMSim.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_sim_enable_pin().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_sim_enable_pin().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_sim_enable_pin().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_sim_enable_pin_finish (MMSim *self,
@@ -477,15 +536,21 @@ mm_sim_enable_pin_finish (MMSim *self,
* @self: A #MMSim.
* @pin: The PIN code.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously enables requesting the PIN code in the SIM card.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_sim_enable_pin_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_sim_enable_pin_finish() to get the result of the operation.
*
* See mm_sim_enable_pin_sync() for the synchronous, blocking version of this method.
* See mm_sim_enable_pin_sync() for the synchronous, blocking version of this
* method.
*
* Since: 1.0
*/
void
mm_sim_enable_pin (MMSim *self,
@@ -517,6 +582,8 @@ mm_sim_enable_pin (MMSim *self,
* See mm_sim_enable_pin() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_sim_enable_pin_sync (MMSim *self,
@@ -538,12 +605,15 @@ mm_sim_enable_pin_sync (MMSim *self,
/**
* mm_sim_disable_pin_finish:
* @self: A #MMSim.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_sim_disable_pin().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_sim_disable_pin().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_sim_disable_pin().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_sim_disable_pin_finish (MMSim *self,
@@ -560,15 +630,21 @@ mm_sim_disable_pin_finish (MMSim *self,
* @self: A #MMSim.
* @pin: The PIN code.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously disables requesting the PIN code in the SIM card.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_sim_disable_pin_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_sim_disable_pin_finish() to get the result of the operation.
*
* See mm_sim_disable_pin_sync() for the synchronous, blocking version of this method.
* See mm_sim_disable_pin_sync() for the synchronous, blocking version of this
* method.
*
* Since: 1.0
*/
void
mm_sim_disable_pin (MMSim *self,
@@ -600,6 +676,8 @@ mm_sim_disable_pin (MMSim *self,
* See mm_sim_disable_pin() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_sim_disable_pin_sync (MMSim *self,
@@ -621,12 +699,15 @@ mm_sim_disable_pin_sync (MMSim *self,
/**
* mm_sim_change_pin_finish:
* @self: A #MMSim.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_sim_change_pin().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_sim_change_pin().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_sim_change_pin().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_sim_change_pin_finish (MMSim *self,
@@ -644,15 +725,21 @@ mm_sim_change_pin_finish (MMSim *self,
* @old_pin: The current PIN code.
* @new_pin: The new PIN code to be set.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously changes the PIN code in the SIM card.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_sim_change_pin_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_sim_change_pin_finish() to get the result of the operation.
*
* See mm_sim_change_pin_sync() for the synchronous, blocking version of this method.
* See mm_sim_change_pin_sync() for the synchronous, blocking version of this
* method.
*
* Since: 1.0
*/
void
mm_sim_change_pin (MMSim *self,
@@ -686,6 +773,8 @@ mm_sim_change_pin (MMSim *self,
* See mm_sim_change_pin() for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_sim_change_pin_sync (MMSim *self,

76
libmm-glib/mm-simple-connect-properties.c
View File

@@ -31,10 +31,10 @@
* mm_modem_simple_connect() or mm_modem_simple_connect_sync().
*/
G_DEFINE_TYPE (MMSimpleConnectProperties, mm_simple_connect_properties, G_TYPE_OBJECT);
G_DEFINE_TYPE (MMSimpleConnectProperties, mm_simple_connect_properties, G_TYPE_OBJECT)
#define PROPERTY_PIN "pin"
#define PROPERTY_OPERATOR_ID "operator-id"
#define PROPERTY_PIN "pin"
#define PROPERTY_OPERATOR_ID "operator-id"
struct _MMSimpleConnectPropertiesPrivate {
/* PIN */
@@ -53,6 +53,8 @@ struct _MMSimpleConnectPropertiesPrivate {
* @pin: PIN code.
*
* Sets the PIN code to use when unlocking the modem.
*
* Since: 1.0
*/
void
mm_simple_connect_properties_set_pin (MMSimpleConnectProperties *self,
@@ -70,7 +72,10 @@ mm_simple_connect_properties_set_pin (MMSimpleConnectProperties *self,
*
* Gets the PIN code to use when unlocking the modem.
*
* Returns: (transfer none): the PIN, or #NULL if not set. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): the PIN, or #NULL if not set. Do not free the
* returned value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_simple_connect_properties_get_pin (MMSimpleConnectProperties *self)
@@ -88,6 +93,8 @@ mm_simple_connect_properties_get_pin (MMSimpleConnectProperties *self)
* @operator_id: operator ID, given as MCC/MNC.
*
* Sets the ID of the network to which register before connecting.
*
* Since: 1.0
*/
void
mm_simple_connect_properties_set_operator_id (MMSimpleConnectProperties *self,
@@ -105,7 +112,10 @@ mm_simple_connect_properties_set_operator_id (MMSimpleConnectProperties *self,
*
* Gets the ID of the network to which register before connecting.
*
* Returns: (transfer none): the operator ID, or #NULL if not set. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): the operator ID, or #NULL if not set. Do not free
* the returned value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_simple_connect_properties_get_operator_id (MMSimpleConnectProperties *self)
@@ -123,6 +133,8 @@ mm_simple_connect_properties_get_operator_id (MMSimpleConnectProperties *self)
* @apn: Name of the access point.
*
* Sets the name of the access point to use when connecting.
*
* Since: 1.0
*/
void
mm_simple_connect_properties_set_apn (MMSimpleConnectProperties *self,
@@ -140,7 +152,10 @@ mm_simple_connect_properties_set_apn (MMSimpleConnectProperties *self,
*
* Gets the name of the access point to use when connecting.
*
* Returns: (transfer none): the access point, or #NULL if not set. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): the access point, or #NULL if not set. Do not free
* the returned value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_simple_connect_properties_get_apn (MMSimpleConnectProperties *self)
@@ -155,9 +170,12 @@ mm_simple_connect_properties_get_apn (MMSimpleConnectProperties *self)
/**
* mm_simple_connect_properties_set_allowed_auth:
* @self: a #MMSimpleConnectProperties.
* @allowed_auth: a bitmask of #MMBearerAllowedAuth values. %MM_BEARER_ALLOWED_AUTH_UNKNOWN may be given to request the modem-default method.
* @allowed_auth: a bitmask of #MMBearerAllowedAuth values.
* %MM_BEARER_ALLOWED_AUTH_UNKNOWN may be given to request the modem-default method.
*
* Sets the authentication method to use.
*
* Since: 1.0
*/
void
mm_simple_connect_properties_set_allowed_auth (MMSimpleConnectProperties *self,
@@ -174,7 +192,10 @@ mm_simple_connect_properties_set_allowed_auth (MMSimpleConnectProperties *self,
*
* Gets the authentication methods allowed in the connection.
*
* Returns: a bitmask of #MMBearerAllowedAuth values, or %MM_BEARER_ALLOWED_AUTH_UNKNOWN to request the modem-default method.
* Returns: a bitmask of #MMBearerAllowedAuth values, or
* %MM_BEARER_ALLOWED_AUTH_UNKNOWN to request the modem-default method.
*
* Since: 1.0
*/
MMBearerAllowedAuth
mm_simple_connect_properties_get_allowed_auth (MMSimpleConnectProperties *self)
@@ -192,6 +213,8 @@ mm_simple_connect_properties_get_allowed_auth (MMSimpleConnectProperties *self)
* @user: the username
*
* Sets the username used to authenticate with the access point.
*
* Since: 1.0
*/
void
mm_simple_connect_properties_set_user (MMSimpleConnectProperties *self,
@@ -209,7 +232,10 @@ mm_simple_connect_properties_set_user (MMSimpleConnectProperties *self,
*
* Gets the username used to authenticate with the access point.
*
* Returns: (transfer none): the username, or #NULL if not set. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): the username, or #NULL if not set. Do not free the
* returned value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_simple_connect_properties_get_user (MMSimpleConnectProperties *self)
@@ -227,6 +253,8 @@ mm_simple_connect_properties_get_user (MMSimpleConnectProperties *self)
* @password: the password
*
* Sets the password used to authenticate with the access point.
*
* Since: 1.0
*/
void
mm_simple_connect_properties_set_password (MMSimpleConnectProperties *self,
@@ -244,7 +272,10 @@ mm_simple_connect_properties_set_password (MMSimpleConnectProperties *self,
*
* Gets the password used to authenticate with the access point.
*
* Returns: (transfer none): the password, or #NULL if not set. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): the password, or #NULL if not set. Do not free the
* returned value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_simple_connect_properties_get_password (MMSimpleConnectProperties *self)
@@ -262,6 +293,8 @@ mm_simple_connect_properties_get_password (MMSimpleConnectProperties *self)
* @ip_type: a #MMBearerIpFamily.
*
* Sets the IP type to use.
*
* Since: 1.0
*/
void
mm_simple_connect_properties_set_ip_type (MMSimpleConnectProperties *self,
@@ -280,6 +313,8 @@ mm_simple_connect_properties_set_ip_type (MMSimpleConnectProperties *self,
* Sets the IP type to use.
*
* Returns: a #MMBearerIpFamily.
*
* Since: 1.0
*/
MMBearerIpFamily
mm_simple_connect_properties_get_ip_type (MMSimpleConnectProperties *self)
@@ -298,6 +333,8 @@ mm_simple_connect_properties_get_ip_type (MMSimpleConnectProperties *self)
*
* Sets the flag to indicate whether roaming is allowed or not in the
* connection.
*
* Since: 1.0
*/
void
mm_simple_connect_properties_set_allow_roaming (MMSimpleConnectProperties *self,
@@ -315,7 +352,9 @@ mm_simple_connect_properties_set_allow_roaming (MMSimpleConnectProperties *self,
*
* Checks whether roaming is allowed in the connection.
*
* Returns: %TRUE if roaming is allowed, %FALSE otherwise..
* Returns: %TRUE if roaming is allowed, %FALSE otherwise.
*
* Since: 1.0
*/
gboolean
mm_simple_connect_properties_get_allow_roaming (MMSimpleConnectProperties *self)
@@ -337,6 +376,7 @@ mm_simple_connect_properties_get_allow_roaming (MMSimpleConnectProperties *self)
*
* Sets the number to use when performing the connection.
*
* Since: 1.0
* Deprecated: 1.10.0. The number setting is not used anywhere, and therefore
* it doesn't make sense to expose it in the ModemManager interface.
*/
@@ -355,8 +395,10 @@ mm_simple_connect_properties_set_number (MMSimpleConnectProperties *self,
*
* Gets the number to use when performing the connection.
*
* Returns: (transfer none): the number, or #NULL if not set. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): the number, or #NULL if not set. Do not free the
* returned value, it is owned by @self.
*
* Since: 1.0
* Deprecated: 1.10.0. The number setting is not used anywhere, and therefore
* it doesn't make sense to expose it in the ModemManager interface.
*/
@@ -373,14 +415,6 @@ mm_simple_connect_properties_get_number (MMSimpleConnectProperties *self)
/*****************************************************************************/
/**
* mm_simple_connect_properties_get_bearer_properties:
* @self: a #MMSimpleConnectProperties:
*
* Returns the bearer properties of @self.
*
* Returns: (transfer full): a #MMBearerProperties
*/
MMBearerProperties *
mm_simple_connect_properties_get_bearer_properties (MMSimpleConnectProperties *self)
{
@@ -567,6 +601,8 @@ mm_simple_connect_properties_new_from_dictionary (GVariant *dictionary,
* Creates a new empty #MMSimpleConnectProperties.
*
* Returns: (transfer full): a #MMSimpleConnectProperties. The returned value should be freed with g_object_unref().
*
* Since: 1.0
*/
MMSimpleConnectProperties *
mm_simple_connect_properties_new (void)

44
libmm-glib/mm-simple-status.c
View File

@@ -33,7 +33,7 @@
* mm_modem_simple_get_status_sync().
*/
G_DEFINE_TYPE (MMSimpleStatus, mm_simple_status, G_TYPE_OBJECT);
G_DEFINE_TYPE (MMSimpleStatus, mm_simple_status, G_TYPE_OBJECT)
enum {
PROP_0,
@@ -96,6 +96,8 @@ struct _MMSimpleStatusPrivate {
* Gets the state of the modem.
*
* Returns: a #MMModemState.
*
* Since: 1.0
*/
MMModemState
mm_simple_status_get_state (MMSimpleStatus *self)
@@ -110,11 +112,14 @@ mm_simple_status_get_state (MMSimpleStatus *self)
/**
* mm_simple_status_get_signal_quality:
* @self: a #MMSimpleStatus.
* @recent: (out) (allow-none): indication of whether the given signal quality is considered recent.
* @recent: (out) (allow-none): indication of whether the given signal quality
* is considered recent.
*
* Gets the signal quality.
*
* Returns: the signal quality.
*
* Since: 1.0
*/
guint32
mm_simple_status_get_signal_quality (MMSimpleStatus *self,
@@ -142,10 +147,13 @@ mm_simple_status_get_signal_quality (MMSimpleStatus *self,
/**
* mm_simple_status_get_current_bands:
* @self: a #MMSimpleStatus.
* @bands: (out): location for an array of #MMModemBand values. Do not free the returned value, it is owned by @self.
* @bands: (out): location for an array of #MMModemBand values. Do not free the
* returned value, it is owned by @self.
* @n_bands: (out): number of elements in @bands.
*
* Gets the currently used frequency bands.
*
* Since: 1.0
*/
void
mm_simple_status_get_current_bands (MMSimpleStatus *self,
@@ -170,6 +178,8 @@ mm_simple_status_get_current_bands (MMSimpleStatus *self,
* Gets the currently used access technologies.
*
* Returns: a bitmask of #MMModemAccessTechnology values.
*
* Since: 1.0
*/
MMModemAccessTechnology
mm_simple_status_get_access_technologies (MMSimpleStatus *self)
@@ -188,6 +198,8 @@ mm_simple_status_get_access_technologies (MMSimpleStatus *self)
* Gets the current state of the registration in the 3GPP network.
*
* Returns: a #MMModem3gppRegistrationState.
*
* Since: 1.0
*/
MMModem3gppRegistrationState
mm_simple_status_get_3gpp_registration_state (MMSimpleStatus *self)
@@ -203,9 +215,13 @@ mm_simple_status_get_3gpp_registration_state (MMSimpleStatus *self)
* mm_simple_status_get_3gpp_operator_code:
* @self: a #MMSimpleStatus.
*
* Gets the MCC/MNC of the operator of the 3GPP network where the modem is registered.
* Gets the MCC/MNC of the operator of the 3GPP network where the modem is
* registered.
*
* Returns: the operator code, or %NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: the operator code, or %NULL if unknown. Do not free the returned
* value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_simple_status_get_3gpp_operator_code (MMSimpleStatus *self)
@@ -221,9 +237,13 @@ mm_simple_status_get_3gpp_operator_code (MMSimpleStatus *self)
* mm_simple_status_get_3gpp_operator_name:
* @self: a #MMSimpleStatus.
*
* Gets the name of the operator of the 3GPP network where the modem is registered.
* Gets the name of the operator of the 3GPP network where the modem is
* registered.
*
* Returns: the operator name, or %NULL if unknown. Do not free the returned value, it is owned by @self.
* Returns: the operator name, or %NULL if unknown. Do not free the returned
* value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_simple_status_get_3gpp_operator_name (MMSimpleStatus *self)
@@ -242,6 +262,8 @@ mm_simple_status_get_3gpp_operator_name (MMSimpleStatus *self)
* Gets the current subscription status of the account.
*
* Returns: a #MMModem3gppSubscriptionState.
*
* Since: 1.0
*/
MMModem3gppSubscriptionState
mm_simple_status_get_3gpp_subscription_state (MMSimpleStatus *self)
@@ -261,6 +283,8 @@ mm_simple_status_get_3gpp_subscription_state (MMSimpleStatus *self)
* Gets the current state of the registration in the CDMA-1x network.
*
* Returns: a #MMModemCdmaRegistrationState.
*
* Since: 1.0
*/
MMModemCdmaRegistrationState
mm_simple_status_get_cdma_cdma1x_registration_state (MMSimpleStatus *self)
@@ -279,6 +303,8 @@ mm_simple_status_get_cdma_cdma1x_registration_state (MMSimpleStatus *self)
* Gets the current state of the registration in the EV-DO network.
*
* Returns: a #MMModemCdmaRegistrationState.
*
* Since: 1.0
*/
MMModemCdmaRegistrationState
mm_simple_status_get_cdma_evdo_registration_state (MMSimpleStatus *self)
@@ -297,6 +323,8 @@ mm_simple_status_get_cdma_evdo_registration_state (MMSimpleStatus *self)
* Gets the System Identification number of the CDMA network.
*
* Returns: the SID, or %MM_MODEM_CDMA_SID_UNKNOWN if unknown.
*
* Since: 1.0
*/
guint
mm_simple_status_get_cdma_sid (MMSimpleStatus *self)
@@ -315,6 +343,8 @@ mm_simple_status_get_cdma_sid (MMSimpleStatus *self)
* Gets the Network Identification number of the CDMA network.
*
* Returns: the NID, or %MM_MODEM_CDMA_NID_UNKNOWN if unknown.
*
* Since: 1.0
*/
guint
mm_simple_status_get_cdma_nid (MMSimpleStatus *self)

78
libmm-glib/mm-sms-properties.c
View File

@@ -68,6 +68,8 @@ struct _MMSmsPropertiesPrivate {
* @text: The text to set, in UTF-8.
*
* Sets the message text.
*
* Since: 1.0
*/
void
mm_sms_properties_set_text (MMSmsProperties *self,
@@ -85,7 +87,11 @@ mm_sms_properties_set_text (MMSmsProperties *self,
*
* Gets the message text, in UTF-8.
*
* Returns: (transfer none): The message text, or %NULL if it doesn't contain any (e.g. contains data instead). Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The message text, or %NULL if it doesn't contain
* any (e.g. contains data instead). Do not free the returned value, it is
* owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_sms_properties_get_text (MMSmsProperties *self)
@@ -104,6 +110,8 @@ mm_sms_properties_get_text (MMSmsProperties *self)
* @data_length: Length of @data.
*
* Sets the message data.
*
* Since: 1.0
*/
void
mm_sms_properties_set_data (MMSmsProperties *self,
@@ -126,9 +134,12 @@ mm_sms_properties_set_data (MMSmsProperties *self,
/**
* mm_sms_properties_set_data_bytearray:
* @self: A #MMSmsProperties.
* @data: A #GByteArray with the data to set. This method takes a new reference of @data.
* @data: A #GByteArray with the data to set. This method takes a new reference
* of @data.
*
* Sets the message data.
*
* Since: 1.0
*/
void
mm_sms_properties_set_data_bytearray (MMSmsProperties *self,
@@ -149,7 +160,10 @@ mm_sms_properties_set_data_bytearray (MMSmsProperties *self,
*
* Gets the message data.
*
* Returns: (transfer none): The message data, or %NULL if it doesn't contain any (e.g. contains text instead).
* Returns: (transfer none): The message data, or %NULL if it doesn't contain
* any (e.g. contains text instead).
*
* Since: 1.0
*/
const guint8 *
mm_sms_properties_get_data (MMSmsProperties *self,
@@ -169,7 +183,11 @@ mm_sms_properties_get_data (MMSmsProperties *self,
*
* Gets the message data.
*
* Returns: (transfer none): A #GByteArray with the message data, or %NULL if it doesn't contain any (e.g. contains text instead). Do not free the returned value, it is owned by @self.
* Returns: (transfer none): A #GByteArray with the message data, or %NULL if it
* doesn't contain any (e.g. contains text instead). Do not free the returned
* value, it is owned by @self.
*
* Since: 1.0
*/
GByteArray *
mm_sms_properties_peek_data_bytearray (MMSmsProperties *self)
@@ -185,7 +203,11 @@ mm_sms_properties_peek_data_bytearray (MMSmsProperties *self)
*
* Gets the message data.
*
* Returns: (transfer full): A #GByteArray with the message data, or %NULL if it doesn't contain any (e.g. contains text instead). The returned value should be freed with g_byte_array_unref().
* Returns: (transfer full): A #GByteArray with the message data, or %NULL if it
* doesn't contain any (e.g. contains text instead). The returned value should
* be freed with g_byte_array_unref().
*
* Since: 1.0
*/
GByteArray *
mm_sms_properties_get_data_bytearray (MMSmsProperties *self)
@@ -203,6 +225,8 @@ mm_sms_properties_get_data_bytearray (MMSmsProperties *self)
* @number: The number.
*
* Sets the number to which the message is addressed.
*
* Since: 1.0
*/
void
mm_sms_properties_set_number (MMSmsProperties *self,
@@ -220,7 +244,10 @@ mm_sms_properties_set_number (MMSmsProperties *self,
*
* Gets the number to which the message is addressed.
*
* Returns: (transfer none): The number, or %NULL if it couldn't be retrieved. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The number, or %NULL if it couldn't be retrieved.
* Do not free the returned value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_sms_properties_get_number (MMSmsProperties *self)
@@ -238,6 +265,8 @@ mm_sms_properties_get_number (MMSmsProperties *self)
* @smsc: The SMSC number.
*
* Sets the SMS service center number.
*
* Since: 1.0
*/
void
mm_sms_properties_set_smsc (MMSmsProperties *self,
@@ -255,7 +284,10 @@ mm_sms_properties_set_smsc (MMSmsProperties *self,
*
* Gets the SMS service center number.
*
* Returns: (transfer none): The number of the SMSC, or %NULL if it couldn't be retrieved. Do not free the returned value, it is owned by @self.
* Returns: (transfer none): The number of the SMSC, or %NULL if it couldn't be
* retrieved. Do not free the returned value, it is owned by @self.
*
* Since: 1.0
*/
const gchar *
mm_sms_properties_get_smsc (MMSmsProperties *self)
@@ -273,6 +305,8 @@ mm_sms_properties_get_smsc (MMSmsProperties *self)
* @validity: The validity of %MM_SMS_VALIDITY_TYPE_RELATIVE type.
*
* Sets the relative validity time of the SMS.
*
* Since: 1.0
*/
void
mm_sms_properties_set_validity_relative (MMSmsProperties *self,
@@ -291,6 +325,8 @@ mm_sms_properties_set_validity_relative (MMSmsProperties *self,
* Gets the relative validity type the SMS.
*
* Returns: a #MMSmsValidityType.
*
* Since: 1.0
*/
MMSmsValidityType
mm_sms_properties_get_validity_type (MMSmsProperties *self)
@@ -307,6 +343,8 @@ mm_sms_properties_get_validity_type (MMSmsProperties *self)
* Gets the relative validity time of the SMS.
*
* Returns: the validity time or 0 if unknown.
*
* Since: 1.0
*/
guint
mm_sms_properties_get_validity_relative (MMSmsProperties *self)
@@ -325,6 +363,8 @@ mm_sms_properties_get_validity_relative (MMSmsProperties *self)
* @message_class: The message class (0..3), or -1 for invalid/unset class.
*
* Sets the 3GPP message class of the SMS.
*
* Since: 1.0
*/
void
mm_sms_properties_set_class (MMSmsProperties *self,
@@ -343,6 +383,8 @@ mm_sms_properties_set_class (MMSmsProperties *self,
* Gets the 3GPP message class of the SMS.
*
* Returns: the message class, or -1 for invalid/unset class.
*
* Since: 1.0
*/
gint
mm_sms_properties_get_class (MMSmsProperties *self)
@@ -360,6 +402,8 @@ mm_sms_properties_get_class (MMSmsProperties *self)
* @request: %TRUE if delivery report is requested, %FALSE otherwise.
*
* Sets whether delivery report is requested for the SMS.
*
* Since: 1.0
*/
void
mm_sms_properties_set_delivery_report_request (MMSmsProperties *self,
@@ -378,6 +422,8 @@ mm_sms_properties_set_delivery_report_request (MMSmsProperties *self,
* Checks whether delivery report is requested for the SMS.
*
* Returns: %TRUE if delivery report is requested, %FALSE otherwise.
*
* Since: 1.0
*/
gboolean
mm_sms_properties_get_delivery_report_request (MMSmsProperties *self)
@@ -395,6 +441,8 @@ mm_sms_properties_get_delivery_report_request (MMSmsProperties *self)
* @teleservice_id: The CDMA teleservice ID.
*
* Sets the CDMA teleservice ID of the SMS.
*
* Since: 1.2
*/
void
mm_sms_properties_set_teleservice_id (MMSmsProperties *self,
@@ -412,6 +460,8 @@ mm_sms_properties_set_teleservice_id (MMSmsProperties *self,
* Gets the CDMA teleservice ID of the SMS.
*
* Returns: the CDMA teleservice ID.
*
* Since: 1.2
*/
MMSmsCdmaTeleserviceId
mm_sms_properties_get_teleservice_id (MMSmsProperties *self)
@@ -429,6 +479,8 @@ mm_sms_properties_get_teleservice_id (MMSmsProperties *self)
* @service_category: The CDMA service category.
*
* Sets the CDMA service category of the SMS.
*
* Since: 1.2
*/
void
mm_sms_properties_set_service_category (MMSmsProperties *self,
@@ -446,6 +498,8 @@ mm_sms_properties_set_service_category (MMSmsProperties *self,
* Gets the CDMA message service category of the SMS.
*
* Returns: the CDMA service category.
*
* Since: 1.2
*/
MMSmsCdmaServiceCategory
mm_sms_properties_get_service_category (MMSmsProperties *self)
@@ -822,14 +876,6 @@ mm_sms_properties_new_from_dictionary (GVariant *dictionary,
/*****************************************************************************/
/**
* mm_sms_properties_dup:
* @orig: a #MMSmsProperties
*
* Returns a copy of @orig.
*
* Returns: (transfer full): a #MMSmsProperties
*/
MMSmsProperties *
mm_sms_properties_dup (MMSmsProperties *orig)
{
@@ -855,6 +901,8 @@ mm_sms_properties_dup (MMSmsProperties *orig)
* Creates a new empty #MMSmsProperties.
*
* Returns: (transfer full): a #MMSmsProperties. The returned value should be freed with g_object_unref().
*
* Since: 1.0
*/
MMSmsProperties *
mm_sms_properties_new (void)

188
libmm-glib/mm-sms.c
View File

@@ -49,6 +49,8 @@ G_DEFINE_TYPE (MMSms, mm_sms, MM_GDBUS_TYPE_SMS_PROXY)
* Gets the DBus path of the #MMSms object.
*
* Returns: (transfer none): The DBus path of the #MMSms object.
*
* Since: 1.0
*/
const gchar *
mm_sms_get_path (MMSms *self)
@@ -65,7 +67,10 @@ mm_sms_get_path (MMSms *self)
*
* Gets a copy of the DBus path of the #MMSms object.
*
* Returns: (transfer full): The DBus path of the #MMSms object. The returned value should be freed with g_free().
* Returns: (transfer full): The DBus path of the #MMSms object. The returned
* value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_sms_dup_path (MMSms *self)
@@ -89,12 +94,14 @@ mm_sms_dup_path (MMSms *self)
*
* Gets the message text, in UTF-8.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_sms_dup_text() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_sms_dup_text() if on another thread.</warning>
*
* Returns: (transfer none): The message text, or %NULL if it doesn't contain any (e.g. contains data instead).
* Returns: (transfer none): The message text, or %NULL if it doesn't contain
* any (e.g. contains data instead).
*
* Since: 1.0
*/
const gchar *
mm_sms_get_text (MMSms *self)
@@ -111,7 +118,11 @@ mm_sms_get_text (MMSms *self)
*
* Gets the message text, in UTF-8.
*
* Returns: (transfer full): The message text, or %NULL if it doesn't contain any (e.g. contains data instead). The returned value should be freed with g_free().
* Returns: (transfer full): The message text, or %NULL if it doesn't contain
* any (e.g. contains data instead). The returned value should be freed with
* g_free().
*
* Since: 1.0
*/
gchar *
mm_sms_dup_text (MMSms *self)
@@ -131,7 +142,11 @@ mm_sms_dup_text (MMSms *self)
*
* Gets the message data.
*
* Returns: (transfer none) (array length=data_len) (element-type guint8): The message data, or %NULL if it doesn't contain any (e.g. contains text instead).
* Returns: (transfer none) (array length=data_len) (element-type guint8): The
* message data, or %NULL if it doesn't contain any (e.g. contains text
* instead).
*
* Since: 1.0
*/
const guint8 *
mm_sms_get_data (MMSms *self,
@@ -158,7 +173,11 @@ mm_sms_get_data (MMSms *self,
*
* Gets the message data.
*
* Returns: (transfer full) (array length=data_len) (element-type guint8): The message data, or %NULL if it doesn't contain any (e.g. contains text instead). The returned value should be freed with g_free().
* Returns: (transfer full) (array length=data_len) (element-type guint8): The
* message data, or %NULL if it doesn't contain any (e.g. contains text
* instead). The returned value should be freed with g_free().
*
* Since: 1.0
*/
guint8 *
mm_sms_dup_data (MMSms *self,
@@ -198,12 +217,13 @@ mm_sms_dup_data (MMSms *self,
*
* Gets the number to which the message is addressed.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_sms_dup_number() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_sms_dup_number() if on another thread.</warning>
*
* Returns: (transfer none): The number, or %NULL if it couldn't be retrieved.
*
* Since: 1.0
*/
const gchar *
mm_sms_get_number (MMSms *self)
@@ -220,7 +240,10 @@ mm_sms_get_number (MMSms *self)
*
* Gets the number to which the message is addressed.
*
* Returns: (transfer full): The number, or %NULL if it couldn't be retrieved. The returned value should be freed with g_free().
* Returns: (transfer full): The number, or %NULL if it couldn't be retrieved.
* The returned value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_sms_dup_number (MMSms *self)
@@ -239,12 +262,14 @@ mm_sms_dup_number (MMSms *self)
*
* Gets the SMS service center number.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_sms_dup_smsc() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_sms_dup_smsc() if on another thread.</warning>
*
* Returns: (transfer none): The number of the SMSC, or %NULL if it couldn't be retrieved.
* Returns: (transfer none): The number of the SMSC, or %NULL if it couldn't be
* retrieved.
*
* Since: 1.0
*/
const gchar *
mm_sms_get_smsc (MMSms *self)
@@ -261,7 +286,10 @@ mm_sms_get_smsc (MMSms *self)
*
* Gets the SMS service center number.
*
* Returns: (transfer full): The number of the SMSC, or %NULL if it couldn't be retrieved. The returned value should be freed with g_free().
* Returns: (transfer full): The number of the SMSC, or %NULL if it couldn't be
* retrieved. The returned value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_sms_dup_smsc (MMSms *self)
@@ -285,12 +313,14 @@ mm_sms_dup_smsc (MMSms *self)
* This field is only applicable if the PDU type is %MM_SMS_PDU_TYPE_DELIVER or
* %MM_SMS_PDU_TYPE_STATUS_REPORT.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_sms_dup_timestamp() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_sms_dup_timestamp() if on another thread.</warning>
*
* Returns: (transfer none): The timestamp, or %NULL if it couldn't be retrieved.
* Returns: (transfer none): The timestamp, or %NULL if it couldn't be
* retrieved.
*
* Since: 1.0
*/
const gchar *
mm_sms_get_timestamp (MMSms *self)
@@ -312,7 +342,10 @@ mm_sms_get_timestamp (MMSms *self)
* This field is only applicable if the PDU type is %MM_SMS_PDU_TYPE_DELIVER or
* %MM_SMS_PDU_TYPE_STATUS_REPORT.
*
* Returns: (transfer full): The timestamp, or %NULL if it couldn't be retrieved. The returned value should be freed with g_free().
* Returns: (transfer full): The timestamp, or %NULL if it couldn't be
* retrieved. The returned value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_sms_dup_timestamp (MMSms *self)
@@ -333,14 +366,17 @@ mm_sms_dup_timestamp (MMSms *self)
* <ulink url="http://en.wikipedia.org/wiki/ISO_8601">ISO8601</ulink>
* format.
*
* This field is only applicable if the PDU type is %MM_SMS_PDU_TYPE_STATUS_REPORT.
* This field is only applicable if the PDU type is
* %MM_SMS_PDU_TYPE_STATUS_REPORT.
*
* <warning>The returned value is only valid until the property changes so
* it is only safe to use this function on the thread where
* @self was constructed. Use mm_sms_dup_discharge_timestamp() if on another
* thread.</warning>
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_sms_dup_discharge_timestamp() if on another thread.</warning>
*
* Returns: (transfer none): The timestamp, or %NULL if it couldn't be retrieved.
* Returns: (transfer none): The timestamp, or %NULL if it couldn't be
* retrieved.
*
* Since: 1.0
*/
const gchar *
mm_sms_get_discharge_timestamp (MMSms *self)
@@ -359,9 +395,13 @@ mm_sms_get_discharge_timestamp (MMSms *self)
* <ulink url="http://en.wikipedia.org/wiki/ISO_8601">ISO8601</ulink>
* format.
*
* This field is only applicable if the PDU type is %MM_SMS_PDU_TYPE_STATUS_REPORT.
* This field is only applicable if the PDU type is
* %MM_SMS_PDU_TYPE_STATUS_REPORT.
*
* Returns: (transfer full): The timestamp, or %NULL if it couldn't be retrieved. The returned value should be freed with g_free().
* Returns: (transfer full): The timestamp, or %NULL if it couldn't be
* retrieved. The returned value should be freed with g_free().
*
* Since: 1.0
*/
gchar *
mm_sms_dup_discharge_timestamp (MMSms *self)
@@ -381,6 +421,8 @@ mm_sms_dup_discharge_timestamp (MMSms *self)
* Gets the type of validity information in the SMS.
*
* Returns: the validity type or #MM_SMS_VALIDITY_TYPE_UNKNOWN.
*
* Since: 1.0
*/
MMSmsValidityType
mm_sms_get_validity_type (MMSms *self)
@@ -411,6 +453,8 @@ mm_sms_get_validity_type (MMSms *self)
* Only applicable if the type of validity is #MM_SMS_VALIDITY_TYPE_RELATIVE.
*
* Returns: the length of the validity period, or 0 if unknown.
*
* Since: 1.0
*/
guint
mm_sms_get_validity_relative (MMSms *self)
@@ -446,6 +490,8 @@ mm_sms_get_validity_relative (MMSms *self)
* Gets the 3GPP message class of the SMS.
*
* Returns: the message class, or -1 for invalid/unset class.
*
* Since: 1.0
*/
gint
mm_sms_get_class (MMSms *self)
@@ -467,6 +513,8 @@ mm_sms_get_class (MMSms *self)
* message reference of the PDU associated to the status report.
*
* Returns: The message reference.
*
* Since: 1.0
*/
guint
mm_sms_get_message_reference (MMSms *self)
@@ -485,6 +533,8 @@ mm_sms_get_message_reference (MMSms *self)
* Checks whether delivery report is requested for this SMS.
*
* Returns: %TRUE if delivery report is requested, %FALSE otherwise.
*
* Since: 1.0
*/
gboolean
mm_sms_get_delivery_report_request (MMSms *self)
@@ -502,9 +552,12 @@ mm_sms_get_delivery_report_request (MMSms *self)
*
* Gets the delivery state of this SMS.
*
* This field is only applicable if the PDU type is %MM_SMS_PDU_TYPE_STATUS_REPORT.
* This field is only applicable if the PDU type is
* %MM_SMS_PDU_TYPE_STATUS_REPORT.
*
* Returns: A #MMSmsDeliveryState specifying the delivery state.
*
* Since: 1.0
*/
guint
mm_sms_get_delivery_state (MMSms *self)
@@ -523,6 +576,8 @@ mm_sms_get_delivery_state (MMSms *self)
* Gets the state of this SMS.
*
* Returns: A #MMSmsState specifying the state.
*
* Since: 1.0
*/
MMSmsState
mm_sms_get_state (MMSms *self)
@@ -541,6 +596,8 @@ mm_sms_get_state (MMSms *self)
* Gets the storage in which this SMS is kept.
*
* Returns: A #MMSmsStorage specifying the storage.
*
* Since: 1.0
*/
MMSmsStorage
mm_sms_get_storage (MMSms *self)
@@ -559,6 +616,8 @@ mm_sms_get_storage (MMSms *self)
* Gets the PDU type on which this SMS is based.
*
* Returns: A #MMSmsPduType specifying the PDU type.
*
* Since: 1.0
*/
MMSmsPduType
mm_sms_get_pdu_type (MMSms *self)
@@ -577,6 +636,8 @@ mm_sms_get_pdu_type (MMSms *self)
* Gets the 3GPP2 Teleservice ID.
*
* Returns: a #MMSmsCdmaTeleserviceId.
*
* Since: 1.2
*/
MMSmsCdmaTeleserviceId
mm_sms_get_teleservice_id (MMSms *self)
@@ -595,6 +656,8 @@ mm_sms_get_teleservice_id (MMSms *self)
* Gets the 3GPP2 Service Category.
*
* Returns: a #MMSmsCdmaServiceCategory.
*
* Since: 1.2
*/
MMSmsCdmaServiceCategory
mm_sms_get_service_category (MMSms *self)
@@ -609,12 +672,15 @@ mm_sms_get_service_category (MMSms *self)
/**
* mm_sms_send_finish:
* @self: A #MMSms.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_sms_send().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_sms_send().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_sms_send().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_sms_send_finish (MMSms *self,
@@ -630,17 +696,22 @@ mm_sms_send_finish (MMSms *self,
* mm_sms_send:
* @self: A #MMSms.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronously requests to queue the message for delivery.
*
* SMS objects can only be sent once.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_sms_send_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_sms_send_finish() to get the result of the operation.
*
* See mm_sms_send_sync() for the synchronous, blocking version of this method.
*
* Since: 1.0
*/
void
mm_sms_send (MMSms *self,
@@ -666,10 +737,12 @@ mm_sms_send (MMSms *self,
*
* SMS objects can only be sent once.
*
* The calling thread is blocked until a reply is received.
* See mm_sms_send() for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See mm_sms_send()
* for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_sms_send_sync (MMSms *self,
@@ -688,12 +761,15 @@ mm_sms_send_sync (MMSms *self,
/**
* mm_sms_store_finish:
* @self: A #MMSms.
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_sms_store().
* @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* mm_sms_store().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with mm_sms_store().
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_sms_store_finish (MMSms *self,
@@ -708,19 +784,25 @@ mm_sms_store_finish (MMSms *self,
/**
* mm_sms_store:
* @self: A #MMSms.
* @storage: A #MMSmsStorage specifying where to store the SMS, or #MM_SMS_STORAGE_UNKNOWN to use the default.
* @storage: A #MMSmsStorage specifying where to store the SMS, or
* %MM_SMS_STORAGE_UNKNOWN to use the default.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or
* %NULL.
* @user_data: User data to pass to @callback.
*
* Asynchronoulsy requests to store the message in the device if not already done.
*
* SMS objects can only be stored once.
*
* When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
* You can then call mm_sms_store_finish() to get the result of the operation.
* When the operation is finished, @callback will be invoked in the
* <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
* of the thread you are calling this method from. You can then call
* mm_sms_store_finish() to get the result of the operation.
*
* See mm_sms_store_sync() for the synchronous, blocking version of this method.
*
* Since: 1.0
*/
void
mm_sms_store (MMSms *self,
@@ -741,18 +823,22 @@ mm_sms_store (MMSms *self,
/**
* mm_sms_store_sync:
* @self: A #MMSms.
* @storage: A #MMSmsStorage specifying where to store the SMS, or #MM_SMS_STORAGE_UNKNOWN to use the default.
* @storage: A #MMSmsStorage specifying where to store the SMS, or
* %MM_SMS_STORAGE_UNKNOWN to use the default.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* Synchronoulsy requests to store the message in the device if not already done.
* Synchronoulsy requests to store the message in the device if not already
* done.
*
* SMS objects can only be stored once.
*
* The calling thread is blocked until a reply is received.
* See mm_sms_store() for the asynchronous version of this method.
* The calling thread is blocked until a reply is received. See mm_sms_store()
* for the asynchronous version of this method.
*
* Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
*
* Since: 1.0
*/
gboolean
mm_sms_store_sync (MMSms *self,

8
libmm-glib/mm-unlock-retries.c
View File

@@ -32,7 +32,7 @@
* mm_modem_get_unlock_retries() or mm_modem_peek_unlock_retries().
*/
G_DEFINE_TYPE (MMUnlockRetries, mm_unlock_retries, G_TYPE_OBJECT);
G_DEFINE_TYPE (MMUnlockRetries, mm_unlock_retries, G_TYPE_OBJECT)
struct _MMUnlockRetriesPrivate {
GHashTable *ht;
@@ -68,6 +68,8 @@ mm_unlock_retries_unset (MMUnlockRetries *self,
* Gets the unlock retries for the given @lock.
*
* Returns: the unlock retries or %MM_UNLOCK_RETRIES_UNKNOWN if unknown.
*
* Since: 1.0
*/
guint
mm_unlock_retries_get (MMUnlockRetries *self,
@@ -116,6 +118,8 @@ mm_unlock_retries_cmp (MMUnlockRetries *a,
* @user_data: (closure): data to pass to @callback.
*
* Executes @callback for each lock information found in @self.
*
* Since: 1.0
*/
void
mm_unlock_retries_foreach (MMUnlockRetries *self,
@@ -221,7 +225,7 @@ mm_unlock_retries_new (void)
static void
mm_unlock_retries_init (MMUnlockRetries *self)
{
self->priv = G_TYPE_INSTANCE_GET_PRIVATE ((self),
self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
MM_TYPE_UNLOCK_RETRIES,
MMUnlockRetriesPrivate);
self->priv->ht = g_hash_table_new (g_direct_hash,

4
libmm-glib/mm-unlock-retries.h
View File

@@ -36,6 +36,8 @@ G_BEGIN_DECLS
* MM_UNLOCK_RETRIES_UNKNOWN:
*
* Identifier for reporting unknown unlock retries.
*
* Since: 1.0
*/
#define MM_UNLOCK_RETRIES_UNKNOWN 999
@@ -76,6 +78,8 @@ guint mm_unlock_retries_get (MMUnlockRetries *self,
* @user_data: data passed to the function.
*
* Specifies the type of function passed to mm_unlock_retries_foreach().
*
* Since: 1.0
*/
typedef void (* MMUnlockRetriesForeachCb) (MMModemLock lock,
guint count,