GHASys Methods |
[This is preliminary documentation and is subject to change.]
The GHASys type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | AddTimer |
Creates a simple timer object under Modules/GHATimers node in the hierarchy. Timer is NOT started after creation.
Set the Enabled property to true to activate the timer
|
| CreateAlert(AlertInfo) |
Creates and publishes an alert
|
| CreateAlert(DateTime, String, String, String, String) |
Creates and publishes an alert
|
| FireMessageCallback |
Initiates a message callback. Receiving end should pop a message box or take some sort of action to
let the user know this event has happened
|
| GetDevices |
Returns the Devices root object in the GHA hierarchy
|
| GetHome |
Returns the Home object in the GHA hierarchy
|
| GetMedia |
Returns the Media root object in the GHA hierarchy
|
| GetModules |
Returns the Module root object in the GHA hierarchy
|
| GetMonitoring |
Returns the Monitor root object in the GHA hierarchy
|
| GetScenes |
Returns the Scenes root object in the GHA hierarchy
|
| GetSchedules |
Returns the Schedule root object in the GHA hierarchy
|
| IsDark |
Helper method to access Nighttime status
|
| IsLight |
Helper method to access Daylight status
|
| RemoveTimer |
Removes the timer with the specified name
|
| SendCommand |
Sends the provided string using the command device. The command device is assumed to implement either
the IInfraredOutput or ISerialPort capabilities
|
| SendSMTPMessage(SMTPWorkItemBase) |
Queues an SMTP message
|
| SendSMTPMessage(String, String, String, String, String) |
Queues an SMTP message
|
| SendSMTPMessage(String, String, String, String, String, String, String) |
Queues an SMTP message
|
| Speak(String) |
Initiate text to speech operation that will render on the default audio device of the GHA server
|
| Speak(String, ITTSStream) |
Initiates text to speech operation that will render on the specified device
|
| Speak(String, ITTSText) |
Initiates text to speech operation that will render on the specified device
|
See Also