Available methods for Imenik (turba)

Application: turba
Prefix: contacts
Name: Imenik

Example:

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

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

// XML RPC (http://pear.php.net/package/XML_RPC)
require_once "XML/RPC.php";
$msg = new XML_RPC_Message("contacts.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" => "contacts"));
$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.contacts.METHOD_NAME(PARAMETER_1, PARAMETER_2, PARAMETER_3 ...)

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

perms - ...

Call: (mixed) perms()

removeUserData - ...

Call: (mixed) removeUserData((mixed) user)
Parameters:

Type	Name	Documentation
mixed	user

browse - Browses through Turb...

Call: (array) browse( [ (string) path, (array) properties ] )

Description :

Browses through Turba's object tree.
'icon', and 'browseable'.

Parameters:

Type	Name	Documentation
string	path	The path of the tree to browse.
array	properties	The item properties to return. Defaults to 'name',

path_delete - Deletes a file from ...

Call: (mixed) path_delete((string) path)

Description :

Deletes a file from the Turba tree.

Parameters:

Type	Name	Documentation
string	path	The path to the file.

sources - ...

Call: (mixed) sources( [ (mixed) writeable ] )
Parameters:

Type	Name	Documentation
mixed	writeable

fields - ...

Call: (mixed) fields( [ (mixed) source ] )
Parameters:

Type	Name	Documentation
mixed	source

list - Returns an array of ...

Call: (array) list( [ (mixed) source ] )

Description :

Returns an array of UIDs for all contacts that the current user is
authorized to see.

Parameters:

Type	Name	Documentation
mixed	source

listBy - Returns an array of ...

Call: (array) listBy((string) action, (integer) timestamp [ , (string) source ] )

Description :

Returns an array of UIDs for contacts 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	source	e The source for which to retrieve the history.

getActionTimestamp - Returns the timestam...

Call: (integer) getActionTimestamp((string) uid, (string) action [ , (string) source ] )

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	source	The source for which to retrieve the history.

import - Import a contact rep...

Call: (string) import((string) content [ , (string) contentType, (string) import_source ] )

Description :

Import a contact represented in the specified contentType.
array and text/(x-)vcard.
imported.

Parameters:

Type	Name	Documentation
string	content	The content of the contact.
string	contentType	What format is the data in? Currently supports
string	import_source	The source into which the contact will be

export - Export a contact, id...

Call: (string) export((string) uid, (mixed) contentType [ , (mixed) source ] )

Description :

Export a contact, identified by UID, in the requested contentType.
Either a string with one of:

text/vcard
text/x-vcard

The first produces a vcard3.0 (rfc2426),
the second produces a vcard in old 2.1 format
defined by imc.org

Parameters:

Type	Name	Documentation
string	uid	Identify the contact to export.
mixed	contentType	What format should the data be in?
mixed	source

delete - Deletes a contact id...

Call: (boolean) delete((array) uid [ , (mixed) source ] )

Description :

Deletes a contact identified by UID.
UID or an array.

Parameters:

Type	Name	Documentation
array	uid	Identify the contact to delete, either a single
mixed	source

replace - Replaces the contact...

Call: (boolean) replace((string) uid, (string) content, (string) contentType [ , (mixed) source ] )

Description :

Replaces the contact identified by UID with the content represented in the
specified contentType.
array and text/(x-)vcard.

Parameters:

Type	Name	Documentation
string	uid	Idenfity the contact to replace.
string	content	The content of the contact.
string	contentType	What format is the data in? Currently supports
mixed	source

search - ...

Call: (mixed) search( [ (mixed) names, (mixed) sources, (mixed) fields, (mixed) matchBegin ] )
Parameters:

Type	Name	Documentation
mixed	names
mixed	sources
mixed	fields
mixed	matchBegin

getContact - ...

Call: (mixed) getContact( [ (mixed) source, (mixed) objectId ] )
Parameters:

Type	Name	Documentation
mixed	source
mixed	objectId

getContacts - ...

Call: (mixed) getContacts( [ (mixed) source, (mixed) objectIds ] )
Parameters:

Type	Name	Documentation
mixed	source
mixed	objectIds

addField - ...

Call: (mixed) addField( [ (mixed) address, (mixed) name, (mixed) field, (mixed) value, (mixed) source ] )
Parameters:

Type	Name	Documentation
mixed	address
mixed	name
mixed	field
mixed	value
mixed	source

deleteField - ...

Call: (mixed) deleteField( [ (mixed) address, (mixed) field, (mixed) sources ] )
Parameters:

Type	Name	Documentation
mixed	address
mixed	field
mixed	sources

getField - ...

Call: (mixed) getField( [ (mixed) address, (mixed) field, (mixed) sources, (mixed) strict, (mixed) multiple ] )
Parameters:

Type	Name	Documentation
mixed	address
mixed	field
mixed	sources
mixed	strict
mixed	multiple

getAllAttributeValues - ...

Call: (mixed) getAllAttributeValues( [ (mixed) field, (mixed) sources ] )
Parameters:

Type	Name	Documentation
mixed	field
mixed	sources

listTimeObjectCategories - ...

Call: (mixed) listTimeObjectCategories()

listTimeObjects - Lists birthdays and/...

Call: (mixed) listTimeObjects((array) time_categories, (mixed) start, (mixed) end)

Description :

Lists birthdays and/or anniversaries as time objects.
listTimeObjectCategories) to list.

Parameters:

Type	Name	Documentation
array	time_categories	The time categories (from
mixed	start	The start date of the period.
mixed	end	The end date of the period.

getClientSource - ...

Call: (mixed) getClientSource()

clientFields - ...

Call: (mixed) clientFields()

getClient - ...

Call: (mixed) getClient( [ (mixed) objectId ] )
Parameters:

Type	Name	Documentation
mixed	objectId

getClients - ...

Call: (mixed) getClients( [ (mixed) objectIds ] )
Parameters:

Type	Name	Documentation
mixed	objectIds

addClient - ...

Call: (mixed) addClient( [ (mixed) attributes ] )
Parameters:

Type	Name	Documentation
mixed	attributes

updateClient - ...

Call: (mixed) updateClient( [ (mixed) objectId, (mixed) attributes ] )
Parameters:

Type	Name	Documentation
mixed	objectId
mixed	attributes

deleteClient - ...

Call: (mixed) deleteClient( [ (mixed) objectId ] )
Parameters:

Type	Name	Documentation
mixed	objectId

searchClients - ...

Call: (mixed) searchClients( [ (mixed) names, (mixed) fields, (mixed) matchBegin ] )
Parameters:

Type	Name	Documentation
mixed	names
mixed	fields
mixed	matchBegin

commentCallback - ...

Call: (mixed) commentCallback((mixed) id)
Parameters:

Type	Name	Documentation
mixed	id

hasComments - ...

Call: (mixed) hasComments()