EventsHelper Class Reference

Events Helper class.
Class instance accessor: When More...

Public Member Functions
EventsHelper	SystemStarted (Func< bool > handler)
	Calls the specified handler after HomeGenie service started.
EventsHelper	SystemStopping (Func< bool > handler)
	Calls the specified handler when HomeGenie service is stopping.
EventsHelper	ProgramStopping (Func< bool > handler)
	Calls the specified handler when the program is beign stopped.
EventsHelper	ModuleParameterChanged (Func< ModuleHelper, ModuleParameter, bool > handler)
	Calls the specified handler function when a parameter of a module changed. If either the handler returns false or changes the event value, the propagation will stop.
EventsHelper	ModuleParameterIsChanging (Func< ModuleHelper, ModuleParameter, bool > handler)
	Calls the specified handler function when a parameter of a module is changing. If either the handler returns false or changes the event value, the propagation will stop.

Detailed Description

Events Helper class.
Class instance accessor: When

Member Function Documentation

SystemStarted()

EventsHelper SystemStarted

(

Func< bool >

handler

)

Calls the specified handler after HomeGenie service started.

Returns

EventsHelper

Parameters

handler

The handler function to call.

Example:

When.SystemStarted( () =>
{
    Program.Say("HomeGenie is now ready!");
    // returning false will prevent this event from being routed to other listeners
    return false;
});

SystemStopping()

EventsHelper SystemStopping

(

Func< bool >

handler

)

Calls the specified handler when HomeGenie service is stopping.

Returns

EventsHelper

Parameters

handler

The handler function to call.

Example:

When.SystemStopping( () =>
{
    Program.Say("See ya soon!");
    // returning true will route this event to other listeners
    return true;
});

ProgramStopping()

EventsHelper ProgramStopping

(

Func< bool >

handler

)

Calls the specified handler when the program is beign stopped.

Returns

EventsHelper

Parameters

handler

The handler function to call.

Example:

When.Stopping( () =>
{
    Program.Say("Oh-oh! I'm quitting!");
    // returning true will route this event to other listeners
    return true;
});

ModuleParameterChanged()

EventsHelper ModuleParameterChanged

(

Func< ModuleHelper, ModuleParameter, bool >

handler

)

Calls the specified handler function when a parameter of a module changed. If either the handler returns false or changes the event value, the propagation will stop.

Returns

EventsHelper

Parameters

handler

The handler function to call.

Example:

When.ModuleParameterChanged( (module, parameter) =>
{
    if (module.Is("Kitchen Motion Sensor") && parameter.Is("Status.Level"))
    {
        // ...
        return false;
    }
    return true;
});

See also

ModuleParameterIsChanging

ModuleParameterIsChanging()

EventsHelper ModuleParameterIsChanging

(

Func< ModuleHelper, ModuleParameter, bool >

handler

)

Calls the specified handler function when a parameter of a module is changing. If either the handler returns false or changes the event value, the propagation will stop.

Returns

EventsHelper

Parameters

handler

The handler function to call.

Example:

When.ModuleParameterIsChanging( (module, parameter) =>
{
    if (module.Is("Kitchen Motion Sensor") && parameter.Is("Status.Level"))
    {
        // ...
        // stop event propagation
        return false;
    }
    // continue event propagation
    return true;
});

See also

ModuleParameterChanged

---

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

• EventsHelper.cs