NextDom\Rest\ScenarioRest

Class ScenarioRest

Synopsis

class ScenarioRest {

• // members
• private static string $NO_GROUP_CODE = 'no-group';
• // methods
• public static void getAll()
• private static array prepareResults()
• public static void getAllByGroup()
• private static array prepareResultsOrderedByGroup()
• public static bool launch()
• public static bool enable()
• private static bool changeScenarioActiveState()
• public static bool disable()
• public static bool stop()
}


Members

private

• $NO_GROUP_CODE
  Default name of group when scenario doesn't have group

Methods

private

• changeScenarioActiveState() — Disable scenario
• prepareResults() — Prepare result for response
• prepareResultsOrderedByGroup() — Prepare result for response\n Associative array by group with following keys : - id - name - displayIcon

public

• disable() — Disable scenario
• enable() — Enable scenario
• getAll() — Get all scenarios
• getAllByGroup() — Get all scenarios ordered by group
• launch() — Launch scenario
• stop() — Stop scenario