1 <?php
2 /**
3 * This file is part of the kerio-api-php.
4 *
5 * Copyright (c) Kerio Technologies s.r.o.
6 *
7 * For the full copyright and license information, please view
8 * the file license.txt that was distributed with this source code
9 * or visit Developer Zone. (http://www.kerio.com/developers)
10 *
11 * Do not modify this source code.
12 * Any changes may be overwritten by a new version.
13 */
14
15 /**
16 * Kerio API Interface.
17 *
18 * This interface describes basic methods for Kerio API.
19 *
20 * @copyright Copyright © 2012-2012 Kerio Technologies s.r.o.
21 * @license http://www.kerio.com/developers/license/sdk-agreement
22 * @version 1.4.0.234
23 */
24 interface KerioApiInterface {
25
26 /**
27 * Class constructor.
28 *
29 * @param string
30 * @param string
31 * @param string
32 */
33 public function __construct($name, $vendor, $version);
34
35 /**
36 * Set JSON-RPC settings.
37 *
38 * @param string
39 * @param integer
40 * @param string
41 */
42 public function setJsonRpc($version, $port, $api);
43
44 /**
45 * Send request using method and its params.
46 *
47 * @param string
48 * @param array
49 */
50 public function sendRequest($method, $params = '');
51
52 /**
53 * Login method.
54 *
55 * @param string
56 * @param string
57 * @param string
58 */
59 public function login($hostname, $username, $password);
60
61 /**
62 * Logout method.
63 *
64 * @param void
65 */
66 public function logout();
67 }
68