Actions - Revision history

Benzac at 18:28, 11 April 2024

2024-04-11T18:28:26Z

Benzac at 11:23, 12 May 2023

2023-05-12T11:23:39Z

Benzac at 11:59, 6 September 2022

2022-09-06T11:59:08Z

Benzac: /* Extended Actions */

2022-06-08T16:48:46Z

Extended Actions

Benzac: /* Extended Actions */

2022-03-28T10:31:46Z

Extended Actions

Benzac: /* Extended Actions */

2022-03-28T10:29:56Z

Extended Actions

Benzac: /* Extended Actions */

2022-03-28T10:29:16Z

Extended Actions

Benzac: /* Extended Actions */

2022-03-28T10:26:45Z

Extended Actions

Benzac: /* Extended Actions */

2022-01-05T14:34:38Z

Extended Actions

Benzac: /* Extended Actions */

2022-01-05T14:34:05Z

Extended Actions

@@ Line 359: / Line 359: @@
 * <code>progress</code>
 * <code>progressColor</code>
 * <code>wrapperColor</code>
 * <code>image</code>

@@ Line 60: / Line 60: @@
 Starts a playlist without a corresponding content page. The playlist data must be provided as <code>data</code> property by the corresponding content item.
 The data structure is the same like the '''Templated Items''' from the '''Content API'''. Please see [[Content Root Object]] for more information.
 |-
 | <code>slideshow:{URL}</code>
@@ Line 76: / Line 78: @@
 Starts a slideshow without a corresponding content page. The playlist data must be provided as <code>data</code> property by the corresponding content item.
 The data structure is the same like the '''Templated Items''' from the '''Content API'''. Please see [[Content Root Object]] for more information.
 |-
 | <code>menu:{URL}</code>
@@ Line 92: / Line 96: @@
 Shows a menu. The menu data must be provided as <code>data</code> property by the corresponding content item.
 Please see [[Menu Root Object]] for the data structure.
 |-
 | <code>content:{URL}</code>
@@ Line 108: / Line 114: @@
 Shows a content page. The content data must be provided as <code>data</code> property by the corresponding content item.
 Please see [[Content Root Object]] for the data structure.
 |-
 | <code>panel:{URL}</code>
@@ Line 124: / Line 132: @@
 Shows a content page in a panel. The content data must be provided as <code>data</code> property by the corresponding content item.
 Please see [[Content Root Object]] for the data structure.
 |-
 | <code>success:{TEXT}</code>

@@ Line 19: / Line 19: @@
 | data-sort-value=0|0.1.0
 ||
-Plays an audio file. The <code>{URL}</code> part must be replaced with the audio URL. This action works in the same way as <code>video:{URL}</code>, except that the video screen is not displayed. Instead, the background screen is displayed. If the corresponding content item provides a <code>background</code> property, it is used, otherwise the next available <code>background</code> property (at higher level) is used.
+Plays an audio. The <code>{URL}</code> part must be replaced with the audio URL. This action works in the same way as <code>video:{URL}</code>, except that the video screen is not displayed. Instead, the background screen is displayed. If the corresponding content item provides a <code>background</code> property, it is used, otherwise the next available <code>background</code> property (at higher level) is used.
 |-
 | <code>image:{URL}</code>
@@ Line 183: / Line 183: @@
 | data-sort-value=40|'''0.1.40'''
 ||
-Plays a plugin audio file. The <code>{URL}</code> part must be replaced with the plugin URL. This action works in the same way as <code>video:plugin:{URL}</code>, except that the video screen is not displayed. Instead, the background screen is displayed. If the corresponding content item provides a <code>background</code> property, it is used, otherwise the next available <code>background</code> property (at higher level) is used.
+Plays a plugin audio. The <code>{URL}</code> part must be replaced with the plugin URL. This action works in the same way as <code>video:plugin:{URL}</code>, except that the video screen is not displayed. Instead, the background screen is displayed. If the corresponding content item provides a <code>background</code> property, it is used, otherwise the next available <code>background</code> property (at higher level) is used.
 Please see the [[YouTube, Vimeo & Co.]] for plugin examples.
 |}

@@ Line 345: / Line 345: @@
 * <code>badge</code>
 * <code>badgeColor</code>
 * <code>progress</code>
 * <code>progressColor</code>

@@ Line 401: / Line 401: @@
 | data-sort-value=58|'''0.1.58'''
 ||
-If an action starts with the character <code>[</code> and ends with the character <code>]</code>, you can use the character <code>{{pipe}}</code> to execute multiple actions in a row. The <code>{ACTION}</code> part must be replaced with any action. If the corresponding content item provides a <code>data</code> property, it is used for each action. If you want to use the <code>{{pipe}}</code> character within an action, please use the <code>{pipe}</code> keyword (e.g. <code>[reload:content{{pipe}}info:P{pipe}I{pipe}P{pipe}E]</code>). By the way, this syntax can also be used to perform a NOP (no operation) action by indicating an empty list (i.e. <code>[]</code>).
+If an action starts with the character <code>[</code> and ends with the character <code>]</code>, you can use the character <code>{{pipe}}</code> to execute multiple actions in a row. The <code>{ACTION}</code> part must be replaced with any action. If the corresponding content item provides a <code>data</code> property, it is used for each action. If you want to use the <code>{{pipe}}</code> character within an action, please use the <code>{pipe}</code> keyword (e.g. <code>[reload:content{{pipe}}info:[P{pipe}I{pipe}P{pipe}E]]</code>). By the way, this syntax can also be used to perform a NOP (no operation) action by indicating an empty list (i.e. <code>[]</code>).
 '''Note: If you use actions like <code>video:{URL}</code> or <code>audio:{URL}</code> with this syntax, the corresponding content item properties (i.e. <code>playerLabel</code>, <code>background</code>, and <code>properties</code>) must be indicated in the action-related <code>data</code> property in order to be used.'''
 |}

@@ Line 306: / Line 306: @@
 Reloads the current panel content data.
-'''Note: The panel content data can only be reloaded if it has not been set via a data action. Since version 0.1.144, you can also replace (and reload) the panel content data that has been set via a data action by using the <code>replace:panel:{CONTENT_FLAG}:{REQUEST_ACTION}</code> action.'''
+'''Note: The panel content data can only be reloaded if it has not been set via a data action. Since version 0.1.144, you can replace (and reload) the panel content data that has been set via a data action by using the <code>replace:panel:{CONTENT_FLAG}:{REQUEST_ACTION}</code> action.'''
 |-
 | <code>update:menu:{ID}</code>

@@ Line 290: / Line 290: @@
 || Reloads the current menu data.
-'''Note: The menu data can only be reloaded if it has not been loaded at startup or set via a data action. Since version 0.1.134, you can reload the menu data that has been loaded at startup by using the <code>reference</code> property. Since version 0.1.144, you can also replace (and reload) the menu data that has been loaded at startup by using the <code>replace:menu:{CONTENT_FLAG}:{REQUEST_ACTION}</code> action.'''
+'''Note: The menu data can only be reloaded if it has not been loaded at startup or set via a data action. Since version 0.1.134, you can reload the menu data that has been loaded at startup by using the <code>reference</code> property. Since version 0.1.144, you can also replace (and reload) the menu data that has been loaded at startup or set via a data action by using the <code>replace:menu:{CONTENT_FLAG}:{REQUEST_ACTION}</code> action.'''
 |-
 | <code>reload:content</code>
@@ Line 298: / Line 298: @@
 Reloads the current content data.
-'''Note: The content data can only be reloaded if it has not been loaded at startup or set via a data action. Since version 0.1.134, you can reload the content data that has been loaded at startup by using the <code>reference</code> property. Since version 0.1.144, you can also replace (and reload) the content data that has been loaded at startup by using the <code>replace:content:{CONTENT_FLAG}:{REQUEST_ACTION}</code> action.'''
+'''Note: The content data can only be reloaded if it has not been loaded at startup or set via a data action. Since version 0.1.134, you can reload the content data that has been loaded at startup by using the <code>reference</code> property. Since version 0.1.144, you can also replace (and reload) the content data that has been loaded at startup or set via a data action by using the <code>replace:content:{CONTENT_FLAG}:{REQUEST_ACTION}</code> action.'''
 |-
 | <code>reload:panel</code>
@@ Line 306: / Line 306: @@
 Reloads the current panel content data.
-'''Note: The panel content data can only be reloaded if it has not been set via a data action.'''
+'''Note: The panel content data can only be reloaded if it has not been set via a data action. Since version 0.1.144, you can also replace (and reload) the panel content data that has been set via a data action by using the <code>replace:panel:{CONTENT_FLAG}:{REQUEST_ACTION}</code> action.'''
 |-
 | <code>update:menu:{ID}</code>