new/org.freedesktop.ModemManager1.Modem.Simple.xml

<?xml version="1.0" encoding="UTF-8" ?>

<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <interface name="org.freedesktop.ModemManager1.Modem.Simple">

    <!-- METHODS -->

    <method name="Connect">
      <tp:docstring>
	Do everything needed to connect the modem using the given properties.
	This method will attempt to find a matching packet data bearer and
	activate it if necessary, returning the bearer's IP details.  If no
	matching bearer is found, a new bearer will be created and activated,
	but this operation may fail if no resources are available to complete
	this connection attempt (ie, if a conflicting bearer is already active).
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_simple_connect"/>
      <arg name="properties" type="a{sv}" direction="in">
	<tp:docstring>
	  Dictionary of properties needed to get the modem connected.  This
	  call may make a large number of changes to modem configuration based
	  on properties passed in.  For example, given a PIN-locked, disabled
	  GSM/UMTS modem, this call may unlock the SIM PIN, alter the access
	  technology preference, wait for network registration (or force
	  registration to a specific provider), create a new packet data bearer
	  using the given 'apn', and connect that bearer.

	  'pin'          : (string) SIM-PIN unlock code
	  'network-id'   : (string) ETSI MCC-MNC of a network to force registration with
	  'band'         : (uint)   Bitfield of radio bands the modem may use
	  'allowed-mode' : (uint)   Allowed network technology preference (ie, 2G/3G, etc)
	  'apn'          : (string) For GSM/UMTS and LTE devices the APN to use
	  'ip-type'      : (string) For GSM/UMTS and LTE devices the IP addressing
	                              type to use, one of "IPV4", "IPV4V6", or "IPV6"
	  'number'       : (string) For POTS devices, the number to dial
	  'home_only'    : (uint)   1 to allow only connections to home networks
	</tp:docstring>
      </arg>
      <arg name="bearer" type="o" direction="out">
        <tp:docstring>
          On successful connect, returns the object path of the connected
          packet data bearer used for the connection attempt.
        </tp:docstring>
      </arg>
      <arg name="interface" type="s" direction="out">
        <tp:docstring>
          The operating system name for the network data interface that provides
          packet data using this bearer.  Connection managers must configure this
          interface using the given IP configuration returned by bearer activation.
        </tp:docstring>
      </arg>
      <arg name="ip4config" type="a{sv}" direction="out">
        <tp:docstring>
          If the bearer was configured for IPv4 addressing, upon successful
          connect this argument contains the addressing details for assignment
          to the data interface.  If the bearer specifies configuration via PPP
          or DHCP, only the 'method' item will be present.  See the description
          of the property of this name in the
          org.freedesktop.ModemManager1.Modem.Bearer interface.
        </tp:docstring>
      </arg>
      <arg name="ip6config" type="a{sv}" direction="out">
        <tp:docstring>
          If the bearer was configured for IPv6 addressing, upon successful
          connect this argument contains the addressing details for assignment
          to the data interface.  If the bearer specifies configuration via PPP
          or DHCP, only the 'method' item will be present.  See the description
          of the property of this name in the
          org.freedesktop.ModemManager1.Modem.Bearer interface.
        </tp:docstring>
      </arg>
    </method>

    <method name="Disconnect">
      <tp:docstring>
	Disconnect an active packet data connection.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_simple_disconnect"/>
      <arg name="bearer" type="o" direction="in">
        <tp:docstring>
          If given this method will disconnect the referenced packet data bearer,
          while if "/" (ie, no object given) this method will disconnect all
          active packet data bearers.
        </tp:docstring>
      </arg>
    </method>

    <method name="GetStatus">
      <!-- FIXME: either convert this to properties (which duplicate properties
           of the base modem object already) or expand the returned property
           list to include "registration" and add a StatusChanged signal so
           clients can monitor changes without having to poll.
        -->
      <tp:docstring>
	Get the modem status.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_simple_get_status"/>
      <arg name="properties" type="a{sv}" direction="out">
	<tp:docstring>
	  Dictionary of properties. The predefined common properties are:

	  'state'             : (uint, always) Modem state
	  'signal-quality'    : (uint, state >= registered)
	  'operator-code'     : (string, state >= registered) Operator MCC-MNC
	  'operator-name'     : (string, state >= registered)
	  'band'              : (uint, state >= registered)
	  'access-technology' : (uint, state >= registered) See MM_MODEM_ACCESS_TECH
	</tp:docstring>
      </arg>
    </method>

  </interface>
</node>