Class RouterService

Index

Constructors

Methods

getServiceName runService verifyConditionsTrue whenActionType whenActionWhen whenCustomBtnID whenDeviceListIdentifier whenEnv whenInputFormID whenParameterExists whenSeries whenUserListIdentifier whenValues whenVariableLike whenVariables whenWidgetExec

Constructors

constructor

new RouterService(service: (...args: any[]) => any): RouterService
Parameters
- service: (...args: any[]) => any
Returns RouterService
- Defined in modules/Utils/router/service.ts:6

Methods

getServiceName

getServiceName(): string
Returns string
- Defined in modules/Utils/router/service.ts:166

runService

runService(router_params: RouterConstructor): any
Parameters
- router_params: RouterConstructor
Returns any
- Defined in modules/Utils/router/service.ts:162

verifyConditionsTrue

verifyConditionsTrue(scope: any, environment: any): boolean
Start verifying if all when conditions are true.
Parameters
- scope: any
- environment: any
Returns boolean
- Defined in modules/Utils/router/service.ts:146

whenActionType

whenActionType(action_type: "condition" | "resource" | "delete"): RouterService
Return true if action_type is the same Information is available if Analysis is triggered by an action.
Parameters
- action_type: "condition" | "resource" | "delete"
Returns RouterService
- Defined in modules/Utils/router/service.ts:129

whenActionWhen

whenActionWhen(
    action_when:
        | "create"
        | "update"
        | "delete"
        | "mqtt_connect"
        | "mqtt_disconnect",
): RouterService
Return true if action_when is the same Information is available if Analysis is triggered by an action.
Parameters
- action_when: "create" | "update" | "delete" | "mqtt_connect" | "mqtt_disconnect"
Returns RouterService
- Defined in modules/Utils/router/service.ts:120

whenCustomBtnID

whenCustomBtnID(btn_id: string): RouterService
Return true if custom btn ID is the same as sent by widget. Information is available if Analysis is triggered by an input widget.
Parameters
- btn_id: string
Returns RouterService
- Defined in modules/Utils/router/service.ts:89

whenDeviceListIdentifier

whenDeviceListIdentifier(btn_id: string): RouterService
Return true if device list identifier ID is the same as sent by widget Information is available if Analysis is triggered by an input widget.
Parameters
- btn_id: string
Returns RouterService
- Defined in modules/Utils/router/service.ts:65

whenEnv

whenEnv(key: string, value: string): RouterService
Return true if input form ID is the same Information is always available.
Parameters
- key: string
- value: string
Returns RouterService
- Defined in modules/Utils/router/service.ts:138

whenInputFormID

whenInputFormID(id: string): RouterService
Return true if input form ID is the same Information is available if Analysis is triggered by an input widget.
Parameters
- id: string
Returns RouterService
- Defined in modules/Utils/router/service.ts:56

whenParameterExists

whenParameterExists(parameter: string): RouterService
Return true if a parameter key exists in the scope array Useful to be used with Device List widget.
Parameters
- parameter: string
Returns RouterService
- Defined in modules/Utils/router/service.ts:102

whenSeries

whenSeries(series: string | string[]): RouterService
Return true if serie is present for any variable in the scope Information is available if Analysis is triggered by an widget or action.
Parameters
- series: string | string[]
Returns RouterService
- Defined in modules/Utils/router/service.ts:46

whenUserListIdentifier

whenUserListIdentifier(btn_id: string): RouterService
Return true if user list identifier ID is the same as sent by widget Information is available if Analysis is triggered by an input widget.
Parameters
- btn_id: string
Returns RouterService
- Defined in modules/Utils/router/service.ts:77

whenValues

whenValues(
values: string | number | boolean | (string | number | boolean)[],
): RouterService
Return true if value is present for any variable in the scope Information is available if Analysis is triggered by an widget or action.
Parameters
- values: string | number | boolean | (string | number | boolean)[]
Returns RouterService
- Defined in modules/Utils/router/service.ts:36

whenVariableLike

whenVariableLike(variable: string): RouterService
Return true if variable is included in any variable name in the scope. Information is available if Analysis is triggered by an widget or action.
Parameters
- variable: string
Returns RouterService
- Defined in modules/Utils/router/service.ts:27

whenVariables

whenVariables(variable: string | string[]): RouterService
Return true if specific variables are in the scope. Information is available if Analysis is triggered by an widget or action.
Parameters
- variable: string | string[]
Returns RouterService
- Defined in modules/Utils/router/service.ts:17

whenWidgetExec

whenWidgetExec(widget_exec: "delete" | "insert" | "edit"): RouterService
Return true if widget_exec is the same Information is available if Analysis is triggered by an widget.
Parameters
- widget_exec: "delete" | "insert" | "edit"
Returns RouterService
- Defined in modules/Utils/router/service.ts:111