api,bearer: specify how 'allow-roaming' works

This is never part of profile settings, it's a volatile configuration
applicable to the connection attempt ongoing with the given bearer
settings.
This commit is contained in:
Aleksander Morgado
2021-11-04 21:29:52 +01:00
parent 1010c3be4e
commit 52538defe1

View File

@@ -542,8 +542,12 @@
<varlistentry><term><literal>"allow-roaming"</literal></term>
<listitem>
Specifies whether the connections are allowed even when the device
is registered in a roaming network, given as a boolean value (signature
<literal>"b"</literal>).
is registered in a roaming (partner or non-partner) network, given as
a boolean value (signature <literal>"b"</literal>). This setting
applies only to the connection attempts started via
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Simple.Connect">Simple.Connect()</link>
or <link linkend="gdbus-method-org-freedesktop-ModemManager1-Bearer.Connect">Bearer.Connect()</link>.
This is a volatile setting, never stored in the device.
</listitem>
</varlistentry>
<varlistentry><term><literal>"multiplex"</literal></term>