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 SamepageApi

Samepage.io. 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/KerioWorkspaceApi.php');

$api = new SamepageApi('Sample Application', 'Company Ltd.', '1.0');

try {
    $api->login('samepage.io', 'user@company.tld', 'SecretPassword');
    $api->sendRequest('...');
    $api->logout();
} catch (KerioApiException $error) {
    print $error->getMessage();
}
?>
KerioApi implements KerioApiInterface
Extended by SamepageApi
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 SamepageApi.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 array
# login( string $hostname, string $username, string $password )

Parameters

$hostname
string
Hostname
$username
string
Username
$password
string
Password

Returns

array
Result

Throws

KerioApiException

See

class/KerioApi::login()

Overrides

KerioApi::login
public array
# logout( )

Returns

array
Result

See

class/KerioApi::logout()

Overrides

KerioApi::logout
public string
# getTenant( )

Get tenant.

Get tenant.

Returns

string
public
# setTenant( string $tenantId )

Set tenant.

Set tenant.

Parameters

$tenantId
string
protected string
# getHttpPutRequest( string $data )

Get headers for PUT request.

Get headers for PUT request.

Parameters

$data
string
Request body

Returns

string
Request body

Overrides

KerioApi::getHttpPutRequest
public array
# uploadFile( string $filename, integer $id = null )

Put a file to server.

Put a file to server.

Parameters

$filename
string
Absolute path to file
$id
integer
Reference ID where uploaded file belongs to

Returns

array
Result

Throws

KerioApiException

Overrides

KerioApi::uploadFile

Methods inherited from KerioApi

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

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