Available methods for Zapiski (mnemo)
Application: mnemo
Prefix: notes
Name: Zapiski
Example:
// inside ObalaNET 1
$result = $registry->call("notes/METHOD_NAME", array(PARAMETERS));
// inside ObalaNET 2
$result = $registry->callByPackage("mnemo", "METHOD_NAME", array(PARAMETERS));
// XML RPC (http://pear.php.net/package/XML_RPC)
require_once "XML/RPC.php";
$msg = new XML_RPC_Message("notes.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" => "notes"));
$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.notes.METHOD_NAME(PARAMETER_1, PARAMETER_2, PARAMETER_3 ...)
More detailed examples: http://www.drugapisarna.si/wicked/ZunanjaUporaba
perms - Mnemo external API i...
Call: (mixed) perms()
Description :
Mnemo external API interface.
This file defines Mnemo's external API interface. Other applications can
interact with Mnemo through this API.
$Horde: mnemo/lib/api.php,v 1.83 2008/01/02 11:13:46 jan Exp $
Copyright 2001-2008 The Horde Project (http://www.horde.org/)
See the enclosed file LICENSE for license information (ASL). If you
did not receive this file, see http://www.horde.org/licenses/asl.php.
removeUserData - ...
Call: (mixed) removeUserData((mixed) user)
Parameters:
| Type |
Name |
Documentation |
| mixed |
user |
listNotepads - Defaults to false....
Call: (array) listNotepads((boolean) owneronly, (integer) permission)
Description :
Defaults to false.
Parameters:
| Type |
Name |
Documentation |
| boolean |
owneronly |
Only return notepads that this user owns? |
| integer |
permission |
The permission to filter notepads by. |
list - Returns an array of ...
Call: (array) list( [ (mixed) notepad ] )
Description :
Returns an array of UIDs for all notes that the current user is authorized
to see.
Parameters:
| Type |
Name |
Documentation |
| mixed |
notepad |
listBy - Returns an array of ...
Call: (array) listBy((string) action, (integer) timestamp [ , (string) notepad ] )
Description :
Returns an array of UIDs for notes that have had $action happen since
$timestamp.
Parameters:
| Type |
Name |
Documentation |
| string |
action |
n The action to check for - add, modify, or delete. |
| integer |
timestamp |
The time to start the search. |
| string |
notepad |
d The notepad to search in. |
getActionTimestamp - Returns the timestam...
Call: (integer) getActionTimestamp((string) uid, (string) action [ , (string) notepad ] )
Description :
Returns the timestamp of an operation for a given uid an action.
Parameters:
| Type |
Name |
Documentation |
| string |
uid |
The uid to look for. |
| string |
action |
The action to check for - add, modify, or delete. |
| string |
notepad |
The notepad to search in. |
import - Import a memo repres...
Call: (string) import((string) content, (string) contentType [ , (string) notepad ] )
Description :
Import a memo represented in the specified contentType.
text/plain
text/x-vnote
Parameters:
| Type |
Name |
Documentation |
| string |
content |
The content of the memo. |
| string |
contentType |
What format is the data in? Currently supports: |
| string |
notepad |
(optional) The notepad to save the memo on. |
export - Export a memo, ident...
Call: (string) export((string) uid, (string) contentType)
Description :
Export a memo, identified by UID, in the requested contentType.
A string with one of:
'text/plain'
'text/x-vnote'
Parameters:
| Type |
Name |
Documentation |
| string |
uid |
Identify the memo to export. |
| string |
contentType |
What format should the data be in? |
delete - Delete a memo identi...
Call: (boolean) delete((string) uid)
Description :
Delete a memo identified by UID.
single UID or an array.
Parameters:
| Type |
Name |
Documentation |
| string |
uid |
ray $uid Identify the note to delete, either a |
replace - Replace the memo ide...
Call: (boolean) replace((string) uid, (string) content, (string) contentType)
Description :
Replace the memo identified by UID with the content represented in
the specified contentType.
text/plain
text/x-vnote
Parameters:
| Type |
Name |
Documentation |
| string |
uid |
Idenfity the memo to replace. |
| string |
content |
The content of the memo. |
| string |
contentType |
What format is the data in? Currently supports: |