SiteRemote Object

---

 
The SiteRemote object provides information about the SiteRemote plugin.

Members Table

The following table lists the members provided by the SiteRemote object.

Members

Properties	Description
Enabled	If SiteRemote is enabled.
IsRegistered	If SiteRemote is registered.
Name	Name of this plugin.
UserServiceUrl	SiteRemote Server URL.
Methods	Description
AttachBlackboardListener	Adds a listener for a SiteRemote blackboard event.
DetachBlackboardListener	Removes a listener for a SiteRemote blackboard event.
ReadBlackboardAsString	Reads SiteRemote blackboard data.

Remarks

This object is available through the collection Plugins. Use the SiteRemote object to determine if this plugin is enabled.

Note that the path of a file using SiteKiosk objects must be allowed in the
SiteKiosk configuration (Security -> Access -> URL's With Script Permission)
if it is not a browser skin file.

Examples

The following example determines if SiteRemote is enabled and shows it in an alert window.

<SCRIPT TYPE="text/javascript"> window.external.InitScriptInterface(); alert(SiteKiosk.Plugins("SiteRemote").Enabled); </SCRIPT>

Applies to

SiteKiosk v5.0 (and later versions).

---

Back to top