class PlaceOS::Core::Api::Command
- PlaceOS::Core::Api::Command
- PlaceOS::Core::Api::Application
- ActionController::Base
- Reference
- Object
Defined in:
api/command.crConstant Summary
-
PARSER_LIST =
["application/json"]
-
RESPONDER_LIST =
["application/json"]
Class Method Summary
-
.base_route
Helper for obtaining base route
-
.load(hash_parts : Hash(String | Symbol, Nil | Bool | Int32 | Int64 | Float32 | Float64 | String | Symbol) | Nil = nil, **tuple_parts)
Helper methods for performing redirect_to calls
Instance Method Summary
-
#base_route(*args, **options)
Helper for obtaining base route
-
#base_route(*args, **options, &)
Helper for obtaining base route
-
#execute(module_id : String, user_id : String | Nil = nil) : Nil
Executes a command against a module
-
#load(module_id : String) : Nil
Loads if not already loaded If the module is already running, it will be updated to latest settings.
-
#module_debugger(socket, module_id : String) : Nil
For now a one-to-one debug session to websocket should be fine as it's not a common operation and limited to system administrators
- #module_manager : ModuleManager
- #module_manager=(module_manager : ModuleManager)
- #remote_exception(error) : CommonError
Instance methods inherited from class PlaceOS::Core::Api::Application
bad_media_type(error) : ContentError
bad_media_type,
common_error(error) : CommonError
common_error,
invalid_param(error) : ParameterError
invalid_param,
request_id : String
request_id
Class Method Detail
def self.load(hash_parts : Hash(String | Symbol, Nil | Bool | Int32 | Int64 | Float32 | Float64 | String | Symbol) | Nil = nil, **tuple_parts)
#
Helper methods for performing redirect_to calls
Instance Method Detail
def execute(module_id : String, user_id : String | Nil = nil) : Nil
#
Executes a command against a module
def load(module_id : String) : Nil
#
Loads if not already loaded If the module is already running, it will be updated to latest settings.
def module_debugger(socket, module_id : String) : Nil
#
For now a one-to-one debug session to websocket should be fine as it's not a common operation and limited to system administrators