\Patami\IPS\SystemIPSConnect

IP Symcon Connect Class.

Provides functions to control or to get information about the IP Symcon Connect service.

Summary

Methods
Properties
Constants
GetInstanceId()
IsConnected()
IsHealthy()
GetURL()
No public properties found
STATUS_URL
MODULE_ID
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

STATUS_URL

STATUS_URL

URL of the IPS Connect status web page.

MODULE_ID

MODULE_ID

IPS module GUID of the IPS Connect Control instance.

Methods

GetInstanceId()

GetInstanceId() : integer

Returns the IPS object ID of the IPS Connect Control instance.

Returns

integer —

IPS obejct ID of the IPS Connect Control instance or null if none was found.

IsConnected()

IsConnected() : boolean

Checks if IP Symcon Connect is connected.

Returns

boolean —

True if IP Symcon Connect is connected to the cloud service.

IsHealthy()

IsHealthy() : boolean|null

Checks if the IP Symcon Connect service is healthy according to its status page.

Returns

boolean|null —

True if the IP Symcon Connect service is healthy or null if the status could not be retrieved.

GetURL()

GetURL() : string|null

Returns the IP Symcon Connect host name of the IP Symcon installation.

Returns

string|null —

FQDN of the IP Symcon installation or null if it is not configured.