Available methods for Zaznamki (trean)

Application: trean
Prefix: bookmarks
Name: Zaznamki

Example:

// inside ObalaNET 1
$result = $registry->call("bookmarks/METHOD_NAME", array(PARAMETERS));

// inside ObalaNET 2
$result = $registry->callByPackage("trean", "METHOD_NAME", array(PARAMETERS));

// XML RPC (http://pear.php.net/package/XML_RPC)
require_once "XML/RPC.php";
$msg = new XML_RPC_Message("bookmarks.METHOD_NAME", PARAMETERS);
$cli = new XML_RPC_Client("/rpc.php", "http://HOSTNAME");
$resp = $cli->send($msg);
$val = $resp->value();
$result = XML_RPC_decode($val);

// XML RPC 2 (http://pear.php.net/package/XML_RPC2)
require_once "XML/RPC2/Client.php";
$client = XML_RPC2_Client::create("http://HOSTNAME/rpc.php", array("prefix" => "bookmarks"));
$result = $client->METHOD_NAME(PARAMETER_1, PARAMETER_2, PARAMETER_3 ...);

// Python Example (http://wiki.horde.org/XmlRpcPythonHowTo)
import xmlrpclib
url = "http://HOSTNAME/rpc.php"
server = xmlrpclib.ServerProxy(url, verbose=0)
result = server.bookmarks.METHOD_NAME(PARAMETER_1, PARAMETER_2, PARAMETER_3 ...)

More detailed examples: http://www.drugapisarna.si/wicked/ZunanjaUporaba

perms - Trean external API i...

Call: (mixed) perms()

Description :

Trean external API interface.
This file defines Trean's external API interface. Other
applications can interact with Trean through this API.
$Horde: trean/lib/api.php,v 1.21 2008/01/02 11:14:02 jan Exp $
Copyright 2002-2008 The Horde Project (http://www.horde.org/)
See the enclosed file LICENSE for license information (BSD). If you
did not receive this file, see http://www.horde.org/licenses/bsdl.php.

getFolders - Gets all the folders...

Call: (array) getFolders((integer) folderId)

Description :

Gets all the folders that are a subfolder of the given folder (or the
root.)
'id' as the folder's ID, and 'name' as its name.

Parameters:

Type	Name	Documentation
integer	folderId	the ID of the folder, or -1 for the root

updateObjects - ...

Call: (mixed) updateObjects((mixed) data)
Parameters:

Type	Name	Documentation
mixed	data

addObjects - ...

Call: (mixed) addObjects((mixed) data)
Parameters:

Type	Name	Documentation
mixed	data

listBookmarks - Returns all the book...

Call: (array) listBookmarks((integer) folderId [ , (string) sortby, (integer) sortdir, (integer) from, (integer) count ] )

Description :

Returns all the bookmarks in a given folder, sorted and "paginated."
the bookmarks.

Parameters:

Type	Name	Documentation
integer	folderId	the ID of a folder, or -1 for root
string	sortby	y field to sort by
integer	sortdir	direction to sort by (non-0 for descending)
integer	from	bookmark to start from
integer	count	how many bookmarks to return

deleteFolder - Delete a given folde...

Call: (boolean) deleteFolder((integer) folderId, (boolean) force)

Description :

Delete a given folder.

Parameters:

Type	Name	Documentation
integer	folderId	the ID of the folder
boolean	force	Force-remove child objects? (currently ignored)

deleteFolders - ...

Call: (mixed) deleteFolders((mixed) Ids)
Parameters:

Type	Name	Documentation
mixed	Ids

deleteBookmark - Delete a given bookm...

Call: (boolean) deleteBookmark((integer) bookmarkId)

Description :

Delete a given bookmark.

Parameters:

Type	Name	Documentation
integer	bookmarkId	Id the ID of the bookmark to delete

deleteBookmarks - ...

Call: (mixed) deleteBookmarks((mixed) Ids)
Parameters:

Type	Name	Documentation
mixed	Ids

syncFolders - Synchronize folders ...

Call: (array) syncFolders((integer) folderId, (array) folderIds)

Description :

Synchronize folders in a folder.  Send a list of IDs, get a list of new
folders and placeholders for deleted ones.  See _trean_syncBookmarks()
for more details.
the newly created folders' data, or placeholders for deleted folders.

Parameters:

Type	Name	Documentation
integer	folderId	the ID of the folder, or -1 for root
array	folderIds	s integer array of folder IDs to sync against

syncBookmarks - Synchronize bookmark...

Call: (array) syncBookmarks((integer) folderId, (array) bookmarkIds)

Description :

Synchronize bookmarks in a folder.  Send a list of IDs of bookmarks you
know about, get an array of new bookmarks and placeholders for bookmarks
you have that are now deleted.
newly created bookmarks' data, or for deleted bookmarks, a placeholder with
'id' as the ID of the bookmark and 'sync_deleted' as true.

Parameters:

Type	Name	Documentation
integer	folderId	the ID of the folder, or -1 for root
array	bookmarkIds	s integer array of the bookmark IDs to sync against