org.nemo.transferengine.xml 5.77 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">

<node name="/org/nemo/transferengine">
    <interface name="org.nemo.transferengine">

        # Share API
        <method name="uploadMediaItem">
          <arg direction="in" type="s" name="source"/>
          <arg direction="in" type="s" name="serviceId"/>
          <arg direction="in" type="s" name="mimeType"/>
          <arg direction="in" type="b" name="metadataStripped"/>
          <arg direction="in" type="a{sv}" name="userData" />
          <arg direction="out" type="i" name="transferId"/>
          <annotation name="org.qtproject.QtDBus.QtTypeName.In4" value="QVariantMap"/>
        </method>
        <method name="uploadMediaItemContent">
          <arg direction="in" type="a{sv}" name="content" />
          <arg direction="in" type="s" name="serviceId"/>
          <arg direction="in" type="a{sv}" name="userData" />
          <arg direction="out" type="i" name="transferId"/>
          <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
          <annotation name="org.qtproject.QtDBus.QtTypeName.In2" value="QVariantMap"/>
        </method>

        # create Sync Entry
        <method name="createSync">
            <arg direction="in" type="s" name="displayName"/>
            <arg direction="in" type="s" name="applicationIcon"/>
            <arg direction="in" type="s" name="serviceIcon"/>
            <arg direction="in" type="as" name="callback"/>
            <arg direction="in" type="s" name="cancelMethod"/>
            <arg direction="in" type="s" name="restartMethod"/>
            <arg direction="out" type="i" name="transferId"/>
        </method>

        # create Download entry
        <method name="createDownload">
            <arg direction="in" type="s" name="displayName"/>
            <arg direction="in" type="s" name="applicationIcon"/>
            <arg direction="in" type="s" name="serviceIcon"/>
            <arg direction="in" type="s" name="filePath"/>
            <arg direction="in" type="s" name="mimeType"/>
            <arg direction="in" type="x" name="expectedFileSize"/>
            <arg direction="in" type="as" name="callback"/>
            <arg direction="in" type="s" name="cancelMethod"/>
            <arg direction="in" type="s" name="restartMethod"/>
            <arg direction="out" type="i" name="transferId"/>
        </method>

        # API for updating either download or sync
        <method name="updateTransferProgress">
            <arg direction="in" type="i" name="transferId"/>
            <arg direction="in" type="d" name="progress"/>
        </method>

        # Mark specific upload or a sync as started.
        <method name="startTransfer">
            <arg direction="in" type="i" name="transferId"/>
        </method>

        # Restart upload or a sync
        <method name="restartTransfer">
            <arg direction="in" type="i" name="transferId"/>
        </method>

        # Mark a specific upload or a sync transfer as finished
        # if success == false, then the reason for failure should
        # be set to human readable message
        <method name="finishTransfer">
            <arg direction="in" type="i" name="transferId"/>
            <arg direction="in" type="i" name="transferStatus"/>
            <arg direction="in" type="s" name="reason"/>
        </method>

        # Get a list of transfers
        <method name="transfers">
            <arg name="records" type="a(iidss)" direction="out" />
            <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QList &lt; TransferDBRecord &gt; "/>
        </method>

82 83 84 85 86 87
        # Get a list of active transfers
        <method name="activeTransfers">
            <arg name="records" type="a(iidss)" direction="out" />
            <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QList &lt; TransferDBRecord &gt; "/>
        </method>

88 89 90
        # Get a list of transfer methods such as FB, Twitter, BT, NFC, etc
        <method name="transferMethods">
            <arg name="methods" type="a(ssssasi)" direction="out" />
91 92 93 94 95 96 97
            <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QList &lt; TransferMethodInfoDeprecated &gt; "/>
        </method>

        # Get a list of transfer methods such as FB, Twitter, BT, NFC, etc
        <method name="transferMethods2">
            <arg name="methods" type="a(ssssasusa{sv})" direction="out" />
            <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QList &lt; TransferMethodInfo&gt; "/>
98 99 100 101 102 103 104 105 106 107
        </method>

        # clear all unfinished transfers
        <method name="clearTransfers" />

        # cancel a specific transfer
        <method name="cancelTransfer">
            <arg name="transferId" type="i" direction="in"/>
        </method>

108 109 110 111
        <method name="clearTransfer">
            <arg name="transferId" type="i" direction="in"/>
        </method>

112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
        # enable or disable notifications
        <method name="enableNotifications">
            <arg name="enable" type="b" direction="in"/>
        </method>

        # Query if notifications are enabled
        <method name="notificationsEnabled">
            <arg name="enabled" type="b" direction="out"/>
        </method>

        # Signals for indicating changes in transfers
        <signal name="progressChanged">
            <arg name="transferId" type="i" direction="out"/>
            <arg name="progress" type="d" direction="out"/>
        </signal>

        <signal name="statusChanged">
            <arg name="transferId" type="i" direction="out"/>
            <arg name="status" type="i" direction="out"/>
        </signal>

        <signal name="transfersChanged" />

135 136
        <signal name="activeTransfersChanged" />

137 138 139 140
        <signal name="transferMethodListChanged" />
   </interface>
</node>