Available methods for ObalaNET (horde)

Application: horde
Prefix: horde
Name: ObalaNET

Example:

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

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

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

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

perms - Horde external API i...

Call: (mixed) perms()

Description :

Horde external API interface.
This file defines Horde's external API interface. Other
applications can interact with Horde through this API.
$Horde: horde/lib/api.php,v 1.61 2007/12/20 09:52:04 jan Exp $

admin_list - ...

Call: (mixed) admin_list()

listApps - ...

Call: (mixed) listApps( [ (mixed) filter ] )
Parameters:

Type	Name	Documentation
mixed	filter

listAPIs - ...

Call: (mixed) listAPIs()

blockTitle - ...

Call: (mixed) blockTitle((mixed) app, (mixed) name [ , (mixed) params ] )
Parameters:

Type	Name	Documentation
mixed	app
mixed	name
mixed	params

blockContent - ...

Call: (mixed) blockContent((mixed) app, (mixed) name [ , (mixed) params ] )
Parameters:

Type	Name	Documentation
mixed	app
mixed	name
mixed	params

blocks - ...

Call: (mixed) blocks()

getPreference - ...

Call: (mixed) getPreference((mixed) app, (mixed) pref)
Parameters:

Type	Name	Documentation
mixed	app
mixed	pref

setPreference - ...

Call: (mixed) setPreference((mixed) app, (mixed) pref, (mixed) value)
Parameters:

Type	Name	Documentation
mixed	app
mixed	pref
mixed	value

removeUserData - ...

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

Type	Name	Documentation
mixed	user

addGroup - Adds a group to the ...

Call: (mixed) addGroup((string) name [ , (string) parent ] )

Description :

Adds a group to the groups system.

Parameters:

Type	Name	Documentation
string	name	The group's name.
string	parent	The group's parent's name.

removeGroup - Removes a group from...

Call: (mixed) removeGroup((string) name)

Description :

Removes a group from the groups system.

Parameters:

Type	Name	Documentation
string	name	The group's name.

addUserToGroup - Adds a user to a gro...

Call: (mixed) addUserToGroup((string) name, (string) user)

Description :

Adds a user to a group.

Parameters:

Type	Name	Documentation
string	name	The group's name.
string	user	The user to add.

addUsersToGroup - Adds multiple users ...

Call: (mixed) addUsersToGroup((string) name, (array) users)

Description :

Adds multiple users to a group.

Parameters:

Type	Name	Documentation
string	name	The group's name.
array	users	The users to add.

removeUserFromGroup - Removes a user from ...

Call: (mixed) removeUserFromGroup((string) name, (string) user)

Description :

Removes a user from a group.

Parameters:

Type	Name	Documentation
string	name	The group's name.
string	user	The user to add.

removeUsersFromGroup - Removes multiple use...

Call: (mixed) removeUsersFromGroup((string) name, (array) users)

Description :

Removes multiple users from a group.

Parameters:

Type	Name	Documentation
string	name	The group's name.
array	users	The users to add.

listUsersOfGroup - Returns a list of us...

Call: (array) listUsersOfGroup((mixed) name)

Description :

Returns a list of users that are part of this group (and only this group)

Parameters:

Type	Name	Documentation
mixed	name

addShare - Adds a share to the ...

Call: (mixed) addShare((string) shareRoot, (string) shareName, (string) shareTitle, (string) userName)

Description :

Adds a share to the shares system.
application that the share belongs to.

Parameters:

Type	Name	Documentation
string	shareRoot	The name of the share root, e.g. the
string	shareName	The share's name.
string	shareTitle	The share's human readable title.
string	userName	The share's owner.

removeShare - Removes a share from...

Call: (mixed) removeShare((string) shareRoot, (string) shareName)

Description :

Removes a share from the shares system permanently.
application that the share belongs to.

Parameters:

Type	Name	Documentation
string	shareRoot	The name of the share root, e.g. the
string	shareName	The share's name.

listSharesOfOwner - Returns an array of ...

Call: (array) listSharesOfOwner((string) shareRoot, (string) userName)

Description :

Returns an array of all shares that $userName is the owner of.
application that the share belongs to.

Parameters:

Type	Name	Documentation
string	shareRoot	The name of the share root, e.g. the
string	userName	The share's owner.

listUsersOfShare - Returns a list of us...

Call: (array) listUsersOfShare((string) shareRoot, (string) shareName, (array) permissions)

Description :

Returns a list of users which have have certain permissions on a share.
application that the share belongs to.

Parameters:

Type	Name	Documentation
string	shareRoot	The name of the share root, e.g. the
string	shareName	The share's name.
array	permissions	A list of permissions (show, read, edit, delete).

listGroupsOfShare - Returns a list of gr...

Call: (array) listGroupsOfShare((string) shareRoot, (string) shareName, (array) permissions)

Description :

Returns a list of groups which have have certain permissions on a share.
application that the share belongs to.

Parameters:

Type	Name	Documentation
string	shareRoot	The name of the share root, e.g. the
string	shareName	The share's name.
array	permissions	A list of permissions (show, read, edit, delete).

addUserPermissions - Gives a user certain...

Call: (mixed) addUserPermissions((string) shareRoot, (string) shareName, (string) userName, (array) permissions)

Description :

Gives a user certain privileges for a share.
application that the share belongs to.

Parameters:

Type	Name	Documentation
string	shareRoot	The name of the share root, e.g. the
string	shareName	The share's name.
string	userName	The user's name.
array	permissions	A list of permissions (show, read, edit, delete).

addGroupPermissions - Gives a group certai...

Call: (mixed) addGroupPermissions((string) shareRoot, (string) shareName, (string) groupName, (array) permissions)

Description :

Gives a group certain privileges for a share.
application that the share belongs to.

Parameters:

Type	Name	Documentation
string	shareRoot	The name of the share root, e.g. the
string	shareName	The share's name.
string	groupName	The group's name.
array	permissions	A list of permissions (show, read, edit, delete).

removeUserPermissions - Removes a user from ...

Call: (mixed) removeUserPermissions((string) shareRoot, (string) shareName, (string) userName)

Description :

Removes a user from a share.
application that the share belongs to.

Parameters:

Type	Name	Documentation
string	shareRoot	The name of the share root, e.g. the
string	shareName	The share's name.
string	userName	The user's name.

removeGroupPermissions - Removes a group from...

Call: (mixed) removeGroupPermissions((string) shareRoot, (string) shareName, (string) groupName)

Description :

Removes a group from a share.
application that the share belongs to.

Parameters:

Type	Name	Documentation
string	shareRoot	The name of the share root, e.g. the
string	shareName	The share's name.
string	groupName	The group's name.

listUserPermissions - Returns an array of ...

Call: (array) listUserPermissions((string) shareRoot, (string) shareName, (string) userName)

Description :

Returns an array of all user permissions on a share.
application that the share belongs to.

Parameters:

Type	Name	Documentation
string	shareRoot	The name of the share root, e.g. the
string	shareName	The share's name.
string	userName	The user's name.

listGroupPermissions - Returns an array of ...

Call: (array) listGroupPermissions((string) shareRoot, (string) shareName, (string) groupName)

Description :

Returns an array of all group permissions on a share.
application that the share belongs to.

Parameters:

Type	Name	Documentation
string	shareRoot	The name of the share root, e.g. the
string	shareName	The share's name.
string	groupName	The group's name.