diff options
author | Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | 2011-01-25 17:35:29 +0100 |
---|---|---|
committer | Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | 2011-01-25 17:35:29 +0100 |
commit | 98a405c5541e9234aedf24e69696577722990728 (patch) | |
tree | 69d53543b031fa49b54ac4dcafbf796684c33f51 /extensions | |
parent | a2930de7b4b9efaa28a47bb841c1c8cd8932d191 (diff) |
add FileURI + its signal as future API
Diffstat (limited to 'extensions')
-rw-r--r-- | extensions/Channel_Type_FileTransfer_Future.xml | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/extensions/Channel_Type_FileTransfer_Future.xml b/extensions/Channel_Type_FileTransfer_Future.xml index b155136e0..bf91acd65 100644 --- a/extensions/Channel_Type_FileTransfer_Future.xml +++ b/extensions/Channel_Type_FileTransfer_Future.xml @@ -62,6 +62,45 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </property> + <property name="FileURI" type="s" access="readwrite" + tp:name-for-bindings="File_URI" tp:immutable="sometimes" tp:requestable="yes"> + <tp:added version="0.21.UNRELEASED"/> + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + <p>For outgoing file transfers, this requestable property allows the channel + requester to inform observers (and the handler, if it is not the requester + itself) of the URI of the file being transferred. Note that the + connection manager SHOULD NOT read this file directly; the handler + streams the file into the CM through the socket negotiated using + ProvideFile.</p> + + <p>On outgoing file transfers, this property MUST NOT change after the channel + is requested.</p> + + <p>For incoming file transfers, this property MAY be set by the channel + handler before calling AcceptFile to + inform observers where the incoming file will be saved. + Setting this property once AcceptFile + has been called MUST fail. Once this property has been set + FileURIDefined is fired.</p> + </tp:docstring> + </property> + + <signal name="FileURIDefined" + tp:name-for-bindings="File_URI_Defined"> + <tp:added version="0.21.UNRELEASED"/> + <tp:docstring> + Emitted when the value of the FileURI + property has been set. This signal MAY only be fired on incoming file + transfers if the handler had set a value to + FileURI before accepting the file. + </tp:docstring> + <arg name="File_URI" type="s"> + <tp:docstring> + The value of the FileURI property. + </tp:docstring> + </arg> + </signal> + </interface> </node> <!-- vim:set sw=2 sts=2 et ft=xml: --> |