introspection/org.freedesktop.ModemManager1.Modem.Messaging.xml

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

<!--
 ModemManager 0.6 Interface Specification

   Copyright (C) 2008 Novell, Inc.
   Copyright (C) 2008-2011 Red Hat, Inc.
   Copyright (C) 2011 The Chromium OS Authors
   Copyright (C) 2011 Google, Inc.
-->

<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">

  <!--
      org.freedesktop.ModemManager1.Modem.Messaging:
      @short_description: The ModemManager Messaging interface.

      The Messaging interface handles sending SMS messages and notification of new
      incoming messages.
  -->
  <interface name="org.freedesktop.ModemManager1.Modem.Messaging">

    <!--
        List:
        @result: The list of SMS object paths.

        Retrieve all SMS messages.

        This method should only be used once and subsequent information
        retreived either by listening for the
        #org.freedesktop.ModemManager1.Modem.Messaging::Added and
        #org.freedesktop.ModemManager1.Modem.Messaging::Completed signals,
        or by querying the specific SMS object of interest.
    -->
    <method name="List">
      <arg name="result" type="ao" direction="out" />
    </method>

    <!--
        Delete:
        @path: The object path of the SMS to delete.

        Delete an SMS message.
    -->
    <method name="Delete">
      <arg name="path" type="o" direction="in" />
    </method>

    <!--
        Create:
        @properties: Message properties from the <link linkend="gdbus-org.freedesktop.ModemManager1.Sms">SMS D-Bus interface</link>.
        @path: The object path of the new message object.

        Creates a new message object.

        The '<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.Number">Number</link>'
        and
        '<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.Text">Text</link>'
        properties are mandatory, others are optional.

        If the SMSC is not specified and one is required, the default SMSC is
        used.
    -->
    <method name="Create">
      <arg name="properties" type="a{sv}" direction="in"  />
      <arg name="path"       type="o"     direction="out" />
    </method>

    <!--
        Added:
        @path: Object path of the new SMS.
        @received: %TRUE if the message was received from the network, as opposed to being added locally.

        Emitted when any part of a new SMS has been received or added (but not
        for subsequent parts, if any). For messages received from the network,
        not all parts may have been received and the message may not be
        complete.

        Check the
        '<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.State">State</link>'
        property to determine if the message is complete. The
        #org.freedesktop.ModemManager1.Modem.Messaging::Completed
        signal will also be emitted when the message is complete.
    -->
    <signal name="Added">
      <arg name="path" type="o" />
      <arg name="received" type="b" />
    </signal>

    <!--
        Completed:
        @path: Object path of the new SMS.

        Emitted when the complete-ness status of an SMS message changes.

        An SMS may not necessarily be complete when the first part is received;
        this signal will be emitted when all parts have been received, even for
        single-part messages.
    -->
    <signal name="Completed">
      <arg name="path" type="o" />
    </signal>

    <!--
        Deleted:
        @path: Object path of the now deleted SMS.

        Emitted when a message has been deleted.
    -->
    <signal name="Deleted">
      <arg name="path" type="o" />
    </signal>

  </interface>
</node>