dbus/introspection/org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.xml

0001 <?xml version="1.0" encoding="UTF-8" ?>
0002
0003 <!--
0004  ModemManager 1.0 Interface Specification
0005
0006    Copyright (C) 2008 Novell, Inc.
0007    Copyright (C) 2008-2013 Red Hat, Inc.
0008    Copyright (C) 2011-2013 Google, Inc.
0009    Copyright (C) 2011-2013 Lanedo GmbH
0010 -->
0011
0012 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
0013
0014   <!--
0015       org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd:
0016       @short_description: The ModemManager 3GPP USSD interface.
0017
0018       This interface provides access to actions based on the USSD protocol.
0019   -->
0020   <interface name="org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd">
0021
0022     <!--
0023         Initiate:
0024         @command: The command to start the USSD session with.
0025         @reply: The network response to the command which started the USSD session.
0026
0027         Sends a USSD command string to the network initiating a USSD session.
0028
0029         When the request is handled by the network, the method returns the
0030         response or an appropriate error. The network may be awaiting further
0031         response from the ME after returning from this method and no new command
0032         can be initiated until this one is cancelled or ended.
0033     -->
0034     <method name="Initiate">
0035       <arg name="command" type="s" direction="in"  />
0036       <arg name="reply"   type="s" direction="out" />
0037     </method>
0038
0039     <!--
0040         Respond:
0041         @response: The response to network-initiated USSD command, or a response to a request for further input.
0042         @reply: The network reply to this response to the network-initiated USSD command. The reply may require further responses.
0043
0044         Respond to a USSD request that is either initiated by the mobile network,
0045         or that is awaiting further input after
0046         <link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Modem3gpp-Ussd.Initiate">Initiate()</link>
0047         was called.
0048     -->
0049     <method name="Respond">
0050       <arg name="response" type="s" direction="in"  />
0051       <arg name="reply"    type="s" direction="out" />
0052     </method>
0053
0054     <!--
0055         Cancel:
0056
0057         Cancel an ongoing USSD session, either mobile or network initiated.
0058     -->
0059     <method name="Cancel" />
0060
0061     <!--
0062         State:
0063
0064         A <link linkend="MMModem3gppUssdSessionState">MMModem3gppUssdSessionState</link> value,
0065         indicating the state of any ongoing USSD session.
0066     -->
0067     <property name="State" type="u" access="read" />
0068
0069     <!--
0070         NetworkNotification:
0071
0072         Contains any network-initiated request to which no USSD response is
0073         required.
0074
0075         When no USSD session is active, or when there is no network-
0076         initiated request, this property will be a zero-length string.
0077     -->
0078     <property name="NetworkNotification" type="s" access="read" />
0079
0080     <!--
0081         NetworkRequest:
0082
0083         Contains any pending network-initiated request for a response. Client
0084         should call
0085         <link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Modem3gpp-Ussd.Respond">Respond()</link>
0086         with the appropriate response to this request.
0087
0088         When no USSD session is active, or when there is no pending
0089         network-initiated request, this property will be a zero-length string.
0090     -->
0091     <property name="NetworkRequest" type="s" access="read" />
0092
0093   </interface>
0094 </node>