Syntax

C#
public class HarmonyAPI
Visual Basic (Declaration)
Public Class HarmonyAPI
Visual C++
public ref class HarmonyAPI

The type exposes the following members.

Public Constructors

  NameDescription
Public methodHarmonyAPIHarmonyAPINew

Public Methods

  NameDescription
Public methodAction_CreateNew
Public methodAction_Delete
Public methodAction_Execute
Public methodAction_Reorder
Public methodAction_Update
Public methodCategory_CreateNew
Public methodCategory_Delete
Public methodCategory_Rename
Public methodCategory_TurnOff
Public methodCategory_TurnOn
Public methodCategory_UpdateMembers
Public methodComponent_RaiseRawValueEvent
Public methodComponent_Reset
Public methodComponentContext_CreateNew
Public methodComponentContext_RaiseEvent
Public methodConnect
Connects to Harmony Core Service (should be the first command called after creating object)
Public methodDevice_CreateNew
Public methodDevice_Delete
Public methodDevice_Rename
Public methodDevice_RequestIcon
Public methodDevice_RequestIconList
Public methodDevice_SaveIcon
Public methodDevice_SetDimLevel
Public methodDevice_TurnOff
Public methodDevice_TurnOn
Public methodDevice_Update
Public methodDeviceProperty_CreateNew
Public methodDeviceProperty_Update
Public methodDeviceType_Register
Public methodDeviceTypeContext_CreateNew
Public methodDeviceTypeContext_RaiseEvent
Public methodDeviceTypeEvent_CreateNew
Public methodDeviceTypeEvent_RaiseEvent
Public methodDeviceTypeMethod_CreateNew
Public methodDisposeOverloaded.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGroup_AddMember
Public methodGroup_CreateNew
Public methodGroup_Delete
Public methodGroup_Rename
Public methodGroup_TurnOff
Public methodGroup_TurnOn
Public methodGroup_UpdateMembers
Public methodHmnyEvent_ComponentTriggered_CreateNew
Public methodHmnyEvent_ComponentTriggered_Update
Public methodHmnyEvent_DateTimeTriggered_CreateNew
Public methodHmnyEvent_DateTimeTriggered_Update
Public methodHmnyEvent_Delete
Public methodHmnyEvent_DeviceTriggered_CreateNew
Public methodHmnyEvent_DeviceTriggered_Update
Public methodHmnyEvent_Execute
Public methodHmnyEvent_GetCurrentSchedulesAsXML
Public methodHmnyEvent_ManualTriggered_CreateNew
Public methodHmnyEvent_ManualTriggered_Update
Public methodHmnyEvent_Rename
Public methodHmnySettings_Update
Public methodLegacyHAPISend
Sends a legacy HAPI string to the server for parsing
Public methodPrereq_CreateNew_DateRange
Public methodPrereq_CreateNew_DayOfWeek
Public methodPrereq_CreateNew_DeviceState
Public methodPrereq_CreateNew_TimeRange
Public methodPrereq_Delete
Public methodPrereq_Update_DateRange
Public methodPrereq_Update_DayOfWeek
Public methodPrereq_Update_DeviceState
Public methodPrereq_Update_TimeRange
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodXML_RequestLecacyXML
Requests Harmony Core to generate legacy XML stream for use with web server
Public methodZone_CreateNew
Public methodZone_Delete
Public methodZone_Rename
Public methodZone_TurnOff
Public methodZone_TurnOn
Public methodZone_UpdateMembers

Protected Methods

  NameDescription
Protected methodFinalize (Overrides Object..::Finalize()().)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)

Protected Fields

  NameDescription
Protected fieldDisableMsgQueueProcess

Public Properties

  NameDescription
Public propertyActions
A collection of all existing actions from Harmony Core
Public propertyCategories
A collection of all existing Categories from Harmony Core
Public propertyComponentContexts
A collection of all existing Component Contexts from Harmony Core
Public propertyComponents
A collection of all existing components from Harmony Core
Public propertyDeviceProperties
A collection of all existing device properties from Harmony Core
Public propertyDevices
A collection of all existing devices from Harmony Core
Public propertyDeviceTypeContexts
A collection of all existing devicetype Contexts from Harmony Core
Public propertyDeviceTypeEvents
A collection of all existing devicetype events from Harmony Core
Public propertyDeviceTypeMethods
A collection of all existing devicetype methods from Harmony Core
Public propertyDeviceTypes
A collection of all existing device types from Harmony Core
Public propertyGroups
A collection of all existing groups from Harmony Core
Public propertyHmnyEvents
A collection of all existing events from Harmony Core
Public propertyPrereqs
A collection of all existing prereqs from Harmony Core
Public propertyProtocols
A collection of all existing protocols from Harmony Core
Public propertySettings
A collection of all settings from Harmony Core
Public propertyVersion_HarmonyAPI
The version of the current HarmonyAPI build
Public propertyVersion_HarmonyCore
The version of the current Harmony core build
Public propertyVersionName_HarmonyCore
The version name of the current Harmony core build
Public propertyZones
A collection of all existing zones and subzones from Harmony Core

Public Events

  NameDescription
Public eventActionAdded
Raised when a new action is added to Harmony Core
Public eventActionDeleted
Raised when an action is deleted
Public eventActionReordered
Raised when an action is reorderd
Public eventActionUpdated
Raised when an action is updated
Public eventCategoryAdded
Raised when a new category is added to Harmony Core
Public eventCategoryDeleted
Raised when a category is deleted from Harmony Core
Public eventCategoryMembersUpdated
Raised when a Category has its members updated
Public eventCategoryRenamed
Raised when a category is renamed
Public eventComponentAdded
Raised when a new component has been added to Harmony Core
Public eventComponentConnected
Raised when a component connects to Harmony Core
Public eventComponentContextAdded
Raised when a new Component Context is added to Harmony Core
Public eventComponentContextEventRaised
Raised when a Component Context is clicked
Public eventComponentDisconnected
Raised when a component disconnects from Harmony Core
Public eventComponentRawExecutionRequest
Raised when a component needs to execute a raw value
Public eventComponentRawValue
Raised when a component reports a raw value
Public eventComponentReset
Raised when a new component been requested to reset
Public eventConnectionTaskProgress
Raised when a connection task has been completed
Public eventDeviceAdded
Raised when a new device is added to Harmony Core
Public eventDeviceDeleted
Raised when a device is deleted
Public eventDeviceDimLevelChanged
Raised when a device has its dim level changed
Public eventDeviceIconListReceived
Raised when a requested icon list is delivered back the API
Public eventDeviceIconReceived
Raised when a requested icon is delivered back the API
Public eventDeviceIconSaved
Raised when icon has been sent to the server and saved
Public eventDevicePropertyAdded
Raised when a new device property is added to Harmony Core
Public eventDevicePropertyUpdated
Raised when a device property has been updated
Public eventDeviceRenamed
Raised when a device is renamed
Public eventDeviceTurnedOff
Raised when a device is turned off
Public eventDeviceTurnedOn
Raised when a device is turned on
Public eventDeviceTypeAdded
Raised when a new device type as been added to Harmony Core
Public eventDeviceTypeCanTurnOnorOffChanged
Raised when a device type has had its switchable status changed
Public eventDeviceTypeContextAdded
Raised when a new devicetype Context is added to Harmony Core
Public eventDeviceTypeContextEventRaised
Raised when a devicetype Context is clicked
Public eventDeviceTypeEventAdded
Raised when a new devicetype event is added to Harmony Core
Public eventDeviceTypeIsDimmableChanged
Raised when a device type has had its dimmable status changed
Public eventDeviceTypeIsMomentaryChanged
Raised when a device type has had its momentary status changed
Public eventDeviceTypeMethodAdded
Raised when a new devicetype method is added to Harmony Core
Public eventDeviceTypeMethodExecutionRequest
Raised when a devicetype Context is clicked
Public eventDeviceUpdated
Raised when a device has been updated
Public eventGroupAdded
Raised when a new group is added to Harmony Core
Public eventGroupDeleted
Raised when a group is deleted from Harmony Core
Public eventGroupMemberAdded
Raised when a new group memeber is added to a group in Harmony Core
Public eventGroupMembersUpdated
Raised when a group has its members updated
Public eventGroupRenamed
Raised when a group is renamed
Public eventHAPIConnected
Raised when HarmonyAPI has successfully connected and registered with Harmony core
Public eventHAPIDisconnected
Raised when HarmonyAPI has been disconnected from Harmony core
Public eventHAPIError
Raised when an error occurs in either Harmony Core or HarmonyAPI
Public eventHarmonyWarning
Raised when a warning is flagged up in the core
Public eventHmnyEventAdded
Raised when a new event is added to Harmony Core
Public eventHmnyEventDeleted
Raised when an event in harmony is deleted
Public eventHmnyEventRenamed
Raised when an event in harmony is renamed
Public eventHmnyEventScheduleXMLReceived
Raised when the requested schedules are returned as XML
Public eventHmnyEventUpdated
Raised when an event has been updated
Public eventHmnySettingsUpdated
Raised when settings are updated
Public eventPrereqAdded
Raised when a new prereq is added to Harmony Core
Public eventPrereqDeleted
Raised when an prereq is deleted
Public eventPrereqUpdated
Raised when a prereq is updated
Public eventRequestedLegacyXML
Raised when Harmony Core returns the legacy xml for use with the web server
Public eventTrialWarning
Raised when a trial limit is reached in the core
Public eventZoneAdded
Raised when a new zone is added to Harmony Core
Public eventZoneDeleted
Raised when a zone is deleted from Harmony Core
Public eventZoneMembersUpdated
Raised when a Zone has its members updated
Public eventZoneRenamed
Raised when a zone is renamed

Explicit Interface Implementations

  NameDescription
Explicit interface implemetationPrivate propertyHAPI_Socket

See Also

Domia Namespace