class Cisco::UIExtender

Defined in:

cisco/ui_extender.cr

Constant Summary

IGNORE_METHODS = ["on_load", "on_unload", "on_update"] of ::String

Build a list of all callback methods that have been defined.

Callback methods are denoted being single arity and beginning with on_.

Class Method Summary

Instance Method Summary

Class Method Detail

def self.driver_interface : String #

Instance Method Detail

def alert(text : String, title : String = "", duration : Int32 = 0) #

[View source]
def clear_alert #

[View source]
def clear_extensions #

Clear any deployed UI extensions.


[View source]
def close_panel #

[View source]
def deploy_extensions(id : String, xml_def : String) #

Push a UI definition build with the in-room control editor to the device.


[View source]
def highlight(id : String, state : Bool = true, momentary : Bool = false, time : Int32 = 500) #

Set the highlight state for a button widget.


[View source]
def label(id : String, value : String | Bool | Nil) #

Set the text label used on text or spinner widget.


[View source]
def link_widget(id : String, bindings : Binding) #

Wire up a widget based on a binding target.


[View source]
def list_extensions #

Retrieve the extensions currently loaded.


[View source]
def on_extensions_widget_action(event : Hash(String, JSON::Any)) #

[View source]
def on_load #

[View source]
def on_unload #

[View source]
def on_update(loading = false) #

[View source]
def set(id : String, value : String | Bool | Nil) #

Set the value of a widget.


[View source]
def switch(id : String, state : Bool | Nil = nil) #

Set the state of a switch widget.


[View source]
def sync_widget_state #

Push the current module state to the device.


[View source]
def unset(id : String) #

Clear the value associated with a widget.


[View source]