Kerio APIs Client Library for PHP 1.4.0.234
  • Namespace
  • Class
  • Tree
  • Deprecated

Namespaces

  • None
  • PHP

Classes

  • KerioApi
  • KerioApiSocket
  • KerioConnectApi
  • KerioControlApi
  • KerioDirectoryApi
  • KerioOperatorApi
  • KerioWorkspaceApi
  • SamepageApi

Interfaces

  • KerioApiInterface
  • KerioApiSocketInterface

Exceptions

  • KerioApiException

Class KerioOperatorApi

Administration API for Kerio Operator. STATUS: In progress, might change in the future

This class implements product-specific methods and properties and currently is under development. Class is not intended for stable use yet. Functionality might not be fully verified, documented, or even supported.

Please note that changes can be made without further notice.

Example:

<?php
require_once(dirname(__FILE__) . '/src/KerioOperatorApi.php');

$api = new KerioOperatorApi('Sample application', 'Company Ltd.', '1.0');

try {
    $api->login('operator.company.tld', 'admin', 'SecretPassword');
    $api->sendRequest('...');
    $api->logout();
} catch (KerioApiException $error) {
    print $error->getMessage();
}
?>
KerioApi implements KerioApiInterface
Extended by KerioOperatorApi
Copyright: Copyright © 2012-2012 Kerio Technologies s.r.o.
License: http://www.kerio.com/developers/license/sdk-agreement
Version: 1.4.0.234
Located at KerioOperatorApi.php

Methods summary

public
# __construct( string $name, string $vendor, string $version )

Class constructor.

Class constructor.

Parameters

$name
string
Application name
$vendor
string
Application vendor
$version
string
Application version

Throws

KerioApiException

Overrides

KerioApi::__construct
public
# setComponentAdmin( )

Set component Web Administration.

Set component Web Administration.

public
# setComponentClient( )

Set component Client aka MyPhone.

Set component Client aka MyPhone.

public
# setComponentMyphone( )

Set component MyPhone.

Set component MyPhone.

Deprecated

public array
# getConstants( )

Get constants defined by product.

Get constants defined by product.

Returns

array
Array of constants

Methods inherited from KerioApi

checkHttpResponse(), clean(), debug(), downloadFile(), getApiVersion(), getApplication(), getCookie(), getDebug(), getFile(), getHttpGetRequest(), getHttpPostRequest(), getHttpPutRequest(), getHttpRequest(), getJsonRpc(), getToken(), login(), logout(), send(), sendRequest(), sendRequestJson(), setCookie(), setDebug(), setHostname(), setJsonRpc(), setTimeout(), setToken(), uploadFile()

Magic methods summary

Constants summary

Constants inherited from KerioApi

CRLF, HTTP_SERVER_OK

Properties summary

protected array $jsonRpc
#

Defines default product-specific JSON-RPC settings

Defines default product-specific JSON-RPC settings

Properties inherited from KerioApi

$application, $cookies, $headers, $hostname, $name, $token, $version

Kerio APIs Client Library for PHP 1.4.0.234 API documentation generated by ApiGen 2.8.0