public interface ActionManager
Modifier and Type | Method and Description |
---|---|
void |
addJobStatusMessage(PluginContext ctx,
java.lang.String msgName,
java.lang.Object props)
Adds a status message to all running jobs associated with a plugin.
|
AsyncJobHandle |
executeAction(PropertyContainer action)
Executes an action.
|
AsyncJobHandle |
executeActionSet(PropertyContainerSet actionSet)
Executes an action set.
|
ActionClass |
getActionClass(PropertyContainerClassContext ctx)
Returns a published action class.
|
java.util.Collection<ActionClass> |
getActionClasses(DeviceContext ctx,
boolean applyConstraints)
Returns all the action classes published by a device.
|
java.util.Collection<ActionClass> |
getActionClasses(HubContext ctx,
boolean applyConstraints)
Returns all action classes published to the hub.
|
java.util.Collection<ActionClass> |
getActionClasses(PluginContext ctx)
Returns all action classes published by a plugin.
|
PropertyContainerSet |
getActionSet(HubContext ctx,
java.lang.String actionSetId)
Returns a published action set.
|
java.util.Collection<PropertyContainerSet> |
getActionSets(HubContext ctx)
Returns all published action sets.
|
JobInfo |
getJobInfo(HubContext ctx,
java.lang.String jobId)
Returns information about a running job.
|
boolean |
hasActionClass(PropertyContainerClassContext ctx)
Indicates whether an ActionClass has been published.
|
void |
publishActionProvider(ActionProvider actionProvider)
Publishes an action provider.
|
PropertyContainerSet |
publishActionSet(HubContext ctx,
java.lang.String name,
java.util.List<PropertyContainer> actions)
Creates and publishes a new action set.
|
Future |
stopJob(HubContext ctx,
java.lang.String jobId)
Stops a currently active job.
|
void addJobStatusMessage(PluginContext ctx, java.lang.String msgName, java.lang.Object props)
ctx
- the plugin contextmsgName
- the message nameprops
- a property objectAsyncJobHandle executeAction(PropertyContainer action)
action
- the action's property containerAsyncJobHandle executeActionSet(PropertyContainerSet actionSet)
actionSet
- the property container setActionClass getActionClass(PropertyContainerClassContext ctx)
ctx
- the property container class contextjava.util.Collection<ActionClass> getActionClasses(PluginContext ctx)
ctx
- the plugin contextjava.util.Collection<ActionClass> getActionClasses(HubContext ctx, boolean applyConstraints)
ctx
- the context of the hub that published the action classesapplyConstraints
- only return condition classes for which the constraints of their typed properties can be
met by the currently available system services (i.e. don't show the user things they
can't do)java.util.Collection<ActionClass> getActionClasses(DeviceContext ctx, boolean applyConstraints)
ctx
- the context of the device that published the action classesapplyConstraints
- only return condition classes for which the constraints of their typed properties can be
met by the currently available system services (i.e. don't show the user things they
can't do)PropertyContainerSet getActionSet(HubContext ctx, java.lang.String actionSetId)
ctx
- the context of the action setactionSetId
- the action set IDjava.util.Collection<PropertyContainerSet> getActionSets(HubContext ctx)
ctx
- the context of the hub that published the action setsJobInfo getJobInfo(HubContext ctx, java.lang.String jobId)
ctx
- the hub contextjobId
- the job IDboolean hasActionClass(PropertyContainerClassContext ctx)
ctx
- the property container class contextvoid publishActionProvider(ActionProvider actionProvider)
actionProvider
- the action provider to publishPropertyContainerSet publishActionSet(HubContext ctx, java.lang.String name, java.util.List<PropertyContainer> actions)
ctx
- the context of the hub publishing the action setname
- the name of the action setactions
- the actions to include in the setFuture stopJob(HubContext ctx, java.lang.String jobId)
ctx
- the hub contextjobId
- the job IDCopyright © 2015 Whizzo Software LLC. All rights reserved.