Warning, /network/kio-extras/mtp/shared/org.kde.kmtp.storage.xml is written in an unsupported language. File is not indexed.

0001 <!DOCTYPE node PUBLIC
0002 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
0003 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
0004 
0005 <!--
0006     This file is part of the KMTP framework, part of the KDE project.
0007 
0008     SPDX-FileCopyrightText: 2018 Andreas Krutzler <andreas.krutzler@gmx.net>
0009 
0010     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
0011 -->
0012 
0013 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
0014 
0015     <!-- org.kde.kmtp.Storage:
0016     @short_description: MTP file, folder and object access API
0017 
0018     This D-Bus interface is used to access MTP files, folders and objects.
0019     -->
0020     <interface name="org.kde.kmtp.Storage">
0021 
0022         <!-- description: A brief description of this storage.
0023         -->
0024         <property name="description" type="s" access="read"/>
0025         <property name="maxCapacity" type="t" access="read"/>
0026         <property name="freeSpaceInBytes" type="t" access="read"/>
0027 
0028         <!-- getFilesAndFolders
0029         -->
0030         <method name="getFilesAndFolders">
0031             <arg direction="in" type="s" name="path"/>
0032             <arg direction="out" type="a(uuustxs)"/>
0033             <arg direction="out" type="i" name="exists"/>
0034             <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="KMTPFileList"/>
0035         </method>
0036 
0037         <method name="getFilesAndFolders2">
0038             <arg type="o" direction="out"/>
0039             <arg name="path" type="s" direction="in"/>
0040         </method>
0041 
0042         <!-- getFileMetadata
0043         -->
0044         <method name="getFileMetadata">
0045             <arg direction="in" type="s" name="path"/>
0046             <arg direction="out" type="(uuustxs)"/>
0047             <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="KMTPFile"/>
0048         </method>
0049 
0050         <!-- getFileToHandler: TODO.
0051         -->
0052         <method name="getFileToHandler">
0053             <arg direction="in" type="s" name="path"/>
0054             <arg direction="out" type="i"/>
0055         </method>
0056 
0057         <!-- getFileToFileDescriptor: Gets a file from the device to a local file.
0058         @descriptor:      The unix file descriptor to copy to
0059         @sourcePath:      Filepath on the device
0060         @result:               The result of the operation. 0 if successful, else not.
0061 
0062         This method will return immediately and emits the copyFinished signal when everything is done.
0063         To track the progress of the operation use the copyProgress signal.
0064         NOTE: The copyFinished and copyProgress signals are just emitted if @result is 0.
0065         -->
0066         <method name="getFileToFileDescriptor">
0067             <arg direction="in" type="h" name="descriptor"/>
0068             <arg direction="in" type="s" name="sourcePath"/>
0069             <arg direction="out" type="i" name="result"/>
0070         </method>
0071 
0072         <!-- sendFileFromFileDescriptor: Sends a local file to a device by its unix file descriptor.
0073         @descriptor:      The unix file descriptor to copy from
0074         @destinationPath: Filepath on the device
0075         @result:               The result of the operation. 0 if successful, else not.
0076 
0077         This method will return immediately and emits the copyFinished signal when everything is done.
0078         To track the progress of the operation use the copyProgress signal.
0079         NOTE: The copyFinished and copyProgress signals are just emitted if @result is 0.
0080         -->
0081         <method name="sendFileFromFileDescriptor">
0082             <arg direction="in" type="h" name="descriptor"/>
0083             <arg direction="in" type="s" name="destinationPath"/>
0084             <arg direction="out" type="i"/>
0085         </method>
0086 
0087         <!--
0088         setFileName
0089         @path:          The path of the file.
0090         @newName:       The new name of the file
0091         @result:        The result of the operation. 0 if successful, else not.
0092         -->
0093         <method name="setFileName">
0094             <arg direction="in"  type="s" name="path" />
0095             <arg direction="in"  type="s" name="newName" />
0096             <arg direction="out" type="i" name="result" />
0097         </method>
0098 
0099         <!--
0100         createFolder
0101         @path:               The path of the new folder
0102         @result:             The result of the operation. 0 if successful, else not.
0103         -->
0104         <method name="createFolder">
0105             <arg direction="in" type="s" name="path"/>
0106             <arg direction="out" type="u"/>
0107         </method>
0108 
0109         <!--
0110         deleteObject
0111         @path:   The path of the object.
0112         @result: The result of the operation. 0 if successful, else not.
0113         -->
0114         <method name="deleteObject">
0115             <arg direction="in" type="s" name="path"/>
0116             <arg direction="out" type="i" name="result" />
0117         </method>
0118 
0119         <!-- dataReady: TODO.
0120         -->
0121         <signal name="dataReady">
0122             <arg direction="out" type="ay" name="data"/>
0123             <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QByteArray"/>
0124         </signal>
0125 
0126         <!--
0127         copyProgress: Signal is emitted when a progress update has been issued by LIBMTP. Applies only to copy operations.
0128         @transferredBytes:  Currently transferred bytes
0129         @totalBytes:        Total number of bytes to transfer
0130         -->
0131         <signal name="copyProgress">
0132             <arg type="t" name="transferredBytes"/>
0133             <arg type="t" name="totalBytes"/>
0134         </signal>
0135 
0136         <!--
0137         copyFinished: Signal is emitted when a copy operation has finished.
0138         @result:            The result of the operation. 0 if successful, else not.
0139         -->
0140         <signal name="copyFinished">
0141             <arg type="i" name="result"/>
0142         </signal>
0143 
0144     </interface>
0145 </node>