diff options
Diffstat (limited to 'docs/reference/api')
53 files changed, 988 insertions, 565 deletions
diff --git a/docs/reference/api/Makefile.am b/docs/reference/api/Makefile.am index c8b58a0..33c28e2 100644 --- a/docs/reference/api/Makefile.am +++ b/docs/reference/api/Makefile.am @@ -63,6 +63,7 @@ content_files = \ expand_content_files = \ ModemManager-overview.xml \ ModemManager-dbus-reference.xml \ + ModemManager-migration-reference.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Sim.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Sms.xml \ @@ -72,7 +73,6 @@ expand_content_files = \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Location.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Time.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Firmware.xml \ - $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Contacts.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.ModemCdma.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Modem3gpp.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.xml \ @@ -92,6 +92,7 @@ endif EXTRA_DIST += \ ModemManager-overview.xml \ ModemManager-dbus-reference.xml \ + ModemManager-migration-reference.xml \ version.xml.in \ $(DIAGRAMS) \ $(NULL) diff --git a/docs/reference/api/Makefile.in b/docs/reference/api/Makefile.in index bde73a8..c6707df 100644 --- a/docs/reference/api/Makefile.in +++ b/docs/reference/api/Makefile.in @@ -1,4 +1,4 @@ -# Makefile.in generated by automake 1.13.2 from Makefile.am. +# Makefile.in generated by automake 1.13.4 from Makefile.am. # @configure_input@ # Copyright (C) 1994-2013 Free Software Foundation, Inc. @@ -133,8 +133,6 @@ AUTOCONF = @AUTOCONF@ AUTOHEADER = @AUTOHEADER@ AUTOMAKE = @AUTOMAKE@ AWK = @AWK@ -CATALOGS = @CATALOGS@ -CATOBJEXT = @CATOBJEXT@ CC = @CC@ CCDEPMODE = @CCDEPMODE@ CFLAGS = @CFLAGS@ @@ -158,7 +156,6 @@ GETTEXT_MACRO_VERSION = @GETTEXT_MACRO_VERSION@ GETTEXT_PACKAGE = @GETTEXT_PACKAGE@ GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ GLIB_MKENUMS = @GLIB_MKENUMS@ -GMOFILES = @GMOFILES@ GMSGFMT = @GMSGFMT@ GMSGFMT_015 = @GMSGFMT_015@ GREP = @GREP@ @@ -175,7 +172,6 @@ INSTALL_DATA = @INSTALL_DATA@ INSTALL_PROGRAM = @INSTALL_PROGRAM@ INSTALL_SCRIPT = @INSTALL_SCRIPT@ INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ -INSTOBJEXT = @INSTOBJEXT@ INTLLIBS = @INTLLIBS@ INTLTOOL_EXTRACT = @INTLTOOL_EXTRACT@ INTLTOOL_MERGE = @INTLTOOL_MERGE@ @@ -207,14 +203,20 @@ MANIFEST_TOOL = @MANIFEST_TOOL@ MBIM_CFLAGS = @MBIM_CFLAGS@ MBIM_LIBS = @MBIM_LIBS@ MKDIR_P = @MKDIR_P@ -MKINSTALLDIRS = @MKINSTALLDIRS@ MMCLI_CFLAGS = @MMCLI_CFLAGS@ MMCLI_LIBS = @MMCLI_LIBS@ MM_CFLAGS = @MM_CFLAGS@ +MM_DEFAULT_USER_POLICY = @MM_DEFAULT_USER_POLICY@ +MM_GLIB_LT_AGE = @MM_GLIB_LT_AGE@ +MM_GLIB_LT_CURRENT = @MM_GLIB_LT_CURRENT@ +MM_GLIB_LT_REVISION = @MM_GLIB_LT_REVISION@ MM_LIBS = @MM_LIBS@ +MM_MAJOR_VERSION = @MM_MAJOR_VERSION@ +MM_MICRO_VERSION = @MM_MICRO_VERSION@ +MM_MINOR_VERSION = @MM_MINOR_VERSION@ +MM_VERSION = @MM_VERSION@ MSGFMT = @MSGFMT@ MSGFMT_015 = @MSGFMT_015@ -MSGFMT_OPTS = @MSGFMT_OPTS@ MSGMERGE = @MSGMERGE@ NM = @NM@ NMEDIT = @NMEDIT@ @@ -233,13 +235,9 @@ PATH_SEPARATOR = @PATH_SEPARATOR@ PKG_CONFIG = @PKG_CONFIG@ PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ -POFILES = @POFILES@ POLKIT_CFLAGS = @POLKIT_CFLAGS@ POLKIT_LIBS = @POLKIT_LIBS@ POSUB = @POSUB@ -PO_IN_DATADIR_FALSE = @PO_IN_DATADIR_FALSE@ -PO_IN_DATADIR_TRUE = @PO_IN_DATADIR_TRUE@ -PPPD_PLUGIN_DIR = @PPPD_PLUGIN_DIR@ QMI_CFLAGS = @QMI_CFLAGS@ QMI_LIBS = @QMI_LIBS@ RANLIB = @RANLIB@ @@ -377,6 +375,7 @@ content_files = \ expand_content_files = \ ModemManager-overview.xml \ ModemManager-dbus-reference.xml \ + ModemManager-migration-reference.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Sim.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Sms.xml \ @@ -386,7 +385,6 @@ expand_content_files = \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Location.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Time.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Firmware.xml \ - $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Contacts.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.ModemCdma.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Modem3gpp.xml \ $(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.xml \ @@ -418,10 +416,12 @@ extra_files = \ @ENABLE_GTK_DOC_FALSE@EXTRA_DIST = ModemManager-overview.xml \ @ENABLE_GTK_DOC_FALSE@ ModemManager-dbus-reference.xml \ +@ENABLE_GTK_DOC_FALSE@ ModemManager-migration-reference.xml \ @ENABLE_GTK_DOC_FALSE@ version.xml.in $(DIAGRAMS) $(NULL) @ENABLE_GTK_DOC_TRUE@EXTRA_DIST = $(HTML_IMAGES) $(SETUP_FILES) \ @ENABLE_GTK_DOC_TRUE@ ModemManager-overview.xml \ @ENABLE_GTK_DOC_TRUE@ ModemManager-dbus-reference.xml \ +@ENABLE_GTK_DOC_TRUE@ ModemManager-migration-reference.xml \ @ENABLE_GTK_DOC_TRUE@ version.xml.in $(DIAGRAMS) $(NULL) @ENABLE_GTK_DOC_TRUE@DOC_STAMPS = setup-build.stamp scan-build.stamp tmpl-build.stamp sgml-build.stamp \ @ENABLE_GTK_DOC_TRUE@ html-build.stamp pdf-build.stamp \ diff --git a/docs/reference/api/ModemManager-dbus-reference.xml b/docs/reference/api/ModemManager-dbus-reference.xml index c84e459..f6f7d32 100644 --- a/docs/reference/api/ModemManager-dbus-reference.xml +++ b/docs/reference/api/ModemManager-dbus-reference.xml @@ -75,12 +75,6 @@ </section> </chapter> - <chapter id="ref-dbus-common-types"> - <title>Common types</title> - <xi:include href="mm-enums.xml"/> - <xi:include href="mm-errors.xml"/> - </chapter> - <chapter id="ref-dbus-object-manager"> <title>The <literal>/org/freedesktop/ModemManager1</literal> object</title> <para> @@ -142,7 +136,7 @@ <xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Location.xml"/> <xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Time.xml"/> <xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Firmware.xml"/> - <xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Contacts.xml"/> + <!--xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Contacts.xml"/--> </chapter> <chapter id="ref-dbus-object-bearer"> diff --git a/docs/reference/api/ModemManager-docs.xml b/docs/reference/api/ModemManager-docs.xml index 97654fb..d321a5a 100644 --- a/docs/reference/api/ModemManager-docs.xml +++ b/docs/reference/api/ModemManager-docs.xml @@ -44,6 +44,7 @@ <year>2010</year> <year>2011</year> <year>2012</year> + <year>2013</year> <holder>The ModemManager Authors</holder> </copyright> @@ -72,9 +73,19 @@ <!-- Part 1, overview --> <xi:include href="xml/ModemManager-overview.xml"/> + <part id="ref-common-types"> + <title>Common types and definitions</title> + <xi:include href="xml/mm-version.xml"/> + <xi:include href="xml/mm-enums.xml"/> + <xi:include href="xml/mm-errors.xml"/> + </part> + <!-- Part 2, DBus reference --> <xi:include href="xml/ModemManager-dbus-reference.xml"/> + <!-- Part 3, Migration reference --> + <xi:include href="xml/ModemManager-migration-reference.xml"/> + <index> <title>Index</title> </index> diff --git a/docs/reference/api/ModemManager-migration-reference.xml b/docs/reference/api/ModemManager-migration-reference.xml new file mode 100644 index 0000000..89670b5 --- /dev/null +++ b/docs/reference/api/ModemManager-migration-reference.xml @@ -0,0 +1,156 @@ +<?xml version="1.0"?> +<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" +"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ +]> +<part id="ref-migrating" xmlns:xi="http://www.w3.org/2003/XInclude"> + <title>Migrating from ModemManager 0.6 to ModemManager 1.0</title> + <partintro> + <para> + ModemManager 1.0 is a new major version of ModemManager that breaks both + API and ABI compared to previous versions. These changes allow better + managing new types of devices (e.g. those with multiple capabilities), + or those not based in AT commands for operation (e.g. QMI or MBIM modems). + </para> + <para> + This section provides an introduction to the changes done in the DBus interface + with respect to the main operations performed with modems through ModemManager. + </para> + </partintro> + + <chapter> + <section> + <title>Listing available modems</title> + <para> + The D-Bus name <literal>org.freedesktop.ModemManager1</literal> + on the system bus is the new name used by the ModemManager 1.0 daemon, and it + implements several standard DBus interfaces, including the new + <ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager"> + <literal>org.freedesktop.DBus.ObjectManager</literal> + </ulink> + interface, which allows to list available modem objects and get notifications + where new ones are added or when existing ones are removed. There are therefore + neither a custom method to enumerate devices as in the old 0.6 interface, nor + custom signals to notify about added or removed modems. + </para> + <para> + Modems which are found but are not usable will be flagged with a + <link linkend="MM-MODEM-STATE-FAILED:CAPS"><constant>MM_MODEM_STATE_FAILED</constant></link> + state in the + <link linkend="gdbus-property-org-freedesktop-ModemManager1-Modem.State"> + <literal>State</literal> + </link> + property, and a more detailed reason about the failure will be given in the + <link linkend="gdbus-property-org-freedesktop-ModemManager1-Modem.StateFailedReason"> + <literal>StateFailedReason</literal> + </link> + property. The most common case of failure is to have the SIM missing in a modem which + requires one for operation. + </para> + </section> + + <section> + <title>PIN unlocking</title> + <para> + The process of PIN unlocking the modem is now performed with the + <link linkend="gdbus-method-org-freedesktop-ModemManager1-Sim.SendPin"> + <literal>SendPin()</literal> + </link> + method in the + <link linkend="gdbus-org.freedesktop.ModemManager1.Sim"> + <literal>org.freedesktop.ModemManager1.Sim</literal> + </link> + interface. + </para> + <para> + The path of the SIM object is specified in the + <link linkend="gdbus-property-org-freedesktop-ModemManager1-Modem.Sim"> + <literal>Sim</literal> + </link> + property of the + <link linkend="gdbus-org.freedesktop.ModemManager1.Modem"> + <literal>org.freedesktop.ModemManager1.Modem</literal> + </link> + interface. If the modem doesn't have a SIM, no object path will be given. + </para> + </section> + + <section> + <title>Connection and disconnection</title> + <para> + The process of requesting to connect or disconnect the modem is now split into + two operations: creating a bearer with + <link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem.CreateBearer"> + <literal>CreateBearer()</literal> + </link> + in the + <link linkend="gdbus-org.freedesktop.ModemManager1.Modem"> + <literal>org.freedesktop.ModemManager1.Modem</literal> + </link> + interface and getting the bearer connected with + <link linkend="gdbus-method-org-freedesktop-ModemManager1-Bearer.Connect"> + <literal>Connect()</literal> + </link> + in the + <link linkend="gdbus-org.freedesktop.ModemManager1.Bearer"> + <literal>org.freedesktop.ModemManager1.Bearer</literal> + </link> + interface. These two steps are equivalent to the old <literal>Connect()</literal> + method in the previous <literal>org.freedesktop.ModemManager.Modem</literal> + interface. + </para> + <para> + The old <literal>Disconnect()</literal> + method in the previous <literal>org.freedesktop.ModemManager.Modem</literal> + interface is therefore also applied in a per-bearer basis through the new + <link linkend="gdbus-method-org-freedesktop-ModemManager1-Bearer.Disconnect"> + <literal>Disconnect()</literal> + </link> + in the + <link linkend="gdbus-org.freedesktop.ModemManager1.Bearer"> + <literal>org.freedesktop.ModemManager1.Bearer</literal> + </link> + interface. + </para> + <para> + This logic of splitting the connection logic allows ModemManager to create + multiple bearers that may be connected to e.g. different access points (if + the modem allows it). + </para> + </section> + + <section> + <title>Simple connection</title> + <para> + In order to simplify the whole sequence to get the modem connected, ModemManager + still exposes a Simple interface, renamed as: + <link linkend="gdbus-org.freedesktop.ModemManager1.Modem.Simple"> + <literal>org.freedesktop.ModemManager1.Modem.Simple</literal> + </link>. + </para> + <para> + The + <link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Simple.Connect"> + <literal>Connect()</literal> + </link> + method will create a single bearer with the parameters specified in the call an get + it connected, while the + <link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Simple.Disconnect"> + <literal>Disconnect()</literal> + </link> + method will disconnect all available bearers. + </para> + <para> + One of the main differences with respect to the 0.6 interface, is that + <link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Simple.Connect"> + <literal>Connect()</literal> + </link> + doesn't support to change allowed modes or bands. Instead, these operations should + be done through the methods in the + <link linkend="gdbus-org.freedesktop.ModemManager1.Modem"> + <literal>org.freedesktop.ModemManager1.Modem</literal> + </link> + interface. + </para> + </section> + </chapter> +</part> diff --git a/docs/reference/api/ModemManager-overview.xml b/docs/reference/api/ModemManager-overview.xml index 751dc68..7dad85a 100644 --- a/docs/reference/api/ModemManager-overview.xml +++ b/docs/reference/api/ModemManager-overview.xml @@ -8,30 +8,31 @@ <chapter id="ref-overview-introduction"> <title>Introduction</title> <para> - ModemManager provides a unified high level API for communicating with - (mobile broadband) modems. While the basic commands are standardized, - the more advanced operations (like signal quality monitoring while - connected) varies a lot. + ModemManager provides a unified high level API for communicating with mobile + broadband modems, regardless of the protocol used to communicate with the + actual device (Generic AT, vendor-specific AT, QCDM, QMI, MBIM...). </para> <formalpara> <title>Using</title> <para> ModemManager is a system daemon and is not meant to be used directly from - the command line. However, a command line client (mmcli) is provided, which - may be used to test the different functionality provided during plugin - development. + the command line. However, since it provides a DBus API, it is possible to use + 'dbus-send' commands or the new 'mmcli' command line interface to control it + from the terminal. The devices are queried from udev and automatically updated + based on hardware events, although a manual re-scan can also be requested to + look for RS232 modems. </para> </formalpara> <formalpara> <title>Implementation</title> <para> ModemManager is a DBus system bus activated service (meaning it's started - automatically when a request arrives). It is written in C. The devices are - queried from udev and automatically updated based on hardware events. There are - DBus-interface specific GInterfaces, which should be implemented by any device - specific implementation. There is a generic MMBroadbandModem implementation that - provides a generic implementation of the most common operations in both GSM and - CDMA modems. + automatically when a request arrives). It is written in C, using glib and gio. + Several GInterfaces specify different features that the modems support, + including the generic MMIfaceModem3gpp and MMIfaceModemCdma which provice basic + operations for 3GPP (GSM, UMTS, LTE) or CDMA (CDMA1x, EV-DO) modems. If a given + feature is not available in the modem, the specific interface will not be + exported in DBus. </para> </formalpara> <formalpara> @@ -39,10 +40,13 @@ <para> Plugins are loaded on startup, and must implement the MMPlugin interface. It consists of a couple of methods which tell the daemon whether the plugin - supports a port and to create custom modem implementations. It most likely - makes sense to derive custom modem implementations from one of the generic - classes and just add (or override) operations which are not standard. Writing - new plugins is highly encouraged! + supports a port and to create custom MMBroadbandModem implementations. It most + likely makes sense to derive custom modem implementations from one of the + generic classes and just add (or override) operations which are not standard. + There are multiple fully working plugins in the plugins/ directory that can be + used as an example for writing new plugins. Writing new plugins is highly + encouraged! The plugin API is open for changes, so if you're writing a plugin + and need to add or change some public method, feel free to suggest it! </para> </formalpara> </chapter> diff --git a/docs/reference/api/ModemManager-sections.txt b/docs/reference/api/ModemManager-sections.txt index 94cc033..f2d0ded 100644 --- a/docs/reference/api/ModemManager-sections.txt +++ b/docs/reference/api/ModemManager-sections.txt @@ -1,4 +1,13 @@ <SECTION> +<FILE>mm-version</FILE> +<TITLE>Version checks</TITLE> +MM_MAJOR_VERSION +MM_MINOR_VERSION +MM_MICRO_VERSION +MM_CHECK_VERSION +</SECTION> + +<SECTION> <FILE>mm-enums</FILE> <TITLE>Flags and Enumerations</TITLE> MMBearerIpFamily @@ -23,6 +32,7 @@ MMModemState MMModemStateFailedReason MMModemStateChangeReason MMModemPowerState +MMModemPortType MMSmsPduType MMSmsState MMSmsDeliveryState diff --git a/docs/reference/api/html/ModemManager-Errors.html b/docs/reference/api/html/ModemManager-Errors.html index b570b89..a5f69d0 100644 --- a/docs/reference/api/html/ModemManager-Errors.html +++ b/docs/reference/api/html/ModemManager-Errors.html @@ -5,9 +5,9 @@ <title>Errors</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="ModemManager Reference Manual"> -<link rel="up" href="ref-dbus-common-types.html" title="Common types"> +<link rel="up" href="ref-common-types.html" title="Part II. Common types and definitions"> <link rel="prev" href="ModemManager-Flags-and-Enumerations.html" title="Flags and Enumerations"> -<link rel="next" href="ref-dbus-object-manager.html" title="The /org/freedesktop/ModemManager1 object"> +<link rel="next" href="ref-dbus.html" title="Part III. D-Bus Reference"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> @@ -15,10 +15,10 @@ <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> <tr valign="middle"> <td><a accesskey="p" href="ModemManager-Flags-and-Enumerations.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ref-dbus-common-types.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="u" href="ref-common-types.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">ModemManager Reference Manual</th> -<td><a accesskey="n" href="ref-dbus-object-manager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<td><a accesskey="n" href="ref-dbus.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr> <tr><td colspan="5" class="shortcuts"> <a href="#ModemManager-Errors.synopsis" class="shortcut">Top</a> diff --git a/docs/reference/api/html/ModemManager-Flags-and-Enumerations.html b/docs/reference/api/html/ModemManager-Flags-and-Enumerations.html index 8581c79..0d20495 100644 --- a/docs/reference/api/html/ModemManager-Flags-and-Enumerations.html +++ b/docs/reference/api/html/ModemManager-Flags-and-Enumerations.html @@ -5,8 +5,8 @@ <title>Flags and Enumerations</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="ModemManager Reference Manual"> -<link rel="up" href="ref-dbus-common-types.html" title="Common types"> -<link rel="prev" href="ref-dbus-common-types.html" title="Common types"> +<link rel="up" href="ref-common-types.html" title="Part II. Common types and definitions"> +<link rel="prev" href="ModemManager-Version-checks.html" title="Version checks"> <link rel="next" href="ModemManager-Errors.html" title="Errors"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> @@ -14,8 +14,8 @@ <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> <tr valign="middle"> -<td><a accesskey="p" href="ref-dbus-common-types.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ref-dbus-common-types.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="ModemManager-Version-checks.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ref-common-types.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">ModemManager Reference Manual</th> <td><a accesskey="n" href="ModemManager-Errors.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> @@ -59,6 +59,7 @@ enum <a class="link" href="ModemManager-Flags-and-Enumerations.ht enum <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMModemStateFailedReason" title="enum MMModemStateFailedReason">MMModemStateFailedReason</a>; enum <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMModemStateChangeReason" title="enum MMModemStateChangeReason">MMModemStateChangeReason</a>; enum <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMModemPowerState" title="enum MMModemPowerState">MMModemPowerState</a>; +enum <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMModemPortType" title="enum MMModemPortType">MMModemPortType</a>; enum <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMSmsPduType" title="enum MMSmsPduType">MMSmsPduType</a>; enum <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMSmsState" title="enum MMSmsState">MMSmsState</a>; enum <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMSmsDeliveryState" title="enum MMSmsDeliveryState">MMSmsDeliveryState</a>; @@ -1759,6 +1760,67 @@ Power state of the modem. </div> <hr> <div class="refsect2"> +<a name="MMModemPortType"></a><h3>enum MMModemPortType</h3> +<pre class="programlisting">typedef enum { + /*< underscore_name=mm_modem_port_type >*/ + MM_MODEM_PORT_TYPE_UNKNOWN = 1, + MM_MODEM_PORT_TYPE_NET = 2, + MM_MODEM_PORT_TYPE_AT = 3, + MM_MODEM_PORT_TYPE_QCDM = 4, + MM_MODEM_PORT_TYPE_GPS = 5, + MM_MODEM_PORT_TYPE_QMI = 6, + MM_MODEM_PORT_TYPE_MBIM = 7 +} MMModemPortType; +</pre> +<p> +Type of modem port. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><a name="MM-MODEM-PORT-TYPE-UNKNOWN:CAPS"></a><span class="term"><code class="literal">MM_MODEM_PORT_TYPE_UNKNOWN</code></span></p></td> +<td>Unknown. +</td> +</tr> +<tr> +<td><p><a name="MM-MODEM-PORT-TYPE-NET:CAPS"></a><span class="term"><code class="literal">MM_MODEM_PORT_TYPE_NET</code></span></p></td> +<td>Net port. +</td> +</tr> +<tr> +<td><p><a name="MM-MODEM-PORT-TYPE-AT:CAPS"></a><span class="term"><code class="literal">MM_MODEM_PORT_TYPE_AT</code></span></p></td> +<td>AT port. +</td> +</tr> +<tr> +<td><p><a name="MM-MODEM-PORT-TYPE-QCDM:CAPS"></a><span class="term"><code class="literal">MM_MODEM_PORT_TYPE_QCDM</code></span></p></td> +<td>QCDM port. +</td> +</tr> +<tr> +<td><p><a name="MM-MODEM-PORT-TYPE-GPS:CAPS"></a><span class="term"><code class="literal">MM_MODEM_PORT_TYPE_GPS</code></span></p></td> +<td>GPS port. +</td> +</tr> +<tr> +<td><p><a name="MM-MODEM-PORT-TYPE-QMI:CAPS"></a><span class="term"><code class="literal">MM_MODEM_PORT_TYPE_QMI</code></span></p></td> +<td>QMI port. +</td> +</tr> +<tr> +<td><p><a name="MM-MODEM-PORT-TYPE-MBIM:CAPS"></a><span class="term"><code class="literal">MM_MODEM_PORT_TYPE_MBIM</code></span></p></td> +<td>MBIM port. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> <a name="MMSmsPduType"></a><h3>enum MMSmsPduType</h3> <pre class="programlisting">typedef enum { /*< underscore_name=mm_sms_pdu_type >*/ diff --git a/docs/reference/api/html/ModemManager-Version-checks.html b/docs/reference/api/html/ModemManager-Version-checks.html new file mode 100644 index 0000000..1dafb8d --- /dev/null +++ b/docs/reference/api/html/ModemManager-Version-checks.html @@ -0,0 +1,122 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Version checks</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="ModemManager Reference Manual"> +<link rel="up" href="ref-common-types.html" title="Part II. Common types and definitions"> +<link rel="prev" href="ref-common-types.html" title="Part II. Common types and definitions"> +<link rel="next" href="ModemManager-Flags-and-Enumerations.html" title="Flags and Enumerations"> +<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="ref-common-types.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ref-common-types.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">ModemManager Reference Manual</th> +<td><a accesskey="n" href="ModemManager-Flags-and-Enumerations.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#ModemManager-Version-checks.synopsis" class="shortcut">Top</a> + | + <a href="#ModemManager-Version-checks.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry"> +<a name="ModemManager-Version-checks"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="ModemManager-Version-checks.top_of_page"></a>Version checks</span></h2> +<p>Version checks — Version information in the API.</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="ModemManager-Version-checks.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#define <a class="link" href="ModemManager-Version-checks.html#MM-MAJOR-VERSION:CAPS" title="MM_MAJOR_VERSION">MM_MAJOR_VERSION</a> +#define <a class="link" href="ModemManager-Version-checks.html#MM-MINOR-VERSION:CAPS" title="MM_MINOR_VERSION">MM_MINOR_VERSION</a> +#define <a class="link" href="ModemManager-Version-checks.html#MM-MICRO-VERSION:CAPS" title="MM_MICRO_VERSION">MM_MICRO_VERSION</a> +#define <a class="link" href="ModemManager-Version-checks.html#MM-CHECK-VERSION:CAPS" title="MM_CHECK_VERSION()">MM_CHECK_VERSION</a> (major, + minor, + micro) +</pre> +</div> +<div class="refsect1"> +<a name="ModemManager-Version-checks.description"></a><h2>Description</h2> +<p> +This section defines types that are used to identify the ModemManager version. +</p> +</div> +<div class="refsect1"> +<a name="ModemManager-Version-checks.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="MM-MAJOR-VERSION:CAPS"></a><h3>MM_MAJOR_VERSION</h3> +<pre class="programlisting">#define MM_MAJOR_VERSION (1) +</pre> +<p> +Evaluates to the major version number of ModemManager which this source +is compiled against. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="MM-MINOR-VERSION:CAPS"></a><h3>MM_MINOR_VERSION</h3> +<pre class="programlisting">#define MM_MINOR_VERSION (0) +</pre> +<p> +Evaluates to the minor version number of ModemManager which this source +is compiled against. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="MM-MICRO-VERSION:CAPS"></a><h3>MM_MICRO_VERSION</h3> +<pre class="programlisting">#define MM_MICRO_VERSION (0) +</pre> +<p> +Evaluates to the micro version number of ModemManager which this source +compiled against. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="MM-CHECK-VERSION:CAPS"></a><h3>MM_CHECK_VERSION()</h3> +<pre class="programlisting">#define MM_CHECK_VERSION(major,minor,micro)</pre> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td> +<td>major version (e.g. 1 for version 1.2.5)</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td> +<td>minor version (e.g. 2 for version 1.2.5)</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td> +<td>micro version (e.g. 5 for version 1.2.5)</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the version of the ModemManager header files +is the same as or newer than the passed-in version.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/api/html/ModemManager.devhelp2 b/docs/reference/api/html/ModemManager.devhelp2 index 0dc9752..8daac50 100644 --- a/docs/reference/api/html/ModemManager.devhelp2 +++ b/docs/reference/api/html/ModemManager.devhelp2 @@ -5,23 +5,28 @@ <sub name="ModemManager Overview" link="ref-overview.html"> <sub name="Introduction" link="ref-overview-introduction.html"/> <sub name="Modem detection and setup" link="ref-overview-modem-detection-and-setup.html"> - <sub name="Detection mechanisms" link="ref-overview-modem-detection-and-setup.html#idm266935804880"/> + <sub name="Detection mechanisms" link="ref-overview-modem-detection-and-setup.html#idm211863910672"/> <sub name="Probing" link="ch02s02.html"> - <sub name="Pre-probing filters" link="ch02s02.html#idm266943579776"/> - <sub name="Probing sequence" link="ch02s02.html#idm266934295312"/> - <sub name="Post-probing filters" link="ch02s02.html#idm266943548864"/> - <sub name="Probing setup examples" link="ch02s02.html#idm266936589872"/> + <sub name="Pre-probing filters" link="ch02s02.html#idm211863905456"/> + <sub name="Probing sequence" link="ch02s02.html#idm211854553632"/> + <sub name="Post-probing filters" link="ch02s02.html#idm211864004288"/> + <sub name="Probing setup examples" link="ch02s02.html#idm211856775152"/> </sub> <sub name="Port grabbing and Modem object creation" link="ch02s03.html"/> </sub> <sub name="Modem state machine" link="ref-overview-modem-state-machine.html"> - <sub name="Initialization" link="ref-overview-modem-state-machine.html#idm266936574096"/> + <sub name="Initialization" link="ref-overview-modem-state-machine.html#idm211856759264"/> <sub name="Enabling" link="ch03s02.html"/> <sub name="Connection & disconnection" link="ch03s03.html"/> <sub name="Disabling" link="ch03s04.html"/> </sub> <sub name="Plugin-specific Modems" link="ref-overview-plugin-specific-modems.html"/> </sub> + <sub name="Common types and definitions" link="ref-common-types.html"> + <sub name="Version checks" link="ModemManager-Version-checks.html"/> + <sub name="Flags and Enumerations" link="ModemManager-Flags-and-Enumerations.html"/> + <sub name="Errors" link="ModemManager-Errors.html"/> + </sub> <sub name="D-Bus Reference" link="ref-dbus.html"> <sub name="The org.freedesktop.ModemManager1 bus name" link="ref-dbus-bus-name.html"/> <sub name="Standard interfaces" link="ref-dbus-standard-interfaces.html"> @@ -29,10 +34,6 @@ <sub name="org.freedesktop.DBus.Introspectable" link="ref-dbus-standard-interfaces-introspectables.html"/> <sub name="org.freedesktop.DBus.ObjectManager" link="ref-dbus-standard-interfaces-objectmanager.html"/> </sub> - <sub name="Common types" link="ref-dbus-common-types.html"> - <sub name="Flags and Enumerations" link="ModemManager-Flags-and-Enumerations.html"/> - <sub name="Errors" link="ModemManager-Errors.html"/> - </sub> <sub name="The /org/freedesktop/ModemManager1 object" link="ref-dbus-object-manager.html"> <sub name="org.freedesktop.ModemManager1" link="gdbus-org.freedesktop.ModemManager1.html"/> </sub> @@ -46,7 +47,6 @@ <sub name="org.freedesktop.ModemManager1.Modem.Location" link="gdbus-org.freedesktop.ModemManager1.Modem.Location.html"/> <sub name="org.freedesktop.ModemManager1.Modem.Time" link="gdbus-org.freedesktop.ModemManager1.Modem.Time.html"/> <sub name="org.freedesktop.ModemManager1.Modem.Firmware" link="gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html"/> - <sub name="org.freedesktop.ModemManager1.Modem.Contacts" link="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html"/> </sub> <sub name="The /org/freedesktop/ModemManager/Bearers objects" link="ref-dbus-object-bearer.html"> <sub name="org.freedesktop.ModemManager1.Bearer" link="gdbus-org.freedesktop.ModemManager1.Bearer.html"/> @@ -58,9 +58,21 @@ <sub name="org.freedesktop.ModemManager1.Sms" link="gdbus-org.freedesktop.ModemManager1.Sms.html"/> </sub> </sub> + <sub name="Migrating from ModemManager 0.6 to ModemManager 1.0" link="ref-migrating.html"> + <sub name="" link="ch12.html"> + <sub name="Listing available modems" link="ch12.html#idm211850989168"/> + <sub name="PIN unlocking" link="ch12s02.html"/> + <sub name="Connection and disconnection" link="ch12s03.html"/> + <sub name="Simple connection" link="ch12s04.html"/> + </sub> + </sub> <sub name="Index" link="ix01.html"/> </chapters> <functions> + <keyword type="macro" name="MM_MAJOR_VERSION" link="ModemManager-Version-checks.html#MM-MAJOR-VERSION:CAPS"/> + <keyword type="macro" name="MM_MINOR_VERSION" link="ModemManager-Version-checks.html#MM-MINOR-VERSION:CAPS"/> + <keyword type="macro" name="MM_MICRO_VERSION" link="ModemManager-Version-checks.html#MM-MICRO-VERSION:CAPS"/> + <keyword type="macro" name="MM_CHECK_VERSION()" link="ModemManager-Version-checks.html#MM-CHECK-VERSION:CAPS"/> <keyword type="enum" name="enum MMBearerIpFamily" link="ModemManager-Flags-and-Enumerations.html#MMBearerIpFamily"/> <keyword type="enum" name="enum MMBearerIpMethod" link="ModemManager-Flags-and-Enumerations.html#MMBearerIpMethod"/> <keyword type="enum" name="enum MMBearerAllowedAuth" link="ModemManager-Flags-and-Enumerations.html#MMBearerAllowedAuth"/> @@ -83,6 +95,7 @@ <keyword type="enum" name="enum MMModemStateFailedReason" link="ModemManager-Flags-and-Enumerations.html#MMModemStateFailedReason"/> <keyword type="enum" name="enum MMModemStateChangeReason" link="ModemManager-Flags-and-Enumerations.html#MMModemStateChangeReason"/> <keyword type="enum" name="enum MMModemPowerState" link="ModemManager-Flags-and-Enumerations.html#MMModemPowerState"/> + <keyword type="enum" name="enum MMModemPortType" link="ModemManager-Flags-and-Enumerations.html#MMModemPortType"/> <keyword type="enum" name="enum MMSmsPduType" link="ModemManager-Flags-and-Enumerations.html#MMSmsPduType"/> <keyword type="enum" name="enum MMSmsState" link="ModemManager-Flags-and-Enumerations.html#MMSmsState"/> <keyword type="enum" name="enum MMSmsDeliveryState" link="ModemManager-Flags-and-Enumerations.html#MMSmsDeliveryState"/> @@ -121,6 +134,7 @@ <keyword type="property" name="The "Drivers" property" link="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.Drivers"/> <keyword type="property" name="The "Plugin" property" link="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.Plugin"/> <keyword type="property" name="The "PrimaryPort" property" link="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.PrimaryPort"/> + <keyword type="property" name="The "Ports" property" link="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.Ports"/> <keyword type="property" name="The "EquipmentIdentifier" property" link="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.EquipmentIdentifier"/> <keyword type="property" name="The "UnlockRequired" property" link="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.UnlockRequired"/> <keyword type="property" name="The "UnlockRetries" property" link="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.UnlockRetries"/> @@ -179,14 +193,6 @@ <keyword type="property" name="The "NetworkTimezone" property" link="gdbus-org.freedesktop.ModemManager1.Modem.Time.html#gdbus-property-org-freedesktop-ModemManager1-Modem-Time.NetworkTimezone"/> <keyword type="method" name="The List() method" link="gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.List"/> <keyword type="method" name="The Select() method" link="gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.Select"/> - <keyword type="method" name="The Add() method" link="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Add"/> - <keyword type="method" name="The Delete() method" link="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Delete"/> - <keyword type="method" name="The Get() method" link="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Get"/> - <keyword type="method" name="The List() method" link="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.List"/> - <keyword type="method" name="The Find() method" link="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Find"/> - <keyword type="method" name="The GetCount() method" link="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.GetCount"/> - <keyword type="signal" name="The "Added" signal" link="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-signal-org-freedesktop-ModemManager1-Modem-Contacts.Added"/> - <keyword type="signal" name="The "Deleted" signal" link="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-signal-org-freedesktop-ModemManager1-Modem-Contacts.Deleted"/> <keyword type="method" name="The Connect() method" link="gdbus-org.freedesktop.ModemManager1.Bearer.html#gdbus-method-org-freedesktop-ModemManager1-Bearer.Connect"/> <keyword type="method" name="The Disconnect() method" link="gdbus-org.freedesktop.ModemManager1.Bearer.html#gdbus-method-org-freedesktop-ModemManager1-Bearer.Disconnect"/> <keyword type="property" name="The "Interface" property" link="gdbus-org.freedesktop.ModemManager1.Bearer.html#gdbus-property-org-freedesktop-ModemManager1-Bearer.Interface"/> @@ -429,6 +435,13 @@ <keyword type="constant" name="MM_MODEM_POWER_STATE_OFF" link="ModemManager-Flags-and-Enumerations.html#MM-MODEM-POWER-STATE-OFF:CAPS"/> <keyword type="constant" name="MM_MODEM_POWER_STATE_LOW" link="ModemManager-Flags-and-Enumerations.html#MM-MODEM-POWER-STATE-LOW:CAPS"/> <keyword type="constant" name="MM_MODEM_POWER_STATE_ON" link="ModemManager-Flags-and-Enumerations.html#MM-MODEM-POWER-STATE-ON:CAPS"/> + <keyword type="constant" name="MM_MODEM_PORT_TYPE_UNKNOWN" link="ModemManager-Flags-and-Enumerations.html#MM-MODEM-PORT-TYPE-UNKNOWN:CAPS"/> + <keyword type="constant" name="MM_MODEM_PORT_TYPE_NET" link="ModemManager-Flags-and-Enumerations.html#MM-MODEM-PORT-TYPE-NET:CAPS"/> + <keyword type="constant" name="MM_MODEM_PORT_TYPE_AT" link="ModemManager-Flags-and-Enumerations.html#MM-MODEM-PORT-TYPE-AT:CAPS"/> + <keyword type="constant" name="MM_MODEM_PORT_TYPE_QCDM" link="ModemManager-Flags-and-Enumerations.html#MM-MODEM-PORT-TYPE-QCDM:CAPS"/> + <keyword type="constant" name="MM_MODEM_PORT_TYPE_GPS" link="ModemManager-Flags-and-Enumerations.html#MM-MODEM-PORT-TYPE-GPS:CAPS"/> + <keyword type="constant" name="MM_MODEM_PORT_TYPE_QMI" link="ModemManager-Flags-and-Enumerations.html#MM-MODEM-PORT-TYPE-QMI:CAPS"/> + <keyword type="constant" name="MM_MODEM_PORT_TYPE_MBIM" link="ModemManager-Flags-and-Enumerations.html#MM-MODEM-PORT-TYPE-MBIM:CAPS"/> <keyword type="constant" name="MM_SMS_PDU_TYPE_UNKNOWN" link="ModemManager-Flags-and-Enumerations.html#MM-SMS-PDU-TYPE-UNKNOWN:CAPS"/> <keyword type="constant" name="MM_SMS_PDU_TYPE_DELIVER" link="ModemManager-Flags-and-Enumerations.html#MM-SMS-PDU-TYPE-DELIVER:CAPS"/> <keyword type="constant" name="MM_SMS_PDU_TYPE_SUBMIT" link="ModemManager-Flags-and-Enumerations.html#MM-SMS-PDU-TYPE-SUBMIT:CAPS"/> diff --git a/docs/reference/api/html/ch02s02.html b/docs/reference/api/html/ch02s02.html index 59ac2e3..4d01761 100644 --- a/docs/reference/api/html/ch02s02.html +++ b/docs/reference/api/html/ch02s02.html @@ -21,7 +21,7 @@ </tr></table> <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="idm266935749600"></a>Probing</h2></div></div></div> +<a name="idm211863907456"></a>Probing</h2></div></div></div> <p> Whenever a new device is detected by ModemManager, port probing process will get started, so that we can determine which kind of ports we have, and also @@ -37,7 +37,7 @@ </p> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idm266943579776"></a>Pre-probing filters</h3></div></div></div> +<a name="idm211863905456"></a>Pre-probing filters</h3></div></div></div> <p> Pre-probing filters are those which control whether the probing, as requested by the specific plugin, takes place. @@ -127,7 +127,7 @@ </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idm266934295312"></a>Probing sequence</h3></div></div></div> +<a name="idm211854553632"></a>Probing sequence</h3></div></div></div> <p> Whenever all pre-probing filters of a given plugin pass, ModemManager will run the probing sequence as requested by the specific plugin. The main purpose of the @@ -216,7 +216,7 @@ </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idm266943548864"></a>Post-probing filters</h3></div></div></div> +<a name="idm211864004288"></a>Post-probing filters</h3></div></div></div> <p> Post-probing filters are required to identify whether a plugin can handle a given modem, in special cases where the information retrieved from udev is either not @@ -294,9 +294,9 @@ </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idm266936589872"></a>Probing setup examples</h3></div></div></div> +<a name="idm211856775152"></a>Probing setup examples</h3></div></div></div> <div class="example"> -<a name="idm266936589136"></a><p class="title"><b>Example 1. Probing setup for a plugin requiring udev-based vendor/product checks</b></p> +<a name="idm211856774416"></a><p class="title"><b>Example 1. Probing setup for a plugin requiring udev-based vendor/product checks</b></p> <div class="example-contents"> <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> <tbody> @@ -358,7 +358,7 @@ </div> <br class="example-break"><div class="example"> -<a name="idm266936586704"></a><p class="title"><b>Example 2. Probing setup for a plugin requiring AT-probed vendor/product checks</b></p> +<a name="idm211856771984"></a><p class="title"><b>Example 2. Probing setup for a plugin requiring AT-probed vendor/product checks</b></p> <div class="example-contents"> <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> <tbody> @@ -414,7 +414,7 @@ </div> <br class="example-break"><div class="example"> -<a name="idm266936584304"></a><p class="title"><b>Example 3. Probing setup for a plugin with custom initialization requirements</b></p> +<a name="idm211856769584"></a><p class="title"><b>Example 3. Probing setup for a plugin with custom initialization requirements</b></p> <div class="example-contents"> <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> <tbody> diff --git a/docs/reference/api/html/ch02s03.html b/docs/reference/api/html/ch02s03.html index 8aa0872..89fc5b3 100644 --- a/docs/reference/api/html/ch02s03.html +++ b/docs/reference/api/html/ch02s03.html @@ -21,7 +21,7 @@ </tr></table> <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="idm266936581152"></a>Port grabbing and Modem object creation</h2></div></div></div> +<a name="idm211856766320"></a>Port grabbing and Modem object creation</h2></div></div></div> <p> Once a port passes all probing filters of a given plugin, the plugin will grab the port. When the first port of a given device is grabbed, the plugin will create diff --git a/docs/reference/api/html/ch03s02.html b/docs/reference/api/html/ch03s02.html index ba1ddfe..664cc69 100644 --- a/docs/reference/api/html/ch03s02.html +++ b/docs/reference/api/html/ch03s02.html @@ -21,7 +21,7 @@ </tr></table> <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="idm266936557056"></a>Enabling</h2></div></div></div> +<a name="idm211856742224"></a>Enabling</h2></div></div></div> <p> Modem enabling is the user-requested sequence with the sole purpose of bringing the modem to a state where it can get connected. diff --git a/docs/reference/api/html/ch03s03.html b/docs/reference/api/html/ch03s03.html index be6334e..cc62014 100644 --- a/docs/reference/api/html/ch03s03.html +++ b/docs/reference/api/html/ch03s03.html @@ -21,7 +21,7 @@ </tr></table> <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="idm266936542224"></a>Connection & disconnection</h2></div></div></div> +<a name="idm211856727392"></a>Connection & disconnection</h2></div></div></div> <p> Connecting the Modem is done through the <span class="emphasis"><em>Bearer</em></span> objects. Once such an object is created, the user can request to get the given bearer connected. diff --git a/docs/reference/api/html/ch03s04.html b/docs/reference/api/html/ch03s04.html index a661b4e..388da75 100644 --- a/docs/reference/api/html/ch03s04.html +++ b/docs/reference/api/html/ch03s04.html @@ -21,7 +21,7 @@ </tr></table> <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="idm266936538208"></a>Disabling</h2></div></div></div> +<a name="idm211856723376"></a>Disabling</h2></div></div></div> <p> Users can disable the modems, which will bring them to a state where they are in low power mode (e.g. RF switched off) and not registered in any network. diff --git a/docs/reference/api/html/ch12.html b/docs/reference/api/html/ch12.html new file mode 100644 index 0000000..3ec9d85 --- /dev/null +++ b/docs/reference/api/html/ch12.html @@ -0,0 +1,65 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title></title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="ModemManager Reference Manual"> +<link rel="up" href="ref-migrating.html" title="Part IV. Migrating from ModemManager 0.6 to ModemManager 1.0"> +<link rel="prev" href="ref-migrating.html" title="Part IV. Migrating from ModemManager 0.6 to ModemManager 1.0"> +<link rel="next" href="ch12s02.html" title="PIN unlocking"> +<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="ref-migrating.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ref-migrating.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">ModemManager Reference Manual</th> +<td><a accesskey="n" href="ch12s02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"></div> +<div class="toc"><dl class="toc"> +<dt><span class="section"><a href="ch12.html#idm211850989168">Listing available modems</a></span></dt> +<dt><span class="section"><a href="ch12s02.html">PIN unlocking</a></span></dt> +<dt><span class="section"><a href="ch12s03.html">Connection and disconnection</a></span></dt> +<dt><span class="section"><a href="ch12s04.html">Simple connection</a></span></dt> +</dl></div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="idm211850989168"></a>Listing available modems</h2></div></div></div> +<p> + The D-Bus name <code class="literal">org.freedesktop.ModemManager1</code> + on the system bus is the new name used by the ModemManager 1.0 daemon, and it + implements several standard DBus interfaces, including the new + <a class="ulink" href="http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager" target="_top"> + <code class="literal">org.freedesktop.DBus.ObjectManager</code> + </a> + interface, which allows to list available modem objects and get notifications + where new ones are added or when existing ones are removed. There are therefore + neither a custom method to enumerate devices as in the old 0.6 interface, nor + custom signals to notify about added or removed modems. + </p> +<p> + Modems which are found but are not usable will be flagged with a + <a class="link" href="ModemManager-Flags-and-Enumerations.html#MM-MODEM-STATE-FAILED:CAPS"><code class="constant">MM_MODEM_STATE_FAILED</code></a> + state in the + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.State" title='The "State" property'> + <code class="literal">State</code> + </a> + property, and a more detailed reason about the failure will be given in the + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.StateFailedReason" title='The "StateFailedReason" property'> + <code class="literal">StateFailedReason</code> + </a> + property. The most common case of failure is to have the SIM missing in a modem which + requires one for operation. + </p> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/api/html/ch12s02.html b/docs/reference/api/html/ch12s02.html new file mode 100644 index 0000000..3d4d66a --- /dev/null +++ b/docs/reference/api/html/ch12s02.html @@ -0,0 +1,52 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>PIN unlocking</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="ModemManager Reference Manual"> +<link rel="up" href="ch12.html" title=""> +<link rel="prev" href="ch12.html" title=""> +<link rel="next" href="ch12s03.html" title="Connection and disconnection"> +<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="ch12.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch12.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">ModemManager Reference Manual</th> +<td><a accesskey="n" href="ch12s03.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="idm211856200960"></a>PIN unlocking</h2></div></div></div> +<p> + The process of PIN unlocking the modem is now performed with the + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Sim.html#gdbus-method-org-freedesktop-ModemManager1-Sim.SendPin" title="The SendPin() method"> + <code class="function">SendPin()</code> + </a> + method in the + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Sim.html" title="org.freedesktop.ModemManager1.Sim"> + <code class="literal">org.freedesktop.ModemManager1.Sim</code> + </a> + interface. + </p> +<p> + The path of the SIM object is specified in the + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.Sim" title='The "Sim" property'> + <code class="literal">Sim</code> + </a> + property of the + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html" title="org.freedesktop.ModemManager1.Modem"> + <code class="literal">org.freedesktop.ModemManager1.Modem</code> + </a> + interface. If the modem doesn't have a SIM, no object path will be given. + </p> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/api/html/ch12s03.html b/docs/reference/api/html/ch12s03.html new file mode 100644 index 0000000..b22ae7a --- /dev/null +++ b/docs/reference/api/html/ch12s03.html @@ -0,0 +1,70 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Connection and disconnection</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="ModemManager Reference Manual"> +<link rel="up" href="ch12.html" title=""> +<link rel="prev" href="ch12s02.html" title="PIN unlocking"> +<link rel="next" href="ch12s04.html" title="Simple connection"> +<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="ch12s02.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch12.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">ModemManager Reference Manual</th> +<td><a accesskey="n" href="ch12s04.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="idm211855470720"></a>Connection and disconnection</h2></div></div></div> +<p> + The process of requesting to connect or disconnect the modem is now split into + two operations: creating a bearer with + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-method-org-freedesktop-ModemManager1-Modem.CreateBearer" title="The CreateBearer() method"> + <code class="function">CreateBearer()</code> + </a> + in the + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html" title="org.freedesktop.ModemManager1.Modem"> + <code class="literal">org.freedesktop.ModemManager1.Modem</code> + </a> + interface and getting the bearer connected with + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Bearer.html#gdbus-method-org-freedesktop-ModemManager1-Bearer.Connect" title="The Connect() method"> + <code class="function">Connect()</code> + </a> + in the + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Bearer.html" title="org.freedesktop.ModemManager1.Bearer"> + <code class="literal">org.freedesktop.ModemManager1.Bearer</code> + </a> + interface. These two steps are equivalent to the old <code class="literal"><code class="function">Connect()</code></code> + method in the previous <code class="literal">org.freedesktop.ModemManager.Modem</code> + interface. + </p> +<p> + The old <code class="literal"><code class="function">Disconnect()</code></code> + method in the previous <code class="literal">org.freedesktop.ModemManager.Modem</code> + interface is therefore also applied in a per-bearer basis through the new + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Bearer.html#gdbus-method-org-freedesktop-ModemManager1-Bearer.Disconnect" title="The Disconnect() method"> + <code class="function">Disconnect()</code> + </a> + in the + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Bearer.html" title="org.freedesktop.ModemManager1.Bearer"> + <code class="literal">org.freedesktop.ModemManager1.Bearer</code> + </a> + interface. + </p> +<p> + This logic of splitting the connection logic allows ModemManager to create + multiple bearers that may be connected to e.g. different access points (if + the modem allows it). + </p> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/api/html/ch12s04.html b/docs/reference/api/html/ch12s04.html new file mode 100644 index 0000000..68fc85f --- /dev/null +++ b/docs/reference/api/html/ch12s04.html @@ -0,0 +1,61 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Simple connection</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="ModemManager Reference Manual"> +<link rel="up" href="ch12.html" title=""> +<link rel="prev" href="ch12s03.html" title="Connection and disconnection"> +<link rel="next" href="ix01.html" title="Index"> +<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="ch12s03.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch12.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">ModemManager Reference Manual</th> +<td><a accesskey="n" href="ix01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="idm211857333392"></a>Simple connection</h2></div></div></div> +<p> + In order to simplify the whole sequence to get the modem connected, ModemManager + still exposes a Simple interface, renamed as: + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Simple.html" title="org.freedesktop.ModemManager1.Modem.Simple"> + <code class="literal">org.freedesktop.ModemManager1.Modem.Simple</code> + </a>. + </p> +<p> + The + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Simple.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Simple.Connect" title="The Connect() method"> + <code class="function">Connect()</code> + </a> + method will create a single bearer with the parameters specified in the call an get + it connected, while the + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Simple.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Simple.Disconnect" title="The Disconnect() method"> + <code class="function">Disconnect()</code> + </a> + method will disconnect all available bearers. + </p> +<p> + One of the main differences with respect to the 0.6 interface, is that + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Simple.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Simple.Connect" title="The Connect() method"> + <code class="function">Connect()</code> + </a> + doesn't support to change allowed modes or bands. Instead, these operations should + be done through the methods in the + <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html" title="org.freedesktop.ModemManager1.Modem"> + <code class="literal">org.freedesktop.ModemManager1.Modem</code> + </a> + interface. + </p> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Bearer.html b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Bearer.html index cf44c78..9563e62 100644 --- a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Bearer.html +++ b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Bearer.html @@ -45,7 +45,7 @@ </pre> </div> <div class="refsect1"> -<a name="idm266931416432"></a><h2>Properties</h2> +<a name="idm211849419184"></a><h2>Properties</h2> <pre class="synopsis"> <a class="link" href="gdbus-org.freedesktop.ModemManager1.Bearer.html#gdbus-property-org-freedesktop-ModemManager1-Bearer.Interface" title='The "Interface" property'>Interface</a> readable s <a class="link" href="gdbus-org.freedesktop.ModemManager1.Bearer.html#gdbus-property-org-freedesktop-ModemManager1-Bearer.Connected" title='The "Connected" property'>Connected</a> readable b diff --git a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html deleted file mode 100644 index dac9708..0000000 --- a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html +++ /dev/null @@ -1,338 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>org.freedesktop.ModemManager1.Modem.Contacts</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> -<link rel="home" href="index.html" title="ModemManager Reference Manual"> -<link rel="up" href="ref-dbus-object-modem.html" title="The /org/freedesktop/ModemManager/Modems objects"> -<link rel="prev" href="gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html" title="org.freedesktop.ModemManager1.Modem.Firmware"> -<link rel="next" href="ref-dbus-object-bearer.html" title="The /org/freedesktop/ModemManager/Bearers objects"> -<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> -<link rel="stylesheet" href="style.css" type="text/css"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> -<tr valign="middle"> -<td><a accesskey="p" href="gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ref-dbus-object-modem.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> -<th width="100%" align="center">ModemManager Reference Manual</th> -<td><a accesskey="n" href="ref-dbus-object-bearer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#gdbus-org.freedesktop.ModemManager1.Modem.Contacts.synopsis" class="shortcut">Top</a> - | - <a href="#gdbus-org.freedesktop.ModemManager1.Modem.Contacts.description" class="shortcut">Description</a> - | - <a href="#gdbus-org.freedesktop.ModemManager1.Modem.Contacts.signals" class="shortcut">Signals</a> -</td></tr> -</table> -<div class="refentry"> -<a name="gdbus-org.freedesktop.ModemManager1.Modem.Contacts"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-ModemManager1-Modem-Contacts.top_of_page"></a>org.freedesktop.ModemManager1.Modem.Contacts</span></h2> -<p>org.freedesktop.ModemManager1.Modem.Contacts — The ModemManager Contacts interface.</p> -</td> -<td valign="top" align="right"></td> -</tr></table></div> -<div class="refsynopsisdiv"> -<h2>Methods</h2> -<pre class="synopsis"> -<a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Add" title="The Add() method">Add</a> (IN a{sv} properties, - OUT u index); -<a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Delete" title="The Delete() method">Delete</a> (IN u index); -<a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Get" title="The Get() method">Get</a> (IN u index, - OUT a{sv} properties); -<a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.List" title="The List() method">List</a> (OUT aa{sv} results); -<a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Find" title="The Find() method">Find</a> (IN s pattern, - OUT aa{sv} results); -<a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.GetCount" title="The GetCount() method">GetCount</a> (OUT u count); -</pre> -</div> -<div class="refsect1"> -<a name="idm266930928400"></a><h2>Signals</h2> -<pre class="synopsis"> -<a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-signal-org-freedesktop-ModemManager1-Modem-Contacts.Added" title='The "Added" signal'>Added</a> (u index, - a{sv} properties); -<a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-signal-org-freedesktop-ModemManager1-Modem-Contacts.Deleted" title='The "Deleted" signal'>Deleted</a> (u index); -</pre> -</div> -<div class="refsect1"> -<a name="gdbus-interface-org-freedesktop-ModemManager1-Modem-Contacts"></a><h2>Description</h2> -<p> This interface provides access to contacts stored in various locations, - including SIM cards, device storage, and other locations. Operations - generally operate on all contacts regardless of their actual storage - location. -</p> -<p> Contacts are referred to by index numbers, which are internal to - ModemManager and do not represent indexes of SIM cards or the device. - Indexes may not be contiguous. -</p> -</div> -<div class="refsect1"> -<a name="gdbus-methods-org.freedesktop.ModemManager1.Modem.Contacts"></a><h2>Method Details</h2> -<div class="refsect2"> -<a name="gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Add"></a><h3>The Add() method</h3> -<pre class="programlisting"> -Add (IN a{sv} properties, - OUT u index); -</pre> -<p> Add a new contact. -</p> -<p> If any of the property in <em class="parameter"><code>properties</code></em> exceeds the modem's size limit, - that property will be truncated to fit. -</p> -<p> Known properties are: - </p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><code class="literal">"name"</code></span></p></td> -<td> - Full name of the contact, given as a string value - (signature <code class="literal">"s"</code>). - </td> -</tr> -<tr> -<td><p><span class="term"><code class="literal">"number"</code></span></p></td> -<td> - Telephone number, given as a string value - (signature <code class="literal">"s"</code>). - </td> -</tr> -<tr> -<td><p><span class="term"><code class="literal">"email"</code></span></p></td> -<td> - Email address, given as a string value - (signature <code class="literal">"s"</code>). - </td> -</tr> -<tr> -<td><p><span class="term"><code class="literal">"group"</code></span></p></td> -<td> - Group this contact belongs to, given as a string value - (signature <code class="literal">"s"</code>). - </td> -</tr> -<tr> -<td><p><span class="term"><code class="literal">"name2"</code></span></p></td> -<td> - Additional contact name, given as a string value - (signature <code class="literal">"s"</code>). - </td> -</tr> -<tr> -<td><p><span class="term"><code class="literal">"number2"</code></span></p></td> -<td> - Additional contact telephone number, given as a string value - (signature <code class="literal">"s"</code>). - </td> -</tr> -<tr> -<td><p><span class="term"><code class="literal">"hidden"</code></span></p></td> -<td> - Boolean flag to specify whether this entry is hidden or not, - (signature <code class="literal">"b"</code>). - </td> -</tr> -<tr> -<td><p><span class="term"><code class="literal">"storage"</code></span></p></td> -<td> - Phonebook in which the contact is stored, given as a - <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMModemContactsStorage" title="enum MMModemContactsStorage">MMModemContactsStorage</a>, - (signature <code class="literal">"u"</code>). - </td> -</tr> -</tbody> -</table></div> -<p> -</p> -<p> The <em class="parameter"><code>index</code></em> number is an internal private number to ModemManager and does - not correspond to the index of the contact in the modem or SIM itself. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>properties</code></em></code>:</span></p></td> -<td><p>Dictionary of properties describing the contact.</p></td> -</tr> -<tr> -<td><p><span class="term"><code class="literal">OUT u <em class="parameter"><code>index</code></em></code>:</span></p></td> -<td><p>The index number of the new contact</p></td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Delete"></a><h3>The Delete() method</h3> -<pre class="programlisting"> -Delete (IN u index); -</pre> -<p> Delete a contact. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody><tr> -<td><p><span class="term"><code class="literal">IN u <em class="parameter"><code>index</code></em></code>:</span></p></td> -<td><p>The index of the contact to delete.</p></td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Get"></a><h3>The Get() method</h3> -<pre class="programlisting"> -Get (IN u index, - OUT a{sv} properties); -</pre> -<p> Retrieve a contact. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><code class="literal">IN u <em class="parameter"><code>index</code></em></code>:</span></p></td> -<td><p>The index of the contact.</p></td> -</tr> -<tr> -<td><p><span class="term"><code class="literal">OUT a{sv} <em class="parameter"><code>properties</code></em></code>:</span></p></td> -<td><p>The properties of the contact.</p></td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.List"></a><h3>The List() method</h3> -<pre class="programlisting"> -List (OUT aa{sv} results); -</pre> -<p> List all contacts. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody><tr> -<td><p><span class="term"><code class="literal">OUT aa{sv} <em class="parameter"><code>results</code></em></code>:</span></p></td> -<td><p>An array of dictionaries, each dictionary representing a contact.</p></td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Find"></a><h3>The Find() method</h3> -<pre class="programlisting"> -Find (IN s pattern, - OUT aa{sv} results); -</pre> -<p> Find a contact. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>pattern</code></em></code>:</span></p></td> -<td><p>The pattern to search for.</p></td> -</tr> -<tr> -<td><p><span class="term"><code class="literal">OUT aa{sv} <em class="parameter"><code>results</code></em></code>:</span></p></td> -<td><p>An array of dictionaries, each dictionary representing a contact.</p></td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.GetCount"></a><h3>The GetCount() method</h3> -<pre class="programlisting"> -GetCount (OUT u count); -</pre> -<p> Get the number of contacts. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody><tr> -<td><p><span class="term"><code class="literal">OUT u <em class="parameter"><code>count</code></em></code>:</span></p></td> -<td><p>The number of contacts.</p></td> -</tr></tbody> -</table></div> -</div> -</div> -<div class="refsect1"> -<a name="gdbus-signals-org.freedesktop.ModemManager1.Modem.Contacts"></a><h2>Signal Details</h2> -<div class="refsect2"> -<a name="gdbus-signal-org-freedesktop-ModemManager1-Modem-Contacts.Added"></a><h3>The "Added" signal</h3> -<pre class="programlisting"> -Added (u index, - a{sv} properties); -</pre> -<p> Emitted when a new contact is added. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><code class="literal">u <em class="parameter"><code>index</code></em></code>:</span></p></td> -<td><p>The index number of the new contact.</p></td> -</tr> -<tr> -<td><p><span class="term"><code class="literal">a{sv} <em class="parameter"><code>properties</code></em></code>:</span></p></td> -<td><p>The properties of the contact.</p></td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdbus-signal-org-freedesktop-ModemManager1-Modem-Contacts.Deleted"></a><h3>The "Deleted" signal</h3> -<pre class="programlisting"> -Deleted (u index); -</pre> -<p> Emitted when a new contact has been deleted. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody><tr> -<td><p><span class="term"><code class="literal">u <em class="parameter"><code>index</code></em></code>:</span></p></td> -<td><p>The index number of the now deleted contact.</p></td> -</tr></tbody> -</table></div> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.18.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html index b9f99cc..0663fad 100644 --- a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html +++ b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html @@ -7,7 +7,7 @@ <link rel="home" href="index.html" title="ModemManager Reference Manual"> <link rel="up" href="ref-dbus-object-modem.html" title="The /org/freedesktop/ModemManager/Modems objects"> <link rel="prev" href="gdbus-org.freedesktop.ModemManager1.Modem.Time.html" title="org.freedesktop.ModemManager1.Modem.Time"> -<link rel="next" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html" title="org.freedesktop.ModemManager1.Modem.Contacts"> +<link rel="next" href="ref-dbus-object-bearer.html" title="The /org/freedesktop/ModemManager/Bearers objects"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> @@ -18,7 +18,7 @@ <td><a accesskey="u" href="ref-dbus-object-modem.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">ModemManager Reference Manual</th> -<td><a accesskey="n" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<td><a accesskey="n" href="ref-dbus-object-bearer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr> <tr><td colspan="5" class="shortcuts"> <a href="#gdbus-org.freedesktop.ModemManager1.Modem.Firmware.synopsis" class="shortcut">Top</a> diff --git a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Location.html b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Location.html index 6ea804b..7e6cf75 100644 --- a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Location.html +++ b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Location.html @@ -46,7 +46,7 @@ </pre> </div> <div class="refsect1"> -<a name="idm266931584784"></a><h2>Properties</h2> +<a name="idm211857531456"></a><h2>Properties</h2> <pre class="synopsis"> <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Location.html#gdbus-property-org-freedesktop-ModemManager1-Modem-Location.Capabilities" title='The "Capabilities" property'>Capabilities</a> readable u <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Location.html#gdbus-property-org-freedesktop-ModemManager1-Modem-Location.Enabled" title='The "Enabled" property'>Enabled</a> readable u diff --git a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Messaging.html b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Messaging.html index fae8796..45d9b7d 100644 --- a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Messaging.html +++ b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Messaging.html @@ -49,7 +49,7 @@ </pre> </div> <div class="refsect1"> -<a name="idm266933889056"></a><h2>Signals</h2> +<a name="idm211849157856"></a><h2>Signals</h2> <pre class="synopsis"> <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Messaging.html#gdbus-signal-org-freedesktop-ModemManager1-Modem-Messaging.Added" title='The "Added" signal'>Added</a> (o path, b received); @@ -57,7 +57,7 @@ </pre> </div> <div class="refsect1"> -<a name="idm266933017440"></a><h2>Properties</h2> +<a name="idm211850974416"></a><h2>Properties</h2> <pre class="synopsis"> <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Messaging.html#gdbus-property-org-freedesktop-ModemManager1-Modem-Messaging.SupportedStorages" title='The "SupportedStorages" property'>SupportedStorages</a> readable au <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Messaging.html#gdbus-property-org-freedesktop-ModemManager1-Modem-Messaging.DefaultStorage" title='The "DefaultStorage" property'>DefaultStorage</a> readable u diff --git a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.html b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.html index 6a24839..e0c1fa6 100644 --- a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.html +++ b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.html @@ -48,7 +48,7 @@ </pre> </div> <div class="refsect1"> -<a name="idm266931120224"></a><h2>Properties</h2> +<a name="idm211849574576"></a><h2>Properties</h2> <pre class="synopsis"> <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.html#gdbus-property-org-freedesktop-ModemManager1-Modem-Modem3gpp-Ussd.State" title='The "State" property'>State</a> readable u <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.html#gdbus-property-org-freedesktop-ModemManager1-Modem-Modem3gpp-Ussd.NetworkNotification" title='The "NetworkNotification" property'>NetworkNotification</a> readable s diff --git a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Modem3gpp.html b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Modem3gpp.html index 8a11a5e..f542f2e 100644 --- a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Modem3gpp.html +++ b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Modem3gpp.html @@ -45,7 +45,7 @@ </pre> </div> <div class="refsect1"> -<a name="idm266930283696"></a><h2>Properties</h2> +<a name="idm211849150832"></a><h2>Properties</h2> <pre class="synopsis"> <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Modem3gpp.html#gdbus-property-org-freedesktop-ModemManager1-Modem-Modem3gpp.Imei" title='The "Imei" property'>Imei</a> readable s <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Modem3gpp.html#gdbus-property-org-freedesktop-ModemManager1-Modem-Modem3gpp.RegistrationState" title='The "RegistrationState" property'>RegistrationState</a> readable u diff --git a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.ModemCdma.html b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.ModemCdma.html index 2ff39ea..c8c4aa0 100644 --- a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.ModemCdma.html +++ b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.ModemCdma.html @@ -47,7 +47,7 @@ </pre> </div> <div class="refsect1"> -<a name="idm266930845344"></a><h2>Signals</h2> +<a name="idm211849006752"></a><h2>Signals</h2> <pre class="synopsis"> <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.ModemCdma.html#gdbus-signal-org-freedesktop-ModemManager1-Modem-ModemCdma.ActivationStateChanged" title='The "ActivationStateChanged" signal'>ActivationStateChanged</a> (u activation_state, u activation_error, @@ -55,7 +55,7 @@ </pre> </div> <div class="refsect1"> -<a name="idm266929185104"></a><h2>Properties</h2> +<a name="idm211850177040"></a><h2>Properties</h2> <pre class="synopsis"> <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.ModemCdma.html#gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.ActivationState" title='The "ActivationState" property'>ActivationState</a> readable u <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.ModemCdma.html#gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Meid" title='The "Meid" property'>Meid</a> readable s diff --git a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Time.html b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Time.html index 0ceea8c..05189c4 100644 --- a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Time.html +++ b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.Time.html @@ -46,13 +46,13 @@ </pre> </div> <div class="refsect1"> -<a name="idm266929702128"></a><h2>Signals</h2> +<a name="idm211848200064"></a><h2>Signals</h2> <pre class="synopsis"> <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Time.html#gdbus-signal-org-freedesktop-ModemManager1-Modem-Time.NetworkTimeChanged" title='The "NetworkTimeChanged" signal'>NetworkTimeChanged</a> (s time); </pre> </div> <div class="refsect1"> -<a name="idm266932813568"></a><h2>Properties</h2> +<a name="idm211853110096"></a><h2>Properties</h2> <pre class="synopsis"> <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Time.html#gdbus-property-org-freedesktop-ModemManager1-Modem-Time.NetworkTimezone" title='The "NetworkTimezone" property'>NetworkTimezone</a> readable a{sv} </pre> diff --git a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.html b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.html index eb6c5df..4d34dce 100644 --- a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.html +++ b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Modem.html @@ -59,7 +59,7 @@ </pre> </div> <div class="refsect1"> -<a name="idm266931107200"></a><h2>Signals</h2> +<a name="idm211852023552"></a><h2>Signals</h2> <pre class="synopsis"> <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-signal-org-freedesktop-ModemManager1-Modem.StateChanged" title='The "StateChanged" signal'>StateChanged</a> (i old, i new, @@ -67,7 +67,7 @@ </pre> </div> <div class="refsect1"> -<a name="idm266931445968"></a><h2>Properties</h2> +<a name="idm211850417072"></a><h2>Properties</h2> <pre class="synopsis"> <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.Sim" title='The "Sim" property'>Sim</a> readable o <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.SupportedCapabilities" title='The "SupportedCapabilities" property'>SupportedCapabilities</a> readable au @@ -82,6 +82,7 @@ <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.Drivers" title='The "Drivers" property'>Drivers</a> readable as <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.Plugin" title='The "Plugin" property'>Plugin</a> readable s <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.PrimaryPort" title='The "PrimaryPort" property'>PrimaryPort</a> readable s +<a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.Ports" title='The "Ports" property'>Ports</a> readable a(su) <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.EquipmentIdentifier" title='The "EquipmentIdentifier" property'>EquipmentIdentifier</a> readable s <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.UnlockRequired" title='The "UnlockRequired" property'>UnlockRequired</a> readable u <a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.UnlockRetries" title='The "UnlockRetries" property'>UnlockRetries</a> readable a{uu} @@ -585,6 +586,18 @@ PrimaryPort readable s </div> <hr> <div class="refsect2"> +<a name="gdbus-property-org-freedesktop-ModemManager1-Modem.Ports"></a><h3>The "Ports" property</h3> +<pre class="programlisting"> +Ports readable a(su) +</pre> +<p> The list of ports in the modem, given as an array of string and unsigned + integer pairs. The string is the port name or path, and the integer is + the port type given as a + <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMModemPortType" title="enum MMModemPortType">MMModemPortType</a> value. +</p> +</div> +<hr> +<div class="refsect2"> <a name="gdbus-property-org-freedesktop-ModemManager1-Modem.EquipmentIdentifier"></a><h3>The "EquipmentIdentifier" property</h3> <pre class="programlisting"> EquipmentIdentifier readable s diff --git a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Sim.html b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Sim.html index d9b03f9..db23dd6 100644 --- a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Sim.html +++ b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Sim.html @@ -50,7 +50,7 @@ </pre> </div> <div class="refsect1"> -<a name="idm266929225280"></a><h2>Properties</h2> +<a name="idm211853113248"></a><h2>Properties</h2> <pre class="synopsis"> <a class="link" href="gdbus-org.freedesktop.ModemManager1.Sim.html#gdbus-property-org-freedesktop-ModemManager1-Sim.SimIdentifier" title='The "SimIdentifier" property'>SimIdentifier</a> readable s <a class="link" href="gdbus-org.freedesktop.ModemManager1.Sim.html#gdbus-property-org-freedesktop-ModemManager1-Sim.Imsi" title='The "Imsi" property'>Imsi</a> readable s diff --git a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Sms.html b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Sms.html index a209606..9e9df3a 100644 --- a/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Sms.html +++ b/docs/reference/api/html/gdbus-org.freedesktop.ModemManager1.Sms.html @@ -7,7 +7,7 @@ <link rel="home" href="index.html" title="ModemManager Reference Manual"> <link rel="up" href="ref-dbus-object-sms.html" title="The /org/freedesktop/ModemManager/SMSs objects"> <link rel="prev" href="ref-dbus-object-sms.html" title="The /org/freedesktop/ModemManager/SMSs objects"> -<link rel="next" href="ix01.html" title="Index"> +<link rel="next" href="ref-migrating.html" title="Part IV. Migrating from ModemManager 0.6 to ModemManager 1.0"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> @@ -18,7 +18,7 @@ <td><a accesskey="u" href="ref-dbus-object-sms.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">ModemManager Reference Manual</th> -<td><a accesskey="n" href="ix01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<td><a accesskey="n" href="ref-migrating.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr> <tr><td colspan="5" class="shortcuts"> <a href="#gdbus-org.freedesktop.ModemManager1.Sms.synopsis" class="shortcut">Top</a> @@ -45,7 +45,7 @@ </pre> </div> <div class="refsect1"> -<a name="idm266929424032"></a><h2>Properties</h2> +<a name="idm211852063152"></a><h2>Properties</h2> <pre class="synopsis"> <a class="link" href="gdbus-org.freedesktop.ModemManager1.Sms.html#gdbus-property-org-freedesktop-ModemManager1-Sms.State" title='The "State" property'>State</a> readable u <a class="link" href="gdbus-org.freedesktop.ModemManager1.Sms.html#gdbus-property-org-freedesktop-ModemManager1-Sms.PduType" title='The "PduType" property'>PduType</a> readable u diff --git a/docs/reference/api/html/index.html b/docs/reference/api/html/index.html index 4025e07..ba407c1 100644 --- a/docs/reference/api/html/index.html +++ b/docs/reference/api/html/index.html @@ -36,12 +36,12 @@ </div> </div></div> <div><p class="releaseinfo"> - For ModemManager version 0.7.991 + For ModemManager version 1.0.0 </p></div> -<div><p class="copyright">Copyright © 2008, 2009, 2010, 2011, 2012 The ModemManager Authors</p></div> +<div><p class="copyright">Copyright © 2008, 2009, 2010, 2011, 2012, 2013 The ModemManager Authors</p></div> <div><div class="legalnotice"> -<a name="idm266943528256"></a><p> +<a name="idm211863716176"></a><p> Permission is granted to copy, distribute and/or modify this document under the terms of the <em class="citetitle">GNU Free Documentation License</em>, Version 1.3 or any later @@ -70,43 +70,46 @@ <dt><span class="chapter"><a href="ref-overview-introduction.html">Introduction</a></span></dt> <dt><span class="chapter"><a href="ref-overview-modem-detection-and-setup.html">Modem detection and setup</a></span></dt> <dd><dl> -<dt><span class="section"><a href="ref-overview-modem-detection-and-setup.html#idm266935804880">Detection mechanisms</a></span></dt> +<dt><span class="section"><a href="ref-overview-modem-detection-and-setup.html#idm211863910672">Detection mechanisms</a></span></dt> <dt><span class="section"><a href="ch02s02.html">Probing</a></span></dt> <dd><dl> -<dt><span class="section"><a href="ch02s02.html#idm266943579776">Pre-probing filters</a></span></dt> -<dt><span class="section"><a href="ch02s02.html#idm266934295312">Probing sequence</a></span></dt> -<dt><span class="section"><a href="ch02s02.html#idm266943548864">Post-probing filters</a></span></dt> -<dt><span class="section"><a href="ch02s02.html#idm266936589872">Probing setup examples</a></span></dt> +<dt><span class="section"><a href="ch02s02.html#idm211863905456">Pre-probing filters</a></span></dt> +<dt><span class="section"><a href="ch02s02.html#idm211854553632">Probing sequence</a></span></dt> +<dt><span class="section"><a href="ch02s02.html#idm211864004288">Post-probing filters</a></span></dt> +<dt><span class="section"><a href="ch02s02.html#idm211856775152">Probing setup examples</a></span></dt> </dl></dd> <dt><span class="section"><a href="ch02s03.html">Port grabbing and Modem object creation</a></span></dt> </dl></dd> <dt><span class="chapter"><a href="ref-overview-modem-state-machine.html">Modem state machine</a></span></dt> <dd><dl> -<dt><span class="section"><a href="ref-overview-modem-state-machine.html#idm266936574096">Initialization</a></span></dt> +<dt><span class="section"><a href="ref-overview-modem-state-machine.html#idm211856759264">Initialization</a></span></dt> <dt><span class="section"><a href="ch03s02.html">Enabling</a></span></dt> <dt><span class="section"><a href="ch03s03.html">Connection & disconnection</a></span></dt> <dt><span class="section"><a href="ch03s04.html">Disabling</a></span></dt> </dl></dd> <dt><span class="chapter"><a href="ref-overview-plugin-specific-modems.html">Plugin-specific Modems</a></span></dt> </dl></dd> -<dt><span class="part"><a href="ref-dbus.html">II. D-Bus Reference</a></span></dt> -<dd><dl> -<dt><span class="chapter"><a href="ref-dbus-bus-name.html">The <code class="literal">org.freedesktop.ModemManager1</code> bus name</a></span></dt> -<dt><span class="chapter"><a href="ref-dbus-standard-interfaces.html">Standard interfaces</a></span></dt> -<dd><dl> -<dt><span class="section"><a href="ref-dbus-standard-interfaces.html#ref-dbus-standard-interfaces-properties">org.freedesktop.DBus.Properties</a></span></dt> -<dt><span class="section"><a href="ref-dbus-standard-interfaces-introspectables.html">org.freedesktop.DBus.Introspectable</a></span></dt> -<dt><span class="section"><a href="ref-dbus-standard-interfaces-objectmanager.html">org.freedesktop.DBus.ObjectManager</a></span></dt> -</dl></dd> -<dt><span class="chapter"><a href="ref-dbus-common-types.html">Common types</a></span></dt> +<dt><span class="part"><a href="ref-common-types.html">II. Common types and definitions</a></span></dt> <dd><dl> <dt> +<span class="refentrytitle"><a href="ModemManager-Version-checks.html">Version checks</a></span><span class="refpurpose"> — Version information in the API.</span> +</dt> +<dt> <span class="refentrytitle"><a href="ModemManager-Flags-and-Enumerations.html">Flags and Enumerations</a></span><span class="refpurpose"> — Common enumerations and types in the API.</span> </dt> <dt> <span class="refentrytitle"><a href="ModemManager-Errors.html">Errors</a></span><span class="refpurpose"> — Common errors in the API.</span> </dt> </dl></dd> +<dt><span class="part"><a href="ref-dbus.html">III. D-Bus Reference</a></span></dt> +<dd><dl> +<dt><span class="chapter"><a href="ref-dbus-bus-name.html">The <code class="literal">org.freedesktop.ModemManager1</code> bus name</a></span></dt> +<dt><span class="chapter"><a href="ref-dbus-standard-interfaces.html">Standard interfaces</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="ref-dbus-standard-interfaces.html#ref-dbus-standard-interfaces-properties">org.freedesktop.DBus.Properties</a></span></dt> +<dt><span class="section"><a href="ref-dbus-standard-interfaces-introspectables.html">org.freedesktop.DBus.Introspectable</a></span></dt> +<dt><span class="section"><a href="ref-dbus-standard-interfaces-objectmanager.html">org.freedesktop.DBus.ObjectManager</a></span></dt> +</dl></dd> <dt><span class="chapter"><a href="ref-dbus-object-manager.html">The <code class="literal">/org/freedesktop/ModemManager1</code> object</a></span></dt> <dd><dl><dt> <span class="refentrytitle"><a href="gdbus-org.freedesktop.ModemManager1.html">org.freedesktop.ModemManager1</a></span><span class="refpurpose"> — The ModemManager Manager interface.</span> @@ -140,9 +143,6 @@ <dt> <span class="refentrytitle"><a href="gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html">org.freedesktop.ModemManager1.Modem.Firmware</a></span><span class="refpurpose"> — The ModemManager Firmware interface.</span> </dt> -<dt> -<span class="refentrytitle"><a href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html">org.freedesktop.ModemManager1.Modem.Contacts</a></span><span class="refpurpose"> — The ModemManager Contacts interface.</span> -</dt> </dl></dd> <dt><span class="chapter"><a href="ref-dbus-object-bearer.html">The <code class="literal">/org/freedesktop/ModemManager/Bearers</code> objects</a></span></dt> <dd><dl><dt> @@ -157,6 +157,16 @@ <span class="refentrytitle"><a href="gdbus-org.freedesktop.ModemManager1.Sms.html">org.freedesktop.ModemManager1.Sms</a></span><span class="refpurpose"> — The ModemManager SMS interface.</span> </dt></dl></dd> </dl></dd> +<dt><span class="part"><a href="ref-migrating.html">IV. Migrating from ModemManager 0.6 to ModemManager 1.0</a></span></dt> +<dd><dl> +<dt><span class="chapter"><a href="ch12.html"></a></span></dt> +<dd><dl> +<dt><span class="section"><a href="ch12.html#idm211850989168">Listing available modems</a></span></dt> +<dt><span class="section"><a href="ch12s02.html">PIN unlocking</a></span></dt> +<dt><span class="section"><a href="ch12s03.html">Connection and disconnection</a></span></dt> +<dt><span class="section"><a href="ch12s04.html">Simple connection</a></span></dt> +</dl></dd> +</dl></dd> <dt><span class="index"><a href="ix01.html">Index</a></span></dt> </dl></div> </div> diff --git a/docs/reference/api/html/index.sgml b/docs/reference/api/html/index.sgml index 3fc4ea1..dd3638d 100644 --- a/docs/reference/api/html/index.sgml +++ b/docs/reference/api/html/index.sgml @@ -1,3 +1,11 @@ +<ANCHOR id="ModemManager-Version-checks" href="ModemManager/ModemManager-Version-checks.html"> +<ANCHOR id="ModemManager-Version-checks.synopsis" href="ModemManager/ModemManager-Version-checks.html#ModemManager-Version-checks.synopsis"> +<ANCHOR id="ModemManager-Version-checks.description" href="ModemManager/ModemManager-Version-checks.html#ModemManager-Version-checks.description"> +<ANCHOR id="ModemManager-Version-checks.details" href="ModemManager/ModemManager-Version-checks.html#ModemManager-Version-checks.details"> +<ANCHOR id="MM-MAJOR-VERSION:CAPS" href="ModemManager/ModemManager-Version-checks.html#MM-MAJOR-VERSION:CAPS"> +<ANCHOR id="MM-MINOR-VERSION:CAPS" href="ModemManager/ModemManager-Version-checks.html#MM-MINOR-VERSION:CAPS"> +<ANCHOR id="MM-MICRO-VERSION:CAPS" href="ModemManager/ModemManager-Version-checks.html#MM-MICRO-VERSION:CAPS"> +<ANCHOR id="MM-CHECK-VERSION:CAPS" href="ModemManager/ModemManager-Version-checks.html#MM-CHECK-VERSION:CAPS"> <ANCHOR id="ModemManager-Flags-and-Enumerations" href="ModemManager/ModemManager-Flags-and-Enumerations.html"> <ANCHOR id="ModemManager-Flags-and-Enumerations.synopsis" href="ModemManager/ModemManager-Flags-and-Enumerations.html#ModemManager-Flags-and-Enumerations.synopsis"> <ANCHOR id="ModemManager-Flags-and-Enumerations.description" href="ModemManager/ModemManager-Flags-and-Enumerations.html#ModemManager-Flags-and-Enumerations.description"> @@ -233,6 +241,14 @@ <ANCHOR id="MM-MODEM-POWER-STATE-OFF:CAPS" href="ModemManager/ModemManager-Flags-and-Enumerations.html#MM-MODEM-POWER-STATE-OFF:CAPS"> <ANCHOR id="MM-MODEM-POWER-STATE-LOW:CAPS" href="ModemManager/ModemManager-Flags-and-Enumerations.html#MM-MODEM-POWER-STATE-LOW:CAPS"> <ANCHOR id="MM-MODEM-POWER-STATE-ON:CAPS" href="ModemManager/ModemManager-Flags-and-Enumerations.html#MM-MODEM-POWER-STATE-ON:CAPS"> +<ANCHOR id="MMModemPortType" href="ModemManager/ModemManager-Flags-and-Enumerations.html#MMModemPortType"> +<ANCHOR id="MM-MODEM-PORT-TYPE-UNKNOWN:CAPS" href="ModemManager/ModemManager-Flags-and-Enumerations.html#MM-MODEM-PORT-TYPE-UNKNOWN:CAPS"> +<ANCHOR id="MM-MODEM-PORT-TYPE-NET:CAPS" href="ModemManager/ModemManager-Flags-and-Enumerations.html#MM-MODEM-PORT-TYPE-NET:CAPS"> +<ANCHOR id="MM-MODEM-PORT-TYPE-AT:CAPS" href="ModemManager/ModemManager-Flags-and-Enumerations.html#MM-MODEM-PORT-TYPE-AT:CAPS"> +<ANCHOR id="MM-MODEM-PORT-TYPE-QCDM:CAPS" href="ModemManager/ModemManager-Flags-and-Enumerations.html#MM-MODEM-PORT-TYPE-QCDM:CAPS"> +<ANCHOR id="MM-MODEM-PORT-TYPE-GPS:CAPS" href="ModemManager/ModemManager-Flags-and-Enumerations.html#MM-MODEM-PORT-TYPE-GPS:CAPS"> +<ANCHOR id="MM-MODEM-PORT-TYPE-QMI:CAPS" href="ModemManager/ModemManager-Flags-and-Enumerations.html#MM-MODEM-PORT-TYPE-QMI:CAPS"> +<ANCHOR id="MM-MODEM-PORT-TYPE-MBIM:CAPS" href="ModemManager/ModemManager-Flags-and-Enumerations.html#MM-MODEM-PORT-TYPE-MBIM:CAPS"> <ANCHOR id="MMSmsPduType" href="ModemManager/ModemManager-Flags-and-Enumerations.html#MMSmsPduType"> <ANCHOR id="MM-SMS-PDU-TYPE-UNKNOWN:CAPS" href="ModemManager/ModemManager-Flags-and-Enumerations.html#MM-SMS-PDU-TYPE-UNKNOWN:CAPS"> <ANCHOR id="MM-SMS-PDU-TYPE-DELIVER:CAPS" href="ModemManager/ModemManager-Flags-and-Enumerations.html#MM-SMS-PDU-TYPE-DELIVER:CAPS"> @@ -444,6 +460,7 @@ <ANCHOR id="gdbus-property-org-freedesktop-ModemManager1-Modem.Drivers" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.Drivers"> <ANCHOR id="gdbus-property-org-freedesktop-ModemManager1-Modem.Plugin" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.Plugin"> <ANCHOR id="gdbus-property-org-freedesktop-ModemManager1-Modem.PrimaryPort" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.PrimaryPort"> +<ANCHOR id="gdbus-property-org-freedesktop-ModemManager1-Modem.Ports" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.Ports"> <ANCHOR id="gdbus-property-org-freedesktop-ModemManager1-Modem.EquipmentIdentifier" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.EquipmentIdentifier"> <ANCHOR id="gdbus-property-org-freedesktop-ModemManager1-Modem.UnlockRequired" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.UnlockRequired"> <ANCHOR id="gdbus-property-org-freedesktop-ModemManager1-Modem.UnlockRetries" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.UnlockRetries"> @@ -535,18 +552,6 @@ <ANCHOR id="gdbus-methods-org.freedesktop.ModemManager1.Modem.Firmware" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html#gdbus-methods-org.freedesktop.ModemManager1.Modem.Firmware"> <ANCHOR id="gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.List" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.List"> <ANCHOR id="gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.Select" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Firmware.Select"> -<ANCHOR id="gdbus-org.freedesktop.ModemManager1.Modem.Contacts" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html"> -<ANCHOR id="gdbus-interface-org-freedesktop-ModemManager1-Modem-Contacts" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-interface-org-freedesktop-ModemManager1-Modem-Contacts"> -<ANCHOR id="gdbus-methods-org.freedesktop.ModemManager1.Modem.Contacts" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-methods-org.freedesktop.ModemManager1.Modem.Contacts"> -<ANCHOR id="gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Add" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Add"> -<ANCHOR id="gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Delete" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Delete"> -<ANCHOR id="gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Get" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Get"> -<ANCHOR id="gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.List" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.List"> -<ANCHOR id="gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Find" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Find"> -<ANCHOR id="gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.GetCount" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.GetCount"> -<ANCHOR id="gdbus-signals-org.freedesktop.ModemManager1.Modem.Contacts" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-signals-org.freedesktop.ModemManager1.Modem.Contacts"> -<ANCHOR id="gdbus-signal-org-freedesktop-ModemManager1-Modem-Contacts.Added" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-signal-org-freedesktop-ModemManager1-Modem-Contacts.Added"> -<ANCHOR id="gdbus-signal-org-freedesktop-ModemManager1-Modem-Contacts.Deleted" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-signal-org-freedesktop-ModemManager1-Modem-Contacts.Deleted"> <ANCHOR id="gdbus-org.freedesktop.ModemManager1.Bearer" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Bearer.html"> <ANCHOR id="gdbus-interface-org-freedesktop-ModemManager1-Bearer" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Bearer.html#gdbus-interface-org-freedesktop-ModemManager1-Bearer"> <ANCHOR id="gdbus-methods-org.freedesktop.ModemManager1.Bearer" href="ModemManager/gdbus-org.freedesktop.ModemManager1.Bearer.html#gdbus-methods-org.freedesktop.ModemManager1.Bearer"> diff --git a/docs/reference/api/html/ix01.html b/docs/reference/api/html/ix01.html index f254905..a41d6e6 100644 --- a/docs/reference/api/html/ix01.html +++ b/docs/reference/api/html/ix01.html @@ -6,13 +6,13 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="ModemManager Reference Manual"> <link rel="up" href="index.html" title="ModemManager Reference Manual"> -<link rel="prev" href="gdbus-org.freedesktop.ModemManager1.Sms.html" title="org.freedesktop.ModemManager1.Sms"> +<link rel="prev" href="ch12s04.html" title="Simple connection"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> -<td><a accesskey="p" href="gdbus-org.freedesktop.ModemManager1.Sms.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="p" href="ch12s04.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> <td> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">ModemManager Reference Manual</th> @@ -20,7 +20,7 @@ </tr></table> <div class="index"> <div class="titlepage"><div><div><h1 class="title"> -<a name="idm266943367152"></a>Index</h1></div></div></div> +<a name="idm211863868880"></a>Index</h1></div></div></div> <div class="index"> <div class="indexdiv"> <h3>B</h3> @@ -58,6 +58,8 @@ <dl> <dt>MMCdmaActivationError, <a class="indexterm" href="ModemManager-Errors.html#MMCdmaActivationError">enum MMCdmaActivationError</a> </dt> +<dt>MM_CHECK_VERSION, <a class="indexterm" href="ModemManager-Version-checks.html#MM-CHECK-VERSION:CAPS">MM_CHECK_VERSION()</a> +</dt> <dt>MMConnectionError, <a class="indexterm" href="ModemManager-Errors.html#MMConnectionError">enum MMConnectionError</a> </dt> <dt>MMCoreError, <a class="indexterm" href="ModemManager-Errors.html#MMCoreError">enum MMCoreError</a> @@ -72,32 +74,20 @@ <div class="indexdiv"> <h3>M</h3> <dl> +<dt>MM_MAJOR_VERSION, <a class="indexterm" href="ModemManager-Version-checks.html#MM-MAJOR-VERSION:CAPS">MM_MAJOR_VERSION</a> +</dt> <dt>MMMessageError, <a class="indexterm" href="ModemManager-Errors.html#MMMessageError">enum MMMessageError</a> </dt> +<dt>MM_MICRO_VERSION, <a class="indexterm" href="ModemManager-Version-checks.html#MM-MICRO-VERSION:CAPS">MM_MICRO_VERSION</a> +</dt> +<dt>MM_MINOR_VERSION, <a class="indexterm" href="ModemManager-Version-checks.html#MM-MINOR-VERSION:CAPS">MM_MINOR_VERSION</a> +</dt> <dt>MMMobileEquipmentError, <a class="indexterm" href="ModemManager-Errors.html#MMMobileEquipmentError">enum MMMobileEquipmentError</a> </dt> <dt>org.freedesktop.ModemManager1.Modem, <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-interface-org-freedesktop-ModemManager1-Modem.top_of_page">org.freedesktop.ModemManager1.Modem</a> </dt> <dt>org.freedesktop.ModemManager1.Modem.Command(), <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-method-org-freedesktop-ModemManager1-Modem.Command">The Command() method</a> </dt> -<dt>org.freedesktop.ModemManager1.Modem.Contacts, <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-interface-org-freedesktop-ModemManager1-Modem-Contacts.top_of_page">org.freedesktop.ModemManager1.Modem.Contacts</a> -</dt> -<dt>org.freedesktop.ModemManager1.Modem.Contacts.Add(), <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Add">The Add() method</a> -</dt> -<dt>org.freedesktop.ModemManager1.Modem.Contacts.Delete(), <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Delete">The Delete() method</a> -</dt> -<dt>org.freedesktop.ModemManager1.Modem.Contacts.Find(), <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Find">The Find() method</a> -</dt> -<dt>org.freedesktop.ModemManager1.Modem.Contacts.Get(), <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.Get">The Get() method</a> -</dt> -<dt>org.freedesktop.ModemManager1.Modem.Contacts.GetCount(), <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.GetCount">The GetCount() method</a> -</dt> -<dt>org.freedesktop.ModemManager1.Modem.Contacts.List(), <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Contacts.List">The List() method</a> -</dt> -<dt>org.freedesktop.ModemManager1.Modem.Contacts::Added, <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-signal-org-freedesktop-ModemManager1-Modem-Contacts.Added">The "Added" signal</a> -</dt> -<dt>org.freedesktop.ModemManager1.Modem.Contacts::Deleted, <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html#gdbus-signal-org-freedesktop-ModemManager1-Modem-Contacts.Deleted">The "Deleted" signal</a> -</dt> <dt>org.freedesktop.ModemManager1.Modem.CreateBearer(), <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-method-org-freedesktop-ModemManager1-Modem.CreateBearer">The CreateBearer() method</a> </dt> <dt>org.freedesktop.ModemManager1.Modem.DeleteBearer(), <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-method-org-freedesktop-ModemManager1-Modem.DeleteBearer">The DeleteBearer() method</a> @@ -238,6 +228,8 @@ </dt> <dt>org.freedesktop.ModemManager1.Modem:Plugin, <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.Plugin">The "Plugin" property</a> </dt> +<dt>org.freedesktop.ModemManager1.Modem:Ports, <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.Ports">The "Ports" property</a> +</dt> <dt>org.freedesktop.ModemManager1.Modem:PowerState, <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.PowerState">The "PowerState" property</a> </dt> <dt>org.freedesktop.ModemManager1.Modem:PrimaryPort, <a class="indexterm" href="gdbus-org.freedesktop.ModemManager1.Modem.html#gdbus-property-org-freedesktop-ModemManager1-Modem.PrimaryPort">The "PrimaryPort" property</a> @@ -306,6 +298,8 @@ </dt> <dt>MMModemMode, <a class="indexterm" href="ModemManager-Flags-and-Enumerations.html#MMModemMode">enum MMModemMode</a> </dt> +<dt>MMModemPortType, <a class="indexterm" href="ModemManager-Flags-and-Enumerations.html#MMModemPortType">enum MMModemPortType</a> +</dt> <dt>MMModemPowerState, <a class="indexterm" href="ModemManager-Flags-and-Enumerations.html#MMModemPowerState">enum MMModemPowerState</a> </dt> <dt>MMModemState, <a class="indexterm" href="ModemManager-Flags-and-Enumerations.html#MMModemState">enum MMModemState</a> diff --git a/docs/reference/api/html/ref-dbus-common-types.html b/docs/reference/api/html/ref-common-types.html index ed6e18c..d5b79a9 100644 --- a/docs/reference/api/html/ref-dbus-common-types.html +++ b/docs/reference/api/html/ref-common-types.html @@ -2,34 +2,40 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Common types</title> +<title>Part II. Common types and definitions</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="ModemManager Reference Manual"> -<link rel="up" href="ref-dbus.html" title="Part II. D-Bus Reference"> -<link rel="prev" href="ref-dbus-standard-interfaces-objectmanager.html" title="org.freedesktop.DBus.ObjectManager"> -<link rel="next" href="ModemManager-Flags-and-Enumerations.html" title="Flags and Enumerations"> +<link rel="up" href="index.html" title="ModemManager Reference Manual"> +<link rel="prev" href="ref-overview-plugin-specific-modems.html" title="Plugin-specific Modems"> +<link rel="next" href="ModemManager-Version-checks.html" title="Version checks"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> -<td><a accesskey="p" href="ref-dbus-standard-interfaces-objectmanager.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ref-dbus.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="ref-overview-plugin-specific-modems.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">ModemManager Reference Manual</th> -<td><a accesskey="n" href="ModemManager-Flags-and-Enumerations.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<td><a accesskey="n" href="ModemManager-Version-checks.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr></table> -<div class="chapter"> -<div class="titlepage"><div><div><h2 class="title"> -<a name="ref-dbus-common-types"></a>Common types</h2></div></div></div> -<div class="toc"><dl class="toc"> +<div class="part"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="ref-common-types"></a>Part II. Common types and definitions</h1></div></div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl class="toc"> +<dt> +<span class="refentrytitle"><a href="ModemManager-Version-checks.html">Version checks</a></span><span class="refpurpose"> — Version information in the API.</span> +</dt> <dt> <span class="refentrytitle"><a href="ModemManager-Flags-and-Enumerations.html">Flags and Enumerations</a></span><span class="refpurpose"> — Common enumerations and types in the API.</span> </dt> <dt> <span class="refentrytitle"><a href="ModemManager-Errors.html">Errors</a></span><span class="refpurpose"> — Common errors in the API.</span> </dt> -</dl></div> +</dl> +</div> </div> <div class="footer"> <hr> diff --git a/docs/reference/api/html/ref-dbus-bus-name.html b/docs/reference/api/html/ref-dbus-bus-name.html index a77bfbc..b288136 100644 --- a/docs/reference/api/html/ref-dbus-bus-name.html +++ b/docs/reference/api/html/ref-dbus-bus-name.html @@ -5,8 +5,8 @@ <title>The org.freedesktop.ModemManager1 bus name</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="ModemManager Reference Manual"> -<link rel="up" href="ref-dbus.html" title="Part II. D-Bus Reference"> -<link rel="prev" href="ref-dbus.html" title="Part II. D-Bus Reference"> +<link rel="up" href="ref-dbus.html" title="Part III. D-Bus Reference"> +<link rel="prev" href="ref-dbus.html" title="Part III. D-Bus Reference"> <link rel="next" href="ref-dbus-standard-interfaces.html" title="Standard interfaces"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> diff --git a/docs/reference/api/html/ref-dbus-object-bearer.html b/docs/reference/api/html/ref-dbus-object-bearer.html index eec5cfe..4246389 100644 --- a/docs/reference/api/html/ref-dbus-object-bearer.html +++ b/docs/reference/api/html/ref-dbus-object-bearer.html @@ -5,15 +5,15 @@ <title>The /org/freedesktop/ModemManager/Bearers objects</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="ModemManager Reference Manual"> -<link rel="up" href="ref-dbus.html" title="Part II. D-Bus Reference"> -<link rel="prev" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html" title="org.freedesktop.ModemManager1.Modem.Contacts"> +<link rel="up" href="ref-dbus.html" title="Part III. D-Bus Reference"> +<link rel="prev" href="gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html" title="org.freedesktop.ModemManager1.Modem.Firmware"> <link rel="next" href="gdbus-org.freedesktop.ModemManager1.Bearer.html" title="org.freedesktop.ModemManager1.Bearer"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> -<td><a accesskey="p" href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="p" href="gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> <td><a accesskey="u" href="ref-dbus.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">ModemManager Reference Manual</th> diff --git a/docs/reference/api/html/ref-dbus-object-manager.html b/docs/reference/api/html/ref-dbus-object-manager.html index ffb332c..f7e271d 100644 --- a/docs/reference/api/html/ref-dbus-object-manager.html +++ b/docs/reference/api/html/ref-dbus-object-manager.html @@ -5,15 +5,15 @@ <title>The /org/freedesktop/ModemManager1 object</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="ModemManager Reference Manual"> -<link rel="up" href="ref-dbus.html" title="Part II. D-Bus Reference"> -<link rel="prev" href="ModemManager-Errors.html" title="Errors"> +<link rel="up" href="ref-dbus.html" title="Part III. D-Bus Reference"> +<link rel="prev" href="ref-dbus-standard-interfaces-objectmanager.html" title="org.freedesktop.DBus.ObjectManager"> <link rel="next" href="gdbus-org.freedesktop.ModemManager1.html" title="org.freedesktop.ModemManager1"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> -<td><a accesskey="p" href="ModemManager-Errors.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="p" href="ref-dbus-standard-interfaces-objectmanager.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> <td><a accesskey="u" href="ref-dbus.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">ModemManager Reference Manual</th> diff --git a/docs/reference/api/html/ref-dbus-object-modem.html b/docs/reference/api/html/ref-dbus-object-modem.html index 004f8f3..abdb953 100644 --- a/docs/reference/api/html/ref-dbus-object-modem.html +++ b/docs/reference/api/html/ref-dbus-object-modem.html @@ -5,7 +5,7 @@ <title>The /org/freedesktop/ModemManager/Modems objects</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="ModemManager Reference Manual"> -<link rel="up" href="ref-dbus.html" title="Part II. D-Bus Reference"> +<link rel="up" href="ref-dbus.html" title="Part III. D-Bus Reference"> <link rel="prev" href="gdbus-org.freedesktop.ModemManager1.html" title="org.freedesktop.ModemManager1"> <link rel="next" href="gdbus-org.freedesktop.ModemManager1.Modem.html" title="org.freedesktop.ModemManager1.Modem"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> @@ -50,9 +50,6 @@ <dt> <span class="refentrytitle"><a href="gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html">org.freedesktop.ModemManager1.Modem.Firmware</a></span><span class="refpurpose"> — The ModemManager Firmware interface.</span> </dt> -<dt> -<span class="refentrytitle"><a href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html">org.freedesktop.ModemManager1.Modem.Contacts</a></span><span class="refpurpose"> — The ModemManager Contacts interface.</span> -</dt> </dl></div> <p> Modem objects are exported in DBus with the following path base: diff --git a/docs/reference/api/html/ref-dbus-object-sim.html b/docs/reference/api/html/ref-dbus-object-sim.html index 10c19a9..b6c5f3b 100644 --- a/docs/reference/api/html/ref-dbus-object-sim.html +++ b/docs/reference/api/html/ref-dbus-object-sim.html @@ -5,7 +5,7 @@ <title>The /org/freedesktop/ModemManager/SIMs objects</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="ModemManager Reference Manual"> -<link rel="up" href="ref-dbus.html" title="Part II. D-Bus Reference"> +<link rel="up" href="ref-dbus.html" title="Part III. D-Bus Reference"> <link rel="prev" href="gdbus-org.freedesktop.ModemManager1.Bearer.html" title="org.freedesktop.ModemManager1.Bearer"> <link rel="next" href="gdbus-org.freedesktop.ModemManager1.Sim.html" title="org.freedesktop.ModemManager1.Sim"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> diff --git a/docs/reference/api/html/ref-dbus-object-sms.html b/docs/reference/api/html/ref-dbus-object-sms.html index 20fc14d..fc1b96c 100644 --- a/docs/reference/api/html/ref-dbus-object-sms.html +++ b/docs/reference/api/html/ref-dbus-object-sms.html @@ -5,7 +5,7 @@ <title>The /org/freedesktop/ModemManager/SMSs objects</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="ModemManager Reference Manual"> -<link rel="up" href="ref-dbus.html" title="Part II. D-Bus Reference"> +<link rel="up" href="ref-dbus.html" title="Part III. D-Bus Reference"> <link rel="prev" href="gdbus-org.freedesktop.ModemManager1.Sim.html" title="org.freedesktop.ModemManager1.Sim"> <link rel="next" href="gdbus-org.freedesktop.ModemManager1.Sms.html" title="org.freedesktop.ModemManager1.Sms"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> diff --git a/docs/reference/api/html/ref-dbus-standard-interfaces-objectmanager.html b/docs/reference/api/html/ref-dbus-standard-interfaces-objectmanager.html index 2f2e358..6a2ad5c 100644 --- a/docs/reference/api/html/ref-dbus-standard-interfaces-objectmanager.html +++ b/docs/reference/api/html/ref-dbus-standard-interfaces-objectmanager.html @@ -7,7 +7,7 @@ <link rel="home" href="index.html" title="ModemManager Reference Manual"> <link rel="up" href="ref-dbus-standard-interfaces.html" title="Standard interfaces"> <link rel="prev" href="ref-dbus-standard-interfaces-introspectables.html" title="org.freedesktop.DBus.Introspectable"> -<link rel="next" href="ref-dbus-common-types.html" title="Common types"> +<link rel="next" href="ref-dbus-object-manager.html" title="The /org/freedesktop/ModemManager1 object"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> @@ -17,7 +17,7 @@ <td><a accesskey="u" href="ref-dbus-standard-interfaces.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">ModemManager Reference Manual</th> -<td><a accesskey="n" href="ref-dbus-common-types.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<td><a accesskey="n" href="ref-dbus-object-manager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr></table> <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> diff --git a/docs/reference/api/html/ref-dbus-standard-interfaces.html b/docs/reference/api/html/ref-dbus-standard-interfaces.html index 3186093..e860bf0 100644 --- a/docs/reference/api/html/ref-dbus-standard-interfaces.html +++ b/docs/reference/api/html/ref-dbus-standard-interfaces.html @@ -5,7 +5,7 @@ <title>Standard interfaces</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="ModemManager Reference Manual"> -<link rel="up" href="ref-dbus.html" title="Part II. D-Bus Reference"> +<link rel="up" href="ref-dbus.html" title="Part III. D-Bus Reference"> <link rel="prev" href="ref-dbus-bus-name.html" title="The org.freedesktop.ModemManager1 bus name"> <link rel="next" href="ref-dbus-standard-interfaces-introspectables.html" title="org.freedesktop.DBus.Introspectable"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> diff --git a/docs/reference/api/html/ref-dbus.html b/docs/reference/api/html/ref-dbus.html index 24ebe7e..530c078 100644 --- a/docs/reference/api/html/ref-dbus.html +++ b/docs/reference/api/html/ref-dbus.html @@ -2,18 +2,18 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Part II. D-Bus Reference</title> +<title>Part III. D-Bus Reference</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="ModemManager Reference Manual"> <link rel="up" href="index.html" title="ModemManager Reference Manual"> -<link rel="prev" href="ref-overview-plugin-specific-modems.html" title="Plugin-specific Modems"> +<link rel="prev" href="ModemManager-Errors.html" title="Errors"> <link rel="next" href="ref-dbus-bus-name.html" title="The org.freedesktop.ModemManager1 bus name"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> -<td><a accesskey="p" href="ref-overview-plugin-specific-modems.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="p" href="ModemManager-Errors.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> <td> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">ModemManager Reference Manual</th> @@ -21,7 +21,7 @@ </tr></table> <div class="part"> <div class="titlepage"><div><div><h1 class="title"> -<a name="ref-dbus"></a>Part II. D-Bus Reference</h1></div></div></div> +<a name="ref-dbus"></a>Part III. D-Bus Reference</h1></div></div></div> <div class="toc"> <p><b>Table of Contents</b></p> <dl class="toc"> @@ -32,15 +32,6 @@ <dt><span class="section"><a href="ref-dbus-standard-interfaces-introspectables.html">org.freedesktop.DBus.Introspectable</a></span></dt> <dt><span class="section"><a href="ref-dbus-standard-interfaces-objectmanager.html">org.freedesktop.DBus.ObjectManager</a></span></dt> </dl></dd> -<dt><span class="chapter"><a href="ref-dbus-common-types.html">Common types</a></span></dt> -<dd><dl> -<dt> -<span class="refentrytitle"><a href="ModemManager-Flags-and-Enumerations.html">Flags and Enumerations</a></span><span class="refpurpose"> — Common enumerations and types in the API.</span> -</dt> -<dt> -<span class="refentrytitle"><a href="ModemManager-Errors.html">Errors</a></span><span class="refpurpose"> — Common errors in the API.</span> -</dt> -</dl></dd> <dt><span class="chapter"><a href="ref-dbus-object-manager.html">The <code class="literal">/org/freedesktop/ModemManager1</code> object</a></span></dt> <dd><dl><dt> <span class="refentrytitle"><a href="gdbus-org.freedesktop.ModemManager1.html">org.freedesktop.ModemManager1</a></span><span class="refpurpose"> — The ModemManager Manager interface.</span> @@ -74,9 +65,6 @@ <dt> <span class="refentrytitle"><a href="gdbus-org.freedesktop.ModemManager1.Modem.Firmware.html">org.freedesktop.ModemManager1.Modem.Firmware</a></span><span class="refpurpose"> — The ModemManager Firmware interface.</span> </dt> -<dt> -<span class="refentrytitle"><a href="gdbus-org.freedesktop.ModemManager1.Modem.Contacts.html">org.freedesktop.ModemManager1.Modem.Contacts</a></span><span class="refpurpose"> — The ModemManager Contacts interface.</span> -</dt> </dl></dd> <dt><span class="chapter"><a href="ref-dbus-object-bearer.html">The <code class="literal">/org/freedesktop/ModemManager/Bearers</code> objects</a></span></dt> <dd><dl><dt> diff --git a/docs/reference/api/html/ref-migrating.html b/docs/reference/api/html/ref-migrating.html new file mode 100644 index 0000000..23ea8a1 --- /dev/null +++ b/docs/reference/api/html/ref-migrating.html @@ -0,0 +1,55 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Part IV. Migrating from ModemManager 0.6 to ModemManager 1.0</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="ModemManager Reference Manual"> +<link rel="up" href="index.html" title="ModemManager Reference Manual"> +<link rel="prev" href="gdbus-org.freedesktop.ModemManager1.Sms.html" title="org.freedesktop.ModemManager1.Sms"> +<link rel="next" href="ch12.html" title=""> +<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gdbus-org.freedesktop.ModemManager1.Sms.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">ModemManager Reference Manual</th> +<td><a accesskey="n" href="ch12.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="part"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="ref-migrating"></a>Part IV. Migrating from ModemManager 0.6 to ModemManager 1.0</h1></div></div></div> +<div class="partintro"> +<div></div> +<p> + ModemManager 1.0 is a new major version of ModemManager that breaks both + API and ABI compared to previous versions. These changes allow better + managing new types of devices (e.g. those with multiple capabilities), + or those not based in AT commands for operation (e.g. QMI or MBIM modems). + </p> +<p> + This section provides an introduction to the changes done in the DBus interface + with respect to the main operations performed with modems through ModemManager. + </p> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl class="toc"> +<dt><span class="chapter"><a href="ch12.html"></a></span></dt> +<dd><dl> +<dt><span class="section"><a href="ch12.html#idm211850989168">Listing available modems</a></span></dt> +<dt><span class="section"><a href="ch12s02.html">PIN unlocking</a></span></dt> +<dt><span class="section"><a href="ch12s03.html">Connection and disconnection</a></span></dt> +<dt><span class="section"><a href="ch12s04.html">Simple connection</a></span></dt> +</dl></dd> +</dl> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18.1</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/api/html/ref-overview-introduction.html b/docs/reference/api/html/ref-overview-introduction.html index 540168b..8fbd86a 100644 --- a/docs/reference/api/html/ref-overview-introduction.html +++ b/docs/reference/api/html/ref-overview-introduction.html @@ -23,33 +23,37 @@ <div class="titlepage"><div><div><h2 class="title"> <a name="ref-overview-introduction"></a>Introduction</h2></div></div></div> <p> - ModemManager provides a unified high level API for communicating with - (mobile broadband) modems. While the basic commands are standardized, - the more advanced operations (like signal quality monitoring while - connected) varies a lot. + ModemManager provides a unified high level API for communicating with mobile + broadband modems, regardless of the protocol used to communicate with the + actual device (Generic AT, vendor-specific AT, QCDM, QMI, MBIM...). </p> <p><b>Using. </b> ModemManager is a system daemon and is not meant to be used directly from - the command line. However, a command line client (mmcli) is provided, which - may be used to test the different functionality provided during plugin - development. + the command line. However, since it provides a DBus API, it is possible to use + 'dbus-send' commands or the new 'mmcli' command line interface to control it + from the terminal. The devices are queried from udev and automatically updated + based on hardware events, although a manual re-scan can also be requested to + look for RS232 modems. </p> <p><b>Implementation. </b> ModemManager is a DBus system bus activated service (meaning it's started - automatically when a request arrives). It is written in C. The devices are - queried from udev and automatically updated based on hardware events. There are - DBus-interface specific GInterfaces, which should be implemented by any device - specific implementation. There is a generic MMBroadbandModem implementation that - provides a generic implementation of the most common operations in both GSM and - CDMA modems. + automatically when a request arrives). It is written in C, using glib and gio. + Several GInterfaces specify different features that the modems support, + including the generic MMIfaceModem3gpp and MMIfaceModemCdma which provice basic + operations for 3GPP (GSM, UMTS, LTE) or CDMA (CDMA1x, EV-DO) modems. If a given + feature is not available in the modem, the specific interface will not be + exported in DBus. </p> <p><b>Plugins. </b> Plugins are loaded on startup, and must implement the MMPlugin interface. It consists of a couple of methods which tell the daemon whether the plugin - supports a port and to create custom modem implementations. It most likely - makes sense to derive custom modem implementations from one of the generic - classes and just add (or override) operations which are not standard. Writing - new plugins is highly encouraged! + supports a port and to create custom MMBroadbandModem implementations. It most + likely makes sense to derive custom modem implementations from one of the + generic classes and just add (or override) operations which are not standard. + There are multiple fully working plugins in the plugins/ directory that can be + used as an example for writing new plugins. Writing new plugins is highly + encouraged! The plugin API is open for changes, so if you're writing a plugin + and need to add or change some public method, feel free to suggest it! </p> </div> <div class="footer"> diff --git a/docs/reference/api/html/ref-overview-modem-detection-and-setup.html b/docs/reference/api/html/ref-overview-modem-detection-and-setup.html index f683956..a8a1dd9 100644 --- a/docs/reference/api/html/ref-overview-modem-detection-and-setup.html +++ b/docs/reference/api/html/ref-overview-modem-detection-and-setup.html @@ -23,19 +23,19 @@ <div class="titlepage"><div><div><h2 class="title"> <a name="ref-overview-modem-detection-and-setup"></a>Modem detection and setup</h2></div></div></div> <div class="toc"><dl class="toc"> -<dt><span class="section"><a href="ref-overview-modem-detection-and-setup.html#idm266935804880">Detection mechanisms</a></span></dt> +<dt><span class="section"><a href="ref-overview-modem-detection-and-setup.html#idm211863910672">Detection mechanisms</a></span></dt> <dt><span class="section"><a href="ch02s02.html">Probing</a></span></dt> <dd><dl> -<dt><span class="section"><a href="ch02s02.html#idm266943579776">Pre-probing filters</a></span></dt> -<dt><span class="section"><a href="ch02s02.html#idm266934295312">Probing sequence</a></span></dt> -<dt><span class="section"><a href="ch02s02.html#idm266943548864">Post-probing filters</a></span></dt> -<dt><span class="section"><a href="ch02s02.html#idm266936589872">Probing setup examples</a></span></dt> +<dt><span class="section"><a href="ch02s02.html#idm211863905456">Pre-probing filters</a></span></dt> +<dt><span class="section"><a href="ch02s02.html#idm211854553632">Probing sequence</a></span></dt> +<dt><span class="section"><a href="ch02s02.html#idm211864004288">Post-probing filters</a></span></dt> +<dt><span class="section"><a href="ch02s02.html#idm211856775152">Probing setup examples</a></span></dt> </dl></dd> <dt><span class="section"><a href="ch02s03.html">Port grabbing and Modem object creation</a></span></dt> </dl></div> <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="idm266935804880"></a>Detection mechanisms</h2></div></div></div> +<a name="idm211863910672"></a>Detection mechanisms</h2></div></div></div> <p> ModemManager requires <span class="emphasis"><em>udev</em></span>-powered Linux kernels in order to get notified of possible available Modems. udev will report each of the ports diff --git a/docs/reference/api/html/ref-overview-modem-state-machine.html b/docs/reference/api/html/ref-overview-modem-state-machine.html index 8695ea7..10e87a1 100644 --- a/docs/reference/api/html/ref-overview-modem-state-machine.html +++ b/docs/reference/api/html/ref-overview-modem-state-machine.html @@ -23,7 +23,7 @@ <div class="titlepage"><div><div><h2 class="title"> <a name="ref-overview-modem-state-machine"></a>Modem state machine</h2></div></div></div> <div class="toc"><dl class="toc"> -<dt><span class="section"><a href="ref-overview-modem-state-machine.html#idm266936574096">Initialization</a></span></dt> +<dt><span class="section"><a href="ref-overview-modem-state-machine.html#idm211856759264">Initialization</a></span></dt> <dt><span class="section"><a href="ch03s02.html">Enabling</a></span></dt> <dt><span class="section"><a href="ch03s03.html">Connection & disconnection</a></span></dt> <dt><span class="section"><a href="ch03s04.html">Disabling</a></span></dt> @@ -43,7 +43,7 @@ </p> <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="idm266936574096"></a>Initialization</h2></div></div></div> +<a name="idm211856759264"></a>Initialization</h2></div></div></div> <p> The modem initialization sequence starts only when all ports have been probed and grabbed by a given plugin. This is done so that the proper diff --git a/docs/reference/api/html/ref-overview-plugin-specific-modems.html b/docs/reference/api/html/ref-overview-plugin-specific-modems.html index d86d8be..b1bba5f 100644 --- a/docs/reference/api/html/ref-overview-plugin-specific-modems.html +++ b/docs/reference/api/html/ref-overview-plugin-specific-modems.html @@ -7,7 +7,7 @@ <link rel="home" href="index.html" title="ModemManager Reference Manual"> <link rel="up" href="ref-overview.html" title="Part I. ModemManager Overview"> <link rel="prev" href="ch03s04.html" title="Disabling"> -<link rel="next" href="ref-dbus.html" title="Part II. D-Bus Reference"> +<link rel="next" href="ref-common-types.html" title="Part II. Common types and definitions"> <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> @@ -17,7 +17,7 @@ <td><a accesskey="u" href="ref-overview.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">ModemManager Reference Manual</th> -<td><a accesskey="n" href="ref-dbus.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<td><a accesskey="n" href="ref-common-types.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr></table> <div class="chapter"> <div class="titlepage"><div><div><h2 class="title"> diff --git a/docs/reference/api/html/ref-overview.html b/docs/reference/api/html/ref-overview.html index ccf8fb5..aaa56be 100644 --- a/docs/reference/api/html/ref-overview.html +++ b/docs/reference/api/html/ref-overview.html @@ -28,19 +28,19 @@ <dt><span class="chapter"><a href="ref-overview-introduction.html">Introduction</a></span></dt> <dt><span class="chapter"><a href="ref-overview-modem-detection-and-setup.html">Modem detection and setup</a></span></dt> <dd><dl> -<dt><span class="section"><a href="ref-overview-modem-detection-and-setup.html#idm266935804880">Detection mechanisms</a></span></dt> +<dt><span class="section"><a href="ref-overview-modem-detection-and-setup.html#idm211863910672">Detection mechanisms</a></span></dt> <dt><span class="section"><a href="ch02s02.html">Probing</a></span></dt> <dd><dl> -<dt><span class="section"><a href="ch02s02.html#idm266943579776">Pre-probing filters</a></span></dt> -<dt><span class="section"><a href="ch02s02.html#idm266934295312">Probing sequence</a></span></dt> -<dt><span class="section"><a href="ch02s02.html#idm266943548864">Post-probing filters</a></span></dt> -<dt><span class="section"><a href="ch02s02.html#idm266936589872">Probing setup examples</a></span></dt> +<dt><span class="section"><a href="ch02s02.html#idm211863905456">Pre-probing filters</a></span></dt> +<dt><span class="section"><a href="ch02s02.html#idm211854553632">Probing sequence</a></span></dt> +<dt><span class="section"><a href="ch02s02.html#idm211864004288">Post-probing filters</a></span></dt> +<dt><span class="section"><a href="ch02s02.html#idm211856775152">Probing setup examples</a></span></dt> </dl></dd> <dt><span class="section"><a href="ch02s03.html">Port grabbing and Modem object creation</a></span></dt> </dl></dd> <dt><span class="chapter"><a href="ref-overview-modem-state-machine.html">Modem state machine</a></span></dt> <dd><dl> -<dt><span class="section"><a href="ref-overview-modem-state-machine.html#idm266936574096">Initialization</a></span></dt> +<dt><span class="section"><a href="ref-overview-modem-state-machine.html#idm211856759264">Initialization</a></span></dt> <dt><span class="section"><a href="ch03s02.html">Enabling</a></span></dt> <dt><span class="section"><a href="ch03s03.html">Connection & disconnection</a></span></dt> <dt><span class="section"><a href="ch03s04.html">Disabling</a></span></dt> diff --git a/docs/reference/api/tmpl/mm-enums.sgml b/docs/reference/api/tmpl/mm-enums.sgml index e179e4d..8cbe3b1 100644 --- a/docs/reference/api/tmpl/mm-enums.sgml +++ b/docs/reference/api/tmpl/mm-enums.sgml @@ -363,6 +363,19 @@ Flags and Enumerations @MM_MODEM_POWER_STATE_LOW: @MM_MODEM_POWER_STATE_ON: +<!-- ##### ENUM MMModemPortType ##### --> +<para> + +</para> + +@MM_MODEM_PORT_TYPE_UNKNOWN: +@MM_MODEM_PORT_TYPE_NET: +@MM_MODEM_PORT_TYPE_AT: +@MM_MODEM_PORT_TYPE_QCDM: +@MM_MODEM_PORT_TYPE_GPS: +@MM_MODEM_PORT_TYPE_QMI: +@MM_MODEM_PORT_TYPE_MBIM: + <!-- ##### ENUM MMSmsPduType ##### --> <para> diff --git a/docs/reference/api/tmpl/mm-version.sgml b/docs/reference/api/tmpl/mm-version.sgml new file mode 100644 index 0000000..3a8ca45 --- /dev/null +++ b/docs/reference/api/tmpl/mm-version.sgml @@ -0,0 +1,55 @@ +<!-- ##### SECTION Title ##### --> +Version checks + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO MM_MAJOR_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO MM_MINOR_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO MM_MICRO_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO MM_CHECK_VERSION ##### --> +<para> + +</para> + +@major: +@minor: +@micro: + + |