Manager hierarchy
===============================
Service org.openobex
Interface org.openobex.Manager
Object path /org/openobex
Methods string CreateBluetoothClient(string source_address, string destination_address)
Gets BluetoothClient object for particular source and
destination addresses.
Returns object path for the created client.
Possible errors:
string CreateBluetoothServer(string source_address)
Gets BluetoothServer object for specified source address.
Returns object path for the created server.
Possible errors:
string CreateIrdaClient()
string CreateIrdaServer()
string CreateInetClient(string destination_address)
string CreateInetServer(string source_address)
string CreateTtyClient(string tty_device)
string CreateTtyServer(string tty_device)
Server hierarchy
===============================
Service org.openobex
Interface org.openobex.Server
Object path /org/openobex/Server/{1,2...}
Methods void Start(string save_path, string serve_path)
Asynchronously starts OBEX Object Push / FTP server (begins
listening for connections). OnStarted signal is emitted after
the server is started. If error occurs, OnError signal is emitted
instead. Once the server is started, it emits OnTransferBegin signal
for every transfer.
save_path defines where all received files will be saved,
serve_path defines which path will be the top-level folder for
FTP server.
Possible errors:
void Stop()
Asynchronously stops the server. OnStopped signal is emitted after
the server is stopped.
Possible errors:
boolean IsStarted()
Returns true if server is started, false otherwise.
Possible errors: none
Signals void OnStarted()
This signal informs that the server was started.
void OnStopped()
This signal informs that the server was stopped and all operations
were ceased.
void OnError(string error_name, string error_message)
This signal informs that error occured while starting or stopping
the server.
void OnTransferBegin(string transfer_object)
This signal informs that remote client has connected to the server
and file transfer was started.
transfer_object is object path for newly started transfer. This object
should be used for tracking transfer progress.
Transfer hierarchy
===============================
Service org.openobex
Interface org.openobex.Transfer
Object path /org/openobex/Transfer/{1,2...}
Methods void Cancel()
Asynchronously cancels the transfer. OnCancelled signal is emitted
after the transfer is fully cancelled.
Possible errors:
int GetTotalBytes()
Returns the number of total bytes that are being sent. null is returned
if total bytes are unknown.
Possible errors: none
string GetFilename()
Returns the filename or null if it is unknown.
Possible errors: none
dict GetInfo()
Returns all info about this transfer (filename, local path, total bytes).
Possible errors: none
string GetLocalPath()
Returns local path. In case this transfer is incoming (file is being
received from a remote device), this will be the path where the
received file will be saved. If transfer is outgoing, this will be
full path of file being sent.
Possible errors: none
Signals void OnProgress(int bytes_transferred)
This signal is emitted constantly during the transfer.
bytes_transferred specifies how many bytes were already transferred.
void OnComplete()
This signal informs that transfer was completed and that this object
is no longer valid.
void OnCancelled()
This signal informs that transfer was cancelled using Cancel() method
and that this object is no loger valid.
void OnError(string error_name, string error_message)
This signal informs that error occured during the transfer and that
this object is no longer valid.
Client hierarchy
===============================
Service org.openobex
Interface org.openobex.Client
Object path /org/openobex/Client/{1,2...}
Methods void ConnectToObjectPushService()
Asynchronously connects to ObjectPush service on a remote device.
FTP functionality of this object will be disabled. OnConnected
signal is emitted once connected. If error occurs during operation,
OnError signal is emitted instead.
Possible errors:
void ConnectToFTPService()
Asynchronously connects to FTP service on a remote device. OnConnected
signal is emitted once connected. If error occurs during operation,
OnError signal is emitted instead.
Possible errors:
void Disconnect()
Asynchronously disconnects from remote device. OnDisconnected signal
is emitted once disconnected.
Possible errors: none
boolean IsConnected()
Returns true if connected to ObjectPush or FTP services on a remote
device, false otherwise.
Possible errors:
void ChangeCurrentFolder(string path)
Asynchronously changes current path on a remote device to the
specified one. OnPathChangeComplete signal is emitted when the path
is changed. If error occurs during operation, OnError signal is
emitted instead.
Possible errors:
void ChangeCurrentFolderBackward()
Asynchronously changes current path on a remote device one level
up. If current folder is root, path is not changed.
OnPathChangeComplete signal is emitted when the path is changed.
If error occurs during operation, OnError signal is emitted instead.
Possible errors:
void ChangeCurrentFolderToRoot()
Asynchronously changes current path on a remote device to root.
OnPathChangeComplete signal is emitted when the path is changed.
If error occurs during operation, OnError signal is emitted instead.
Possible errors:
string GetCurrentPath()
Returns current path on a remote device.
Possible errors: none
void CopyRemoteFile(string remote_filename, string local_path)
Asynchronously starts receiving a specified file from a remote device.
remote_filename specifies the file to receive on a remote device.
local_path is the path where received file will be saved.
OnTransferBegin signal is emitted when transfer starts. If error
occurs during operation, OnError signal is emitted instead.
Possible errors:
void CreateFolder(string folder_name)
Asynchronously creates a folder on a remote device with a specified
name. OnCreateFolderComplete signal is emitted when the folder is
created. If error occurs during operation, OnError signal is emitted
instead.
Possible errors:
void RetrieveFolderListing()
Asynchronously retrieves the list of files in current folder. The
actual listing is returned by OnRetrieveFolderListingComplete signal.
If error occurs during operation, OnError signal is emitted instead.
Possible errors:
void SendFile(string local_path)
Asynchronously starts sending a specified file to a remote device.
local_path specifies the path to file that will be sent.
OnTransferBegin signal is emitted when transfer starts. If error
occurs during operation, OnError signal is emitted instead.
Possible errors:
void DeleteRemoteFile(string remote_filename)
Asynchronously deletes specified file on remote device.
OnDeleteRemoteFileComplete signal is emitted when the file is deleted.
If error occurs during operation, OnError signal is emitted instead.
Possible errors:
boolean IsBusy()
Returns true if there is an operation in progress, false otherwise.
Possible errors: none.
void Cancel()
Asynchronously cancels any operation that is in progress. OnCancelled
signal is emitted once there is no operation in progress.
Possible errors:
Signals void OnConnected()
This signal informs that the client is connected and ready for
operations.
void OnDisconnected()
This signal informs that the client was disconnected and all operations
were ceased.
void OnPathChangeComplete(string path)
Informs that path change operation is complete. path specifies the
current path.
void OnCreateFolderComplete(string folder_name)
Informs that folder creation is complete. folder_name specifies the
name of created folder.
void OnDeleteRemoteFileComplete(string filename)
Informs that remote file was deleted. filename specifies the name of
the deleted file.
void OnRetrieveFolderListingComplete(array{string} listing)
Informs that folder listing operation is complete. listing is a
string array of filenames.
void OnTransferBegin(string transfer_object)
This signal informs that transfer was started.
transfer_object is object path for newly started transfer. This object
should be used for tracking transfer progress.
void OnError(string error_name, string error_message)
This signal informs that error occured while performing some operation.