Start Page>SiteKiosk Object>Plugins Collection>SitePhone Object>State Property


State Property


 
The State property indicates the state of SitePhone plugin.


Syntax 

    [long=] SiteKiosk.Plugins("SitePhone").State
Possible Values 
    Long value that retrieves the plugin state.

    The property is read only.
Remarks
    Possible status flags are:

    S_UNKNOWN = -1;
    S_OFFLINE = 0;
    S_CONNECTING = 1;
    S_PAUSING = 2;
    S_ONLINE = 3;

    If you want to react when this property changed, you can use the OnStateChanged Event.
Examples
    The following example logs the SitePhone state. 

    <SCRIPT TYPE="text/javascript">
window.external.InitScriptInterface();
SitePhone = SiteKiosk.Plugins("SitePhone");
SitePhone.OnStateChanged = OnStateChanged;

var S_OFFLINE = 0;
var S_CONNECTING = 1;
var S_PAUSING = 2;
var S_ONLINE = 3;

function OnStateChanged()
{
   switch (SitePhone.State)
   {
      case S_OFFLINE:
         SiteKiosk.Logfile.Notification("SitePhone is now offline.");
         break;
      case S_CONNECTING:
         SiteKiosk.Logfile.Notification("SitePhone is now connecting.");
         break;
      case S_PAUSING:
         SiteKiosk.Logfile.Notification("SitePhone is now pausing.");
         break;
      case S_ONLINE:
         SiteKiosk.Logfile.Notification("SitePhone is now online.");
         break;
      default:
         SiteKiosk.Logfile.Notification("SitePhone state is unknown.");
   }
}
</SCRIPT>

Applies to
    SiteKiosk v7.0 (and later versions).
Back to top