VideoOS.Platform.RuleAction.ActionManager Class Referenceabstract

Manager for plug-ins to specify and execute actions. More...

Public Member Functions

void ExecuteAction (Guid actionId, Collection< FQID > actionItems, BaseEvent sourceEvent)
 Instructs the plug-in to execute an action, which was triggered by the source event.
 
virtual void ExecuteAction2 (Guid actionId, Collection< FQID > actionItems, Collection< FQID > actionItems2, BaseEvent sourceEvent)
 Instructs the plug-in to execute an action, which was triggered by the source event.
 
Collection< ActionDefinitionGetActionDefinitions ()
 Get a collection of actions, which the plug-in can execute.
 

Protected Member Functions

virtual void OnActionConfigurationChanged (EventArgs e)
 Default event execution.
 

Events

EventHandler ActionConfigurationChanged = delegate { }
 Indicate that the action configuration has changed.
 

Detailed Description

Manager for plug-ins to specify and execute actions.

Note: Your assembly must contain an Event Server BackgroundPlugin otherwise your assembly will not be loaded by the Event Server and your ActionManager will not work.

Member Function Documentation

◆ ExecuteAction()

void VideoOS.Platform.RuleAction.ActionManager.ExecuteAction ( Guid actionId,
Collection< FQID > actionItems,
BaseEvent sourceEvent )
abstract

Instructs the plug-in to execute an action, which was triggered by the source event.

Parameters
actionIdRefers to the ActionDefinition.Id
actionItemsThe FQIDs of the first selection, multiple FQIDs is possible when groups was selected.
sourceEventContains information about the event that triggered the rule

◆ ExecuteAction2()

virtual void VideoOS.Platform.RuleAction.ActionManager.ExecuteAction2 ( Guid actionId,
Collection< FQID > actionItems,
Collection< FQID > actionItems2,
BaseEvent sourceEvent )
inlinevirtual

Instructs the plug-in to execute an action, which was triggered by the source event.

Parameters
actionIdRefers to the ActionDefinition.Id
actionItemsThe FQIDs of the first selection, multiple FQIDs is possible when groups was selected.
actionItems2The FQIDs of the second selection, multiple FQIDs is possible when groups was selected.
sourceEventContains information about the event that triggered the rule

◆ GetActionDefinitions()

Collection< ActionDefinition > VideoOS.Platform.RuleAction.ActionManager.GetActionDefinitions ( )
abstract

Get a collection of actions, which the plug-in can execute.

Returns

◆ OnActionConfigurationChanged()

virtual void VideoOS.Platform.RuleAction.ActionManager.OnActionConfigurationChanged ( EventArgs e)
inlineprotectedvirtual

Default event execution.

Parameters
e

Event Documentation

◆ ActionConfigurationChanged

EventHandler VideoOS.Platform.RuleAction.ActionManager.ActionConfigurationChanged = delegate { }

Indicate that the action configuration has changed.