Difference between revisions of "Code Panel"

Revision as of 12:44, 25 September 2026

It is possible to enter codes (i.e. numbers) with the integrated code panel. These codes can either be processed at the server or plugin level or embedded directly into action strings. This feature is available since version 0.1.0, but was significantly expanded in version 0.1.167.

Usage[edit]

There are various actions for opening the code panel. Depending on the action, the code is then processed further. Please see following action syntax examples.

Action syntax of code actions
Syntax	Example	Since Version	Description
`enter`	`enter`	0.1.167	The entered code is embedded in the indicated action by replacing the keyword `{CODE}` (e.g. `"info:You have entered the code: {col:msx-white}{CODE}"`). The data must contain an `action` property (of type `string`) and can optionally contain an action-related `data` property (of type `object`).
`enter:{CODE}`	`enter:1234`	0.1.0	If the entered code is correct, the indicated action is executed. The data must contain an `action` property (of type `string`) and can optionally contain an action-related `data` property (of type `object`).
`execute:code:{URL}` `execute:code:accurate:{URL}` `execute:code:request:interaction:{DATA_ID}` `execute:code:request:interaction:{DATA_ID}@{URL}` `execute:code:request:player:{DATA_ID}` `execute:code:user:{URL}` `execute:code:user:accurate:{URL}`	`execute:code:http://msx.benzac.de/services/echo.php` `execute:code:accurate:http://msx.benzac.de/services/echo.php` `execute:code:request:interaction:custom_data_id` `execute:code:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html` `execute:code:request:player:custom_data_id` `execute:code:user:http://msx.benzac.de/services/echo.php` `execute:code:user:accurate:http://msx.benzac.de/services/echo.php`	0.1.30	Executes an action on server side, the player, or the interaction plugin with an entered code and returns an action to be executed (e.g. to show a success/error message). Please see Actions#Server Actions for more information.
`interaction:commit:code`	`interaction:commit:code`	0.1.82	Commits a code to the interaction plugin.
`player:commit:code`	`player:commit:code`	0.1.40	Commits a code to the video/audio plugin.

Syntax[edit]

Property syntax of code data object
Property	Type	Default Value	Mandatory	Since Version	Description
`headline`	`string`	`"Enter Code"`	No	0.1.0	The headline of the code panel. This property supports Inline Expressions.
`extension`	`string`	`null`	No	0.1.0	The extension of the code panel. This property can be used to display a small label in the upper right corner. This property supports Inline Expressions and Live Inline Expressions.
`description`	`string`	`null`	No	0.1.167	The description of the code panel. This property supports Inline Expressions. Note: This property is only used if the `digits` property is set.
`value`	`string`	`null`	No	0.1.0	The prefilled value of the code panel. The value must consist only of numbers and must not exceed the maximum length, otherwise, it is ignored.
`placeholder`	`string`	`"Code"`	No	0.1.0	The placeholder value of the code panel. This value is displayed if no code is entered. This property supports Inline Expressions. Note: This property is ignored if the `digits` property is set.
`secret`	`boolean`	`false`	No	0.1.0	Indicates if the code is secret and should not be displayed.
`digits`	`number`	`-1`	No	0.1.167	Specifies if a specific number of digits that should be entered. The value must be between `1` and `8`, otherwise, it is ignored. When using this property, a `description` can also be specified. The confirmation button is omitted when using this property, and there is also no placeholder. The code is processed immediately once all the digits have been entered.
`clear`	`boolean`	`false\|true`	No	0.1.167	Indicates if the code should be cleared when it has been processed. By default, the code is retained if the `digits` property is not used and cleared if the `digits` property is used.
`delay`	`number`	`-1`	No	0.1.167	Specifies a delay in milliseconds after which the entered code should be automatically processed. Note: This property is ignored if the `digits` property is set.
`action`	`string`	`null`	Only if `enter` or `enter:{CODE}` action is used	0.1.0	The code action that is executed if the `enter` or `enter:{CODE}` action is used. Please see Actions for possible values.
`data`	`object`	`null`	No	0.1.0	The additional data of the code action that is used if the action is executed. Please see Actions for possible values.

Example[edit]

Screenshot[edit]

Example Screenshot (Code Panel)

Code[edit]

{
    "type": "list",
    "headline": "Code Panel",
    "template": {
        "enumerate": false,
        "icon": "dialpad",
        "type": "button",
        "layout": "0,0,3,3"
    },
    "items": [{           
            "label": "Default",
            "action": "execute:code:http://msx.benzac.de/services/echo.php"
        }, {
            "label": "Secret",
            "action": "execute:code:http://msx.benzac.de/services/echo.php",
            "data": {
                "headline": "Enter Secret Code",
                "placeholder": "Secret Code",
                "secret": true,
                "clear": true
            }
        }, {           
            "label": "Prefilled + Extension",
            "action": "execute:code:http://msx.benzac.de/services/echo.php",
            "data": {               
                "value": "1234",
                "extension": "Prefilled"
            }
        }, {
            "label": "1 Digit",
            "titleFooter": "0.1.167+{br}{br}{br}",
            "alignment": "center",
            "action": "execute:code:http://msx.benzac.de/services/echo.php",
            "data": {
                "headline": "Enter 1 Digit",
                "digits": 1
            }
        }, {           
            "label": "3 Digits + Decription",
            "titleFooter": "0.1.167+{br}{br}{br}",
            "alignment": "center",
            "action": "execute:code:http://msx.benzac.de/services/echo.php",
            "data": {
                "headline": "Enter 3 Digits",
                "description": "Execution takes place automatically as soon as all digits have been entered.",
                "digits": 3
            }
        }, {           
            "label": "6 Secret Digits",
            "titleFooter": "0.1.167+{br}{br}{br}",
            "alignment": "center",
            "action": "execute:code:http://msx.benzac.de/services/echo.php",
            "data": {
                "headline": "Enter 6 Secret Digits",              
                "digits": 6,
                "secret": true
            }
        }, {         
            "badge": "Enter Action",
            "label": "Switch Channel",
            "titleFooter": "0.1.167+{br}{br}{br}",
            "alignment": "center",
            "action": "enter",
            "data": {
                "headline": "Switch Channel",
                "placeholder": "Channel Number",
                "extension": "Delay: 3 sec",
                "action": "player:goto:number:{CODE}",
                "delay": 3000
            }
        }, {           
            "badge": "Enter Action",
            "label": "Switch Channel",
            "titleFooter": "0.1.167+{br}{br}{br}",
            "alignment": "center",
            "action": "enter",
            "data": {
                "headline": "Switch Channel",
                "description": "Enter the channel number to switch to this channel. Please load a playlist first so that this action can be executed.",               
                "action": "player:goto:number:{CODE}",
                "digits": 4
            }
        }]
}

Demo[edit]

Launch via App: https://msx.benzac.de/?start=menu:https://msx.benzac.de/info/xp/data/hidden_feature_20.json
Launch via Demo Page: https://msx.benzac.de/info/?start=menu:https://msx.benzac.de/info/xp/data/hidden_feature_20.json

@@ Line 106: / Line 106: @@
 '''Note: This property is ignored if the <code>digits</code> property is set.'''
 |-
-| <code>action</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 ||
+| <code>action</code> || <code>string</code> || <code>null</code> || '''Only if <code>enter</code> or <code>enter:{CODE}</code> action is used''' || data-sort-value=0|0.1.0 ||
 The code action that is executed if the <code>enter</code> or <code>enter:{CODE}</code> action is used.
+Please see [[Actions]] for possible values.
 |-
 | <code>data</code> || <code>object</code> || <code>null</code> || No || data-sort-value=0|0.1.0 ||
 The additional data of the code action that is used if the action is executed.
+Please see [[Actions]] for possible values.
 |}