Class: OpenHAB::Core::Events::ItemCommandEvent

Inherits:
ItemEvent show all
Defined in:
lib/openhab/core/events/item_command_event.rb

Overview

AbstractEvent sent when an item receives a command.

Instance Attribute Summary collapse

Attributes inherited from ItemEvent

#group, #item

Attributes inherited from AbstractEvent

#attachment, #inputs, #source

Instance Method Summary collapse

Methods inherited from AbstractEvent

#payload

Instance Attribute Details

#commandCommand (readonly)

Returns The command sent to the item.

Returns:

  • (Command)

    The command sent to the item.



14
# File 'lib/openhab/core/events/item_command_event.rb', line 14

alias_method :command, :item_command

Instance Method Details

#decrease?true, false

Check if #command is DECREASE

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 48

#down?true, false

Check if #command is (implicitly convertible to) DOWN

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 32

#fast_forward?true, false

Check if #command is FASTFORWARD

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 64

#increase?true, false

Check if #command is INCREASE

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 44

#inspectString

Returns:

  • (String)


77
78
79
80
81
# File 'lib/openhab/core/events/item_command_event.rb', line 77

def inspect
  s = "#<OpenHAB::Core::Events::ItemCommandEvent item=#{itemName} command=#{command.inspect}"
  s += " source=#{source.inspect}" if source
  "#{s}>"
end

#move?true, false

Check if #command is MOVE

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 40

#next?true, false

Check if #command is NEXT

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 68

#off?true, false

Check if #command is (implicitly convertible to) OFF

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 24

#on?true, false

Check if #command is (implicitly convertible to) ON

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 20

#pause?true, false

Check if #command is PAUSE

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 56

#play?true, false

Check if #command is PLAY

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 52

#previous?true, false

Check if #command is PREVIOUS

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 72

#refresh?true, false

Check if #command is REFRESH

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 16

#rewind?true, false

Check if #command is REWIND

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 60

#stop?true, false

Check if #command is STOP

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 36

#up?true, false

Check if #command is (implicitly convertible to) UP

Returns:

  • (true, false)


# File 'lib/openhab/core/events/item_command_event.rb', line 28