DispatchMessageAction dispatches a message of specified type to a specified target. More...

#include <kanzi/ui/action/dispatch_message_action.hpp>

Inheritance diagram for kanzi::DispatchMessageAction:

Public Types
enum	DispatchMode { DispatchModeNode , DispatchModeSend , DispatchModePost }
	Dispatch mode type. More...

Public Types inherited from kanzi::ForwardingAction
typedef BindingContainer::const_iterator	BindingConstIterator

typedef map< AbstractPropertyType, BindingEntry >	BindingContainer

typedef BindingRuntimeContainer::const_iterator	BindingRuntimeConstIterator

typedef map< AbstractPropertyType, BindingRuntimeEntry >	BindingRuntimeContainer

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Static Public Member Functions
static auto	create (Domain *domain, string_view name)
	Creates an instance of DispatchMessageAction.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Provides the Kanzi Studio editor metadata for the DispatchMessageAction.

Static Public Member Functions inherited from kanzi::Action
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Provides the Kanzi Studio editor metadata for the SetPropertyAction.

Static Public Member Functions inherited from kanzi::ActionBase
static ActionBaseSharedPtr	loadAction (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser)
	Loads an ActionBase from a kzb file.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Provides the Kanzi Studio editor metadata for the ActionBase.

template<typename TAction >
static shared_ptr< TAction >	loadAction (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser)
	Loads an TAction from a kzb file.

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Protected Member Functions
ActionSharedPtr	clone () const override
	Action::clone() implementation.

BindingTargetRuntimePtr	createTriggerBindingTargetRuntime (string_view targetPath, AbstractPropertyType targetArgument, PropertyField targetField) override
	ForwardingAction::createManualBindingTarget() implementation.

	DispatchMessageAction (Domain *domain, string_view name)
	Constructor.

void	onAttach () override
	Action::onAttach() implementation.

void	onCopy (const DispatchMessageAction &other)
	Called when the action is being copied.

void	onDelayedInvoke () override
	Action::onDelayedInvoke() implementation.

void	onInvoke () override
	Action::onInvoke() implementation.

void	onPrepareDelayedInvoke () override
	Action::onPrepareDelayedInvoke() implementation.

Protected Member Functions inherited from kanzi::ForwardingAction
void	applyResourceBindings (string_view path)
	Sets all resource bindings to their respective target items, if possible.

void	attachMessageToSourceRuntimes ()
	Updates a message on message binding source runtimes.

void	attachTriggerToLookUpContexts ()
	Updates triggers on binding trigger look-up contexts.

	ForwardingAction (Domain *domain, string_view name)
	Constructor.

Variant	getArgument (AbstractPropertyType argumentType)
	Gets the value of the argument with given property type in the forwarded message of associated trigger.

void	load (KzbFile &kzbFile, KzbMemoryParser &parser) override
	Action::load() implementation.

void	loadBinding (KzbFile &kzbFile, KzbMemoryParser &parser)
	Loads a binding object from a kzb file.

void	onAttach () override
	Action::onAttach() implementation.

void	onCopy (const ForwardingAction &other)
	Must be called by deriving classes on new instances created inside implementations of clone().

void	onInvoke () override
	Action::onInvoke() implementation.

void	onPrepareDelayedInvoke () override
	Action::onPrepareDelayedInvoke() implementation.

void	removeAllBindings ()
	Removes all binding objects from an action.

void	removeBinding (AbstractBindingRuntimeSharedPtr bindingRuntime)
	Removes a binding object from an action.

void	removeBinding (AbstractPropertyType argumentType)
	Removes a binding object from an action.

Protected Member Functions inherited from kanzi::Action
	Action (Domain *domain, string_view name)
	Constructor.

virtual void	onUnprepareDelayedInvoke ()
	Kanzi calls this callback when an action is invoked by trigger with delay, after onDelayedInvoke() callback, or when it cancels a delayed execution.

Protected Member Functions inherited from kanzi::ActionBase
	ActionBase (Domain *domain, string_view name)
	Constructor.

virtual void	onDetach ()
	Overridable method called during detach.

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source.

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source.

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Properties
static PropertyType< string >	MessageTypeProperty
	Sets the name of the message type for the dispatched message.

static PropertyType< DispatchMessageAction::DispatchMode >	DispatchModeProperty
	DispatchMode property.

static PropertyType< string >	RoutingTargetProperty
	Sets a relative path in the node tree for looking up the target of a dispatched message.

static PropertyType< string >	RoutingTargetLookupProperty
	Sets the name of a property type on the item targeted by the RoutingTargetProperty.

string	getMessageType () const
	Gets the value of the MessageTypeProperty.

void	setMessageType (string value)
	Sets the value of the MessageTypeProperty.

DispatchMessageAction::DispatchMode	getDispatchMode () const
	Gets the value of DispatchModeProperty.

void	setDispatchMode (DispatchMessageAction::DispatchMode value)
	Sets the value of DispatchModeProperty.

string	getRoutingTarget () const
	Gets the value of RoutingTargetProperty.

void	setRoutingTarget (string value)
	Sets the value of RoutingTargetProperty.

string	getRoutingTargetLookup () const
	Returns the value of the RoutingTargetLookupProperty.

void	setRoutingTargetLookup (string value)
	Sets the value of the RoutingTargetLookupProperty.

Additional Inherited Members
Public Member Functions inherited from kanzi::ForwardingAction
ManualBindingRuntimeSharedPtr	addArgumentBinding (AbstractPropertyType sourceArgument, AbstractPropertyType targetArgument)
	Adds a binding from message argument to a node or a message argument.

ManualBindingRuntimeSharedPtr	addArgumentBinding (AbstractPropertyType sourceArgument, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField)
	Adds a binding from message argument to a node or a message argument.

ManualBindingRuntimeSharedPtr	addBinding (string_view targetPath, AbstractPropertyType targetArgument, PropertyField targetField, ManualBindingSharedPtr binding)
	Adds an arbitrary binding object to an action.

ManualBindingRuntimeSharedPtr	addPropertyBinding (AbstractPropertyType sourcePropertyType, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField)
	Adds a binding from property to a node or a message argument.

ManualBindingRuntimeSharedPtr	addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, AbstractPropertyType targetArgument)
	Adds a binding from property to a node or a message argument.

ManualBindingRuntimeSharedPtr	addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField)
	Adds a binding from property to a node or a message argument.

ManualBindingRuntimeSharedPtr	addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, PropertyField sourceField, string_view targetObjectPath, AbstractPropertyType targetArgument, PropertyField targetField)
	Adds a binding from property to a node or a message argument.

void	addResourceBinding (ResourceID id, AbstractPropertyType targetArgument)
	Adds a binding from resource ID to a property.

void	addResourceBinding (ResourceID id, AbstractPropertyType targetArgument, PropertyField targetField)
	Adds a binding from resource ID to a property field.

void	addResourceBinding (string_view id, AbstractPropertyType targetArgument)
	Adds a binding from resource ID to an object property.

void	addResourceBinding (string_view id, AbstractPropertyType targetArgument, PropertyField targetField)
	Adds a binding from resource ID to a property field.

ManualBindingRuntimeSharedPtr	addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument)
	Adds a binding from value to a node or a message argument.

ManualBindingRuntimeSharedPtr	addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument, PropertyField targetField)
	Adds a binding from a value to a node or a message argument.

BindingRuntimeConstIterator	beginBindingRuntimes () const
	Returns a const iterator pointing to the first binding runtimes.

BindingConstIterator	beginBindings () const
	Returns a const iterator pointing to the first bindings.

BindingRuntimeConstIterator	endBindingRuntimes () const
	Returns a const iterator pointing to the end of binding runtimes.

BindingConstIterator	endBindings () const
	Returns a const iterator pointing to the end of bindings.

Public Member Functions inherited from kanzi::Action
void	attach (Trigger *trigger)
	Attaches an Action to a Trigger.

ActionSharedPtr	copy () const

void	detach ()
	Detaches the Action from the Trigger.

Trigger *	getTrigger () const
	Returns the pointer to a Trigger to which an Action is attached.

void	invoke ()
	Invokes the Action.

chrono::milliseconds	getDelay () const
	Returns the delay in milliseconds that Kanzi waits before it invokes an action.

void	setDelay (chrono::milliseconds delay)
	Sets the delay in milliseconds that Kanzi waits before it invokes an action.

Public Member Functions inherited from kanzi::ActionBase
string	getName () const
	Returns the name of the action.

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.

void	applyObjectStyles ()
	Apply all styles for an object node.

Domain *	getDomain () const
	Returns the domain the object belongs to.

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it.

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications.

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property.

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

virtual	~PropertyObject ()

Static Public Attributes inherited from kanzi::Action
static PropertyType< int >	DelayProperty
	Delays all invocations of an action by the amount in milliseconds.

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

Protected Attributes inherited from kanzi::ForwardingAction
BindingRuntimeContainer	m_bindingRuntimes
	Runtimes for binding rules to execute on invoke.

BindingContainer	m_resourceBindings
	Resource bindings to set to target object on invoke.

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Detailed Description

DispatchMessageAction dispatches a message of specified type to a specified target.

You set the message type with the MessageTypeProperty and the target with the RoutingTargetProperty and the RoutingTargetLookupProperty.

Examples

To create and configure a DispatchMessageAction instance:

        // Create an instance of DispatchMessageAction.
        auto action = DispatchMessageAction::create(domain, "action");
 
        // Set the type of dispatched message.
        action->setMessageType(MyMessageType.getName());
 
        // Set the path to target, here parent of the trigger host node.
        action->setRoutingTarget("../");
 
        // Use bindings to set the argument of the dispatched message.
 
        // MyPropertyA to fixed value 1.
        action->addValueBinding(Variant(1), MyPropertyA);
 
        // MyPropertyB to MyPropertyB of the triggering message.
        action->addArgumentBinding(MyPropertyB, MyPropertyB);
 
        // MyPropertyC to MyPropertyC of the trigger host node.
        action->addPropertyBinding(".", MyPropertyC, MyPropertyC);
 
        // Add the action to the trigger.
        trigger->addAction(action);

Member Enumeration Documentation

◆ DispatchMode

enum kanzi::DispatchMessageAction::DispatchMode

Dispatch mode type.

Deprecated: In Kanzi 3.5. All messages are delivered immediately, and DispatchMode property has no effect.

Enumerator
DispatchModeNode
DispatchModeSend
DispatchModePost

Constructor & Destructor Documentation

◆ DispatchMessageAction()

kanzi::DispatchMessageAction::DispatchMessageAction	(	Domain *	domain,
		string_view	name )

explicitprotected

Constructor.

Parameters

domain	Pointer to domain.
name	Name for the instance.

Member Function Documentation

◆ getMessageType()

string kanzi::DispatchMessageAction::getMessageType ( ) const

inline

Gets the value of the MessageTypeProperty.

Returns: The value of the MessageTypeProperty.

See also: setMessageType()

◆ setMessageType()

void kanzi::DispatchMessageAction::setMessageType ( string value )

inline

Sets the value of the MessageTypeProperty.

Parameters

value A value for the MessageTypeProperty.

See also: getMessageType()

◆ getDispatchMode()

DispatchMessageAction::DispatchMode kanzi::DispatchMessageAction::getDispatchMode ( ) const

inline

Gets the value of DispatchModeProperty.

Deprecated: In Kanzi 3.5. All messages are delivered immediately, and DispatchModeProperty has no effect.

Returns: The value of the DispatchModeProperty.

See also: setDispatchMode()

◆ setDispatchMode()

void kanzi::DispatchMessageAction::setDispatchMode ( DispatchMessageAction::DispatchMode value )

inline

Sets the value of DispatchModeProperty.

Deprecated: In Kanzi 3.5. All messages are delivered immediately, and DispatchModeProperty has no effect.

Parameters

value A value for the DispatchModeProperty.

See also: getDispatchMode()

◆ getRoutingTarget()

string kanzi::DispatchMessageAction::getRoutingTarget ( ) const

inline

Gets the value of RoutingTargetProperty.

Returns: The value of the RoutingTargetProperty.

See also: setRoutingTarget()

◆ setRoutingTarget()

void kanzi::DispatchMessageAction::setRoutingTarget ( string value )

inline

Sets the value of RoutingTargetProperty.

Parameters

value A value for the RoutingTargetProperty.

See also: getRoutingTarget()

◆ getRoutingTargetLookup()

string kanzi::DispatchMessageAction::getRoutingTargetLookup ( ) const

inline

Returns the value of the RoutingTargetLookupProperty.

Returns: The value of the RoutingTargetLookupProperty.

See also: setRoutingTargetLookup()

◆ setRoutingTargetLookup()

void kanzi::DispatchMessageAction::setRoutingTargetLookup ( string value )

inline

Sets the value of the RoutingTargetLookupProperty.

Parameters

value A value for the RoutingTargetLookupProperty.

See also: getRoutingTargetLookup()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::DispatchMessageAction::makeEditorInfo ( )

static

Provides the Kanzi Studio editor metadata for the DispatchMessageAction.

Returns: Shared pointer to the created PropertyTypeEditorInfo instance.

◆ create()

static auto kanzi::DispatchMessageAction::create	(	Domain *	domain,
		string_view	name )

inlinestatic

Creates an instance of DispatchMessageAction.

Parameters

domain	Pointer to domain.
name	Name for the instance.

Returns: Shared pointer to created DispatchMessageAction instance.

◆ onAttach()

void kanzi::DispatchMessageAction::onAttach ( )

overrideprotectedvirtual

Action::onAttach() implementation.

Reimplemented from kanzi::ActionBase.

◆ onInvoke()

void kanzi::DispatchMessageAction::onInvoke ( )

overrideprotectedvirtual

Action::onInvoke() implementation.

Reimplemented from kanzi::Action.

◆ onPrepareDelayedInvoke()

void kanzi::DispatchMessageAction::onPrepareDelayedInvoke ( )

overrideprotectedvirtual

Action::onPrepareDelayedInvoke() implementation.

Reimplemented from kanzi::Action.

◆ onDelayedInvoke()

void kanzi::DispatchMessageAction::onDelayedInvoke ( )

overrideprotectedvirtual

Action::onDelayedInvoke() implementation.

Reimplemented from kanzi::Action.

◆ clone()

ActionSharedPtr kanzi::DispatchMessageAction::clone ( ) const

overrideprotectedvirtual

Action::clone() implementation.

Implements kanzi::Action.

◆ createTriggerBindingTargetRuntime()

BindingTargetRuntimePtr kanzi::DispatchMessageAction::createTriggerBindingTargetRuntime	(	string_view	targetPath,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField )

overrideprotectedvirtual

ForwardingAction::createManualBindingTarget() implementation.

Reimplemented from kanzi::ForwardingAction.

◆ onCopy()

void kanzi::DispatchMessageAction::onCopy ( const DispatchMessageAction & other )

protected

Called when the action is being copied.

Parameters

other Source action to copy from.

Member Data Documentation

◆ MessageTypeProperty

PropertyType<string> kanzi::DispatchMessageAction::MessageTypeProperty

static

Sets the name of the message type for the dispatched message.

The default value is "".

See also: setMessageType(), getMessageType()

◆ DispatchModeProperty

PropertyType<DispatchMessageAction::DispatchMode> kanzi::DispatchMessageAction::DispatchModeProperty

static

DispatchMode property.

Deprecated: In Kanzi 3.5. All messages are delivered immediately, and DispatchModeProperty has no effect. The default value is DispatchMessageAction::DispatchModePost.

See also: setDispatchMode(), getDispatchMode()

◆ RoutingTargetProperty

PropertyType<string> kanzi::DispatchMessageAction::RoutingTargetProperty

static

Sets a relative path in the node tree for looking up the target of a dispatched message.

The default value is ".".

See also: setRoutingTarget(), getRoutingTarget()

◆ RoutingTargetLookupProperty

PropertyType<string> kanzi::DispatchMessageAction::RoutingTargetLookupProperty

static

Sets the name of a property type on the item targeted by the RoutingTargetProperty.

If set, Kanzi uses the value of this property as a path for looking up the target of the dispatched message. If not set, Kanzi dispatches the message to the item targeted by the RoutingTargetProperty. The default value is "".

See also: setRoutingTargetLookup(), getRoutingTargetLookup()

The documentation for this class was generated from the following file:

kanzi/ui/action/dispatch_message_action.hpp

Public Types

Static Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Examples

Member Enumeration Documentation

◆ DispatchMode

Constructor & Destructor Documentation

◆ DispatchMessageAction()

Member Function Documentation

◆ getMessageType()

◆ setMessageType()

◆ getDispatchMode()

◆ setDispatchMode()

◆ getRoutingTarget()

◆ setRoutingTarget()

◆ getRoutingTargetLookup()

◆ setRoutingTargetLookup()

◆ makeEditorInfo()

◆ create()

◆ onAttach()

◆ onInvoke()

◆ onPrepareDelayedInvoke()

◆ onDelayedInvoke()

◆ clone()

◆ createTriggerBindingTargetRuntime()

◆ onCopy()

Member Data Documentation

◆ MessageTypeProperty

◆ DispatchModeProperty

◆ RoutingTargetProperty

◆ RoutingTargetLookupProperty