← Back to branch summary

~ubuntu-branches/ubuntu/maverick/bluedevil/maverick-proposed

« back to all changes in this revision

Viewing changes to src/kio/obextest/obexftp/doc/obexd-api.txt

  • Committer: Bazaar Package Importer
  • Author(s): Mark Purcell
  • Date: 2010-08-07 09:04:19 UTC
  • Revision ID: james.westby@ubuntu.com-20100807090419-68k54ucso2htcf5z
Tags: upstream-1.0~rc2
Import upstream version 1.0~rc2

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/kio/obextest/obexftp/doc/obexd-api.txt
 
1
obexd API description
 
2
**********************************
 
3
 
 
4
Copyright (C) 2007-2010  Nokia Corporation
 
5
Copyright (C) 2007-2010  Marcel Holtmann <marcel@holtmann.org>
 
6
 
 
7
 
 
8
Manager hierarchy
 
9
===============
 
10
 
 
11
Service         org.openobex
 
12
Interface       org.openobex.Manager
 
13
Object path     /
 
14
 
 
15
Methods
 
16
                void RegisterAgent(object agent)
 
17
 
 
18
                        Register an agent to request authorization of 
 
19
                        the user to accept/reject objects. Object push
 
20
                        service needs to authorize each received object.
 
21
 
 
22
                        Possible errors: org.openobex.Error.AlreadyExists
 
23
 
 
24
                void UnregisterAgent(object agent)
 
25
 
 
26
                        This unregisters the agent that has been previously
 
27
                        registered. The object path parameter must match the
 
28
                        same value that has been used on registration.
 
29
 
 
30
                        Possible errors: org.openobex.Error.DoesNotExist
 
31
 
 
32
Signals         SessionCreated(object session)
 
33
                        
 
34
                        Signal sent when OBEX connection has been accepted.
 
35
                        (FTP only)
 
36
 
 
37
                SessionRemoved(object session)
 
38
                        
 
39
                        Sent when the transport is disconnected
 
40
                        (FTP only)
 
41
 
 
42
                TransferStarted(object transfer)
 
43
 
 
44
                        Signal sent when an object push operation starts.
 
45
                        (OPP only)
 
46
 
 
47
                TransferCompleted(object transfer, boolean success)
 
48
 
 
49
                        Signal sent when the object has been received
 
50
                        or an error happens.
 
51
                        (OPP only)
 
52
 
 
53
 
 
54
Transfer hierarchy
 
55
===============
 
56
 
 
57
Service         org.openobex
 
58
Interface       org.openobex.Transfer
 
59
Object path     /transfer{0, 1, 2, ...}
 
60
 
 
61
Methods
 
62
                void Cancel()
 
63
 
 
64
                        Stops the current transference.
 
65
 
 
66
Signals
 
67
                Progress(int32 total, int32 transfered)
 
68
 
 
69
 
 
70
Session hierarchy
 
71
===============
 
72
 
 
73
Service         org.openobex
 
74
Interface       org.openobex.Session
 
75
Object path     /session{0, 1, 2, ...}
 
76
 
 
77
Methods
 
78
                dict GetProperties()
 
79
 
 
80
 
 
81
Signals         TBD
 
82
 
 
83
 
 
84
Properties
 
85
                string Address [readonly]
 
86
 
 
87
                        Bluetooth device address or USB