diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingGsm.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingGsm.html | 98 |
1 files changed, 44 insertions, 54 deletions
diff --git a/docs/libnm-util/html/NMSettingGsm.html b/docs/libnm-util/html/NMSettingGsm.html index 39aa12d1f..1e725b028 100644 --- a/docs/libnm-util/html/NMSettingGsm.html +++ b/docs/libnm-util/html/NMSettingGsm.html @@ -2,13 +2,13 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm-util Reference Manual: NMSettingGsm</title> +<title>NMSettingGsm: libnm-util Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm-util Reference Manual"> <link rel="up" href="ch01.html" title="libnm-util API Reference"> <link rel="prev" href="NMSettingCdma.html" title="NMSettingCdma"> <link rel="next" href="NMSettingWimax.html" title="NMSettingWimax"> -<meta name="generator" content="GTK-Doc V1.21 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -326,7 +326,6 @@ nm_setting_gsm_error_quark (<em class="parameter"><code><span class="type">void< <div class="refsect3"> <a name="id-1.2.11.9.2.5"></a><h4>Returns</h4> <p> the error quark used for <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> errors.</p> -<p></p> </div> </div> <hr> @@ -349,7 +348,6 @@ nm_setting_gsm_new (<em class="parameter"><code><span class="type">void</span></ <div class="refsect3"> <a name="id-1.2.11.9.4.5"></a><h4>Returns</h4> <p> the new empty <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> object</p> -<p></p> </div> </div> <hr> @@ -375,7 +373,6 @@ nm_setting_gsm_get_number (<em class="parameter"><code><a class="link" href="NMS <div class="refsect3"> <a name="id-1.2.11.9.5.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--number" title="The “number” property"><span class="type">“number”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -401,7 +398,6 @@ nm_setting_gsm_get_username (<em class="parameter"><code><a class="link" href="N <div class="refsect3"> <a name="id-1.2.11.9.6.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--username" title="The “username” property"><span class="type">“username”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -427,7 +423,6 @@ nm_setting_gsm_get_password (<em class="parameter"><code><a class="link" href="N <div class="refsect3"> <a name="id-1.2.11.9.7.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--password" title="The “password” property"><span class="type">“password”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -453,7 +448,6 @@ nm_setting_gsm_get_apn (<em class="parameter"><code><a class="link" href="NMSett <div class="refsect3"> <a name="id-1.2.11.9.8.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--apn" title="The “apn” property"><span class="type">“apn”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -479,7 +473,6 @@ nm_setting_gsm_get_network_id (<em class="parameter"><code><a class="link" href= <div class="refsect3"> <a name="id-1.2.11.9.9.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--network-id" title="The “network-id” property"><span class="type">“network-id”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -505,7 +498,6 @@ nm_setting_gsm_get_pin (<em class="parameter"><code><a class="link" href="NMSett <div class="refsect3"> <a name="id-1.2.11.9.10.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--pin" title="The “pin” property"><span class="type">“pin”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -531,7 +523,6 @@ nm_setting_gsm_get_home_only (<em class="parameter"><code><a class="link" href=" <div class="refsect3"> <a name="id-1.2.11.9.11.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--home-only" title="The “home-only” property"><span class="type">“home-only”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -557,7 +548,6 @@ nm_setting_gsm_get_pin_flags (<em class="parameter"><code><a class="link" href=" <div class="refsect3"> <a name="id-1.2.11.9.12.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> pertaining to the <a class="link" href="NMSettingGsm.html#NMSettingGsm--pin" title="The “pin” property"><span class="type">“pin”</span></a></p> -<p></p> </div> </div> <hr> @@ -583,7 +573,6 @@ nm_setting_gsm_get_password_flags (<em class="parameter"><code><a class="link" h <div class="refsect3"> <a name="id-1.2.11.9.13.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> pertaining to the <a class="link" href="NMSettingGsm.html#NMSettingGsm--password" title="The “password” property"><span class="type">“password”</span></a></p> -<p></p> </div> </div> <hr> @@ -613,7 +602,6 @@ nm_setting_gsm_get_network_type (<em class="parameter"><code><a class="link" hre <div class="refsect3"> <a name="id-1.2.11.9.14.6"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--network-type" title="The “network-type” property"><span class="type">“network-type”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -643,7 +631,6 @@ nm_setting_gsm_get_allowed_bands (<em class="parameter"><code><a class="link" hr <div class="refsect3"> <a name="id-1.2.11.9.15.6"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--allowed-bands" title="The “allowed-bands” property"><span class="type">“allowed-bands”</span></a> property of the setting</p> -<p></p> </div> </div> </div> @@ -653,8 +640,6 @@ nm_setting_gsm_get_allowed_bands (<em class="parameter"><code><a class="link" hr <a name="NM-SETTING-GSM-SETTING-NAME:CAPS"></a><h3>NM_SETTING_GSM_SETTING_NAME</h3> <pre class="programlisting">#define NM_SETTING_GSM_SETTING_NAME "gsm" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> @@ -707,96 +692,72 @@ is missing in the connection</p> <a name="NM-SETTING-GSM-ERROR:CAPS"></a><h3>NM_SETTING_GSM_ERROR</h3> <pre class="programlisting">#define NM_SETTING_GSM_ERROR nm_setting_gsm_error_quark () </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-GSM-NUMBER:CAPS"></a><h3>NM_SETTING_GSM_NUMBER</h3> <pre class="programlisting">#define NM_SETTING_GSM_NUMBER "number" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-GSM-USERNAME:CAPS"></a><h3>NM_SETTING_GSM_USERNAME</h3> <pre class="programlisting">#define NM_SETTING_GSM_USERNAME "username" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-GSM-PASSWORD:CAPS"></a><h3>NM_SETTING_GSM_PASSWORD</h3> <pre class="programlisting">#define NM_SETTING_GSM_PASSWORD "password" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-GSM-PASSWORD-FLAGS:CAPS"></a><h3>NM_SETTING_GSM_PASSWORD_FLAGS</h3> <pre class="programlisting">#define NM_SETTING_GSM_PASSWORD_FLAGS "password-flags" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-GSM-APN:CAPS"></a><h3>NM_SETTING_GSM_APN</h3> <pre class="programlisting">#define NM_SETTING_GSM_APN "apn" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-GSM-NETWORK-ID:CAPS"></a><h3>NM_SETTING_GSM_NETWORK_ID</h3> <pre class="programlisting">#define NM_SETTING_GSM_NETWORK_ID "network-id" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-GSM-PIN:CAPS"></a><h3>NM_SETTING_GSM_PIN</h3> <pre class="programlisting">#define NM_SETTING_GSM_PIN "pin" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-GSM-PIN-FLAGS:CAPS"></a><h3>NM_SETTING_GSM_PIN_FLAGS</h3> <pre class="programlisting">#define NM_SETTING_GSM_PIN_FLAGS "pin-flags" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-GSM-HOME-ONLY:CAPS"></a><h3>NM_SETTING_GSM_HOME_ONLY</h3> <pre class="programlisting">#define NM_SETTING_GSM_HOME_ONLY "home-only" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-GSM-ALLOWED-BANDS:CAPS"></a><h3>NM_SETTING_GSM_ALLOWED_BANDS</h3> <pre class="programlisting">#define NM_SETTING_GSM_ALLOWED_BANDS "allowed-bands" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-GSM-NETWORK-TYPE:CAPS"></a><h3>NM_SETTING_GSM_NETWORK_TYPE</h3> <pre class="programlisting">#define NM_SETTING_GSM_NETWORK_TYPE "network-type" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> @@ -1008,7 +969,9 @@ the device may use when connecting to this network.</p> <div class="refsect2"> <a name="NMSettingGsm--allowed-bands"></a><h3>The <code class="literal">“allowed-bands”</code> property</h3> <pre class="programlisting"> “allowed-bands” <span class="type">guint</span></pre> -<p></p> +<p>Bitfield of allowed frequency bands. Note that not all devices allow +frequency band control. Permitted values are those specified by +<a class="link" href="NMSettingGsm.html#NMSettingGsmNetworkBand" title="enum NMSettingGsmNetworkBand"><span class="type">NMSettingGsmNetworkBand</span></a>.</p> <div class="warning"> <p><code class="literal">NMSettingGsm:allowed-bands</code> has been deprecated since version 0.9.10 and should not be used in newly-written code.</p> <p>No longer used. Band setting should be done by @@ -1022,7 +985,13 @@ talking to ModemManager directly.</p> <div class="refsect2"> <a name="NMSettingGsm--apn"></a><h3>The <code class="literal">“apn”</code> property</h3> <pre class="programlisting"> “apn” <span class="type">gchar</span> *</pre> -<p></p> +<p>The GPRS Access Point Name specifying the APN used when establishing a +data session with the GSM-based network. The APN often determines how +the user will be billed for their network usage and whether the user has +access to the Internet or just a provider-specific walled-garden, so it +is important to use the correct APN for the user's mobile broadband plan. +The APN may only be composed of the characters a-z, 0-9, ., and - per GSM +03.60 Section 14.9.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1030,7 +999,8 @@ talking to ModemManager directly.</p> <div class="refsect2"> <a name="NMSettingGsm--home-only"></a><h3>The <code class="literal">“home-only”</code> property</h3> <pre class="programlisting"> “home-only” <span class="type">gboolean</span></pre> -<p></p> +<p>When <code class="literal">TRUE</code>, only connections to the home network will be allowed. +Connections to roaming networks will not be made.</p> <p>Flags: Read / Write</p> <p>Default value: FALSE</p> </div> @@ -1038,7 +1008,11 @@ talking to ModemManager directly.</p> <div class="refsect2"> <a name="NMSettingGsm--network-id"></a><h3>The <code class="literal">“network-id”</code> property</h3> <pre class="programlisting"> “network-id” <span class="type">gchar</span> *</pre> -<p></p> +<p>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network +registration. If the Network ID is specified, NetworkManager will +attempt to force the device to register only on the specified network. +This can be used to ensure that the device does not roam when direct +roaming control of the device is not otherwise possible.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1046,7 +1020,15 @@ talking to ModemManager directly.</p> <div class="refsect2"> <a name="NMSettingGsm--network-type"></a><h3>The <code class="literal">“network-type”</code> property</h3> <pre class="programlisting"> “network-type” <span class="type">gint</span></pre> -<p></p> +<p>Network preference to force the device to only use specific network +technologies. The permitted values are <a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-NETWORK-TYPE-ANY:CAPS"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_ANY</code></a>, +<a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-NETWORK-TYPE-UMTS-HSPA:CAPS"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA</code></a>, +<a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-NETWORK-TYPE-GPRS-EDGE:CAPS"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE</code></a>, +<a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-NETWORK-TYPE-PREFER-UMTS-HSPA:CAPS"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA</code></a>, +<a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-NETWORK-TYPE-PREFER-GPRS-EDGE:CAPS"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE</code></a>, +<a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-NETWORK-TYPE-PREFER-4G:CAPS"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G</code></a>, and +<a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-NETWORK-TYPE-4G:CAPS"><code class="literal">NM_SETTING_GSM_NETWORK_TYPE_4G</code></a>. Note that not all devices allow network +preference control.</p> <div class="warning"> <p><code class="literal">NMSettingGsm:network-type</code> has been deprecated since version 0.9.10 and should not be used in newly-written code.</p> <p>No longer used. Network type setting should be done @@ -1060,7 +1042,10 @@ by talking to ModemManager directly.</p> <div class="refsect2"> <a name="NMSettingGsm--number"></a><h3>The <code class="literal">“number”</code> property</h3> <pre class="programlisting"> “number” <span class="type">gchar</span> *</pre> -<p></p> +<p>Number to dial when establishing a PPP data session with the GSM-based +mobile broadband network. Many modems do not require PPP for connections +to the mobile network and thus this property should be left blank, which +allows NetworkManager to select the appropriate settings automatically.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1068,7 +1053,9 @@ by talking to ModemManager directly.</p> <div class="refsect2"> <a name="NMSettingGsm--password"></a><h3>The <code class="literal">“password”</code> property</h3> <pre class="programlisting"> “password” <span class="type">gchar</span> *</pre> -<p></p> +<p>The password used to authenticate with the network, if required. Many +providers do not require a password, or accept any password. But if a +password is required, it is specified here.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1076,7 +1063,7 @@ by talking to ModemManager directly.</p> <div class="refsect2"> <a name="NMSettingGsm--password-flags"></a><h3>The <code class="literal">“password-flags”</code> property</h3> <pre class="programlisting"> “password-flags” <span class="type">guint</span></pre> -<p></p> +<p>Flags indicating how to handle the <a class="link" href="NMSettingGsm.html#NMSettingGsm--password" title="The “password” property"><span class="type">“password”</span></a> property.</p> <p>Flags: Read / Write</p> <p>Allowed values: <= 7</p> <p>Default value: 0</p> @@ -1085,7 +1072,9 @@ by talking to ModemManager directly.</p> <div class="refsect2"> <a name="NMSettingGsm--pin"></a><h3>The <code class="literal">“pin”</code> property</h3> <pre class="programlisting"> “pin” <span class="type">gchar</span> *</pre> -<p></p> +<p>If the SIM is locked with a PIN it must be unlocked before any other +operations are requested. Specify the PIN here to allow operation of the +device.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1093,7 +1082,7 @@ by talking to ModemManager directly.</p> <div class="refsect2"> <a name="NMSettingGsm--pin-flags"></a><h3>The <code class="literal">“pin-flags”</code> property</h3> <pre class="programlisting"> “pin-flags” <span class="type">guint</span></pre> -<p></p> +<p>Flags indicating how to handle the <a class="link" href="NMSettingGsm.html#NMSettingGsm--pin" title="The “pin” property"><span class="type">“pin”</span></a> property.</p> <p>Flags: Read / Write</p> <p>Allowed values: <= 7</p> <p>Default value: 0</p> @@ -1102,14 +1091,15 @@ by talking to ModemManager directly.</p> <div class="refsect2"> <a name="NMSettingGsm--username"></a><h3>The <code class="literal">“username”</code> property</h3> <pre class="programlisting"> “username” <span class="type">gchar</span> *</pre> -<p></p> +<p>The username used to authenticate with the network, if required. Many +providers do not require a username, or accept any username. But if a +username is required, it is specified here.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.21</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file |