A complete list of the action targets, methods, conditions, and operators supported in Appspace Multizone Signage Channels. Use this reference alongside Configure Signage Channel Actions when you build event-driven behavior into a channel. The Event and Method lists change with the selected Source and Target.
For: IT Administrators — Multizone Signage Channel Action Reference
What’s in this article:
How an Action Is Built
An action combines a source, an event, a target, and a method. Optional conditions restrict when the action runs. The selected source determines which events are available. The selected target determines which methods are available, and the selected method determines which parameters you must supply.
| Part | What You Select |
|---|---|
| Source | The channel, layout, or widget that raises the event. |
| Event | When the action runs. Some events expose condition fields. |
| Target | Where the method runs: System, Channel, Layout, Media Zone, or a widget. |
| Method | What the action does. Method parameter fields change with this selection. |
Note: Channel-level actions are configured on the channel Actions tab. Widget-level actions are configured on that widget's Actions tab in the layout editor and affect only that widget. See Configure Signage Channel Widget Actions.
String and integer method parameters accept literal values. They can also accept event expressions from the selected source event, for example $event.Title or $event.itemId.
Action Targets and Methods
System Methods
| Method | Parameters | Description |
|---|---|---|
| Filter Table Data | Text (FilterKey) | Filters the data displayed by a target widget. |
| Load VE Application | App ID (ApplicationId) | Loads the selected Signage Channel using its ID. |
| Load Custom Application | App Name (InterfaceName) | Loads the selected custom application using its name. |
| Send Network Message | IP, Port, Message, Message2, Message3, Delimiter, Include CR (IncludeCR, optional) | Sends script commands over the network to the device. Include CR appends a carriage return to the message. |
Channel Methods
| Method | Parameters | Description |
|---|---|---|
| Send HTTP Post | Target (target), Data Name (dataname), Data Value (datavalue) | Sends data to a third-party program through an HTTP post. |
| Load Playlist From Info Menu Item | Media Zone ID (MediaZoneId), Info Menu ID (InfoMenuId), Info Menu Item ID (InfoMenuItemId), Asset Type (AssetType) | Loads the media playlist from the specified Media Container item. The method name and parameter names still use the previous Info Menu labels. |
| Set Property | Key, Value | Creates or updates a property that is scoped to the current channel. |
| Reset Properties | None | Clears all current channel properties. |
| Back | None | Returns to the previously loaded layout. |
| Next Layout | None | Goes to the next layout. |
| Previous Layout | None | Goes to the previous layout. |
| Load Layout By Name | Layout Name (LayoutName) | Loads the layout with the specified name. |
| Load Layout | Layout ID (LayoutID), Duration | Loads the selected layout for the specified playout duration. |
| Hide Component | Component ID (ComponentID), Hide (hide), Inverse (inverse, optional) | Hides a widget based on the ID of the widget. Inverse reverses the value and defaults to false. |
| Capture Interactive Metric | Metric Tree Name (MetricName), Metric Object (Object), Extra | Sends an interactive metric to Appspace. Enter Extra values as key and value pairs, for example key1:value1;key2:value2. |
Layout Methods
| Method | Parameters | Description |
|---|---|---|
| Refresh | Layout ID (LayoutID), Delay Start (DelayStart, optional) | Reloads the specified layout. Delay Start is the delay in seconds before the layout starts. |
Media Zone Methods
| Method | Parameters | Description |
|---|---|---|
| Next Media | None | Goes to the next content item in the playlist. |
| Previous Media | None | Returns to the previous content item in the playlist. |
| Replay Media | None | Replays the current content item. |
| Load Media | Offset (offset), Increment (increment) | Loads a content item from the playlist. Offset 0 is the first item. |
| Load Schedule | ID (id) | Loads a scheduled playlist by schedule ID. |
| Load Schedule By Name | Schedule Name (schedulename) | Loads a scheduled playlist by schedule name. |
| Enable Audio | Audio (enabled) | Controls playback of media audio. |
| Set Audio level | Level (level) | Sets the absolute audio volume level. Use numbers 1 to 100. |
| Adjust Audio level | Amount (amount) | Adjusts the current audio volume. Use numbers 1 to 100. |
| Zoom | Position (position), Zoom Amount (zoomamount), Duration (duration) | Magnifies the content. Enter position as X and Y coordinates. Duration is the number of minutes before the content zooms out. |
| Reset Zoom | Duration (duration) | Resets the zoom effect after the specified number of minutes. |
| Rotate Display | Amount (amount) | Rotates the display by the specified angle. |
| Scale Display | Amount (amount) | Scales the display. |
| Execute Content Function | Function Name (functionName), Param 1 to Param 4 (param1 to param4) | Triggers an external function based on the input string and parameters. |
| Load Web Page | Content URL (url), Query String 1 to 4 (key1 to key4), Value 1 to 4 (val1 to val4) | Loads a specific web page using the supplied query strings. |
Note: Load Schedule and Load Schedule By Name act on schedules in a Media Zone playlist. A zone has those schedules only when Enable Playlist Scheduling is turned on for it.
Widget Methods
When the Target is a widget, the Method list is specific to that widget. Clock and Weather have no widget-specific methods. Remote Control and RSS Ticker have events, but no methods. Every widget still inherits the shared events On Freeze, On Unfreeze, and Mouse Click / Touch.
Table Listing
| Method | Parameters |
|---|---|
| Filter Table Data | Text (text), Columns (columns) |
| Query Table Data | Query (query) |
| Load Page | Offset (offset), Increment (increment) |
| Next Page | None |
| Previous Page | None |
Media Container
Previously named InfoMenu. Use these methods when the Target is a Media Container widget.
| Method | Parameters |
|---|---|
| Load Previous Item | None |
| Load Next Item | None |
| Load Parent Item | None |
| Next Page | None |
| Previous Page | None |
| Load Item By ID | Item ID (itemid) |
| Load Item Level | Item ID (itemid) |
| Set Default Asset Type | Asset Type Name (itemid) |
| Load Item Level From Path | Path (path) |
| Load Item From Offset | Offset (offset), Increment (increment) |
| Load Page | Page Number (pagenum) |
Event Calendar
| Method | Parameters |
|---|---|
| Next page | None |
| Previous page | None |
Plain Text
| Method | Parameters |
|---|---|
| Set Text | Text (text) |
| Append Text | Text (text) |
| Replace Text | Text (oldtext), Text (newtext) |
| Update Text From URL | URL (url), XML Query (xmlQuery) |
RSS Viewer
| Method | Parameters |
|---|---|
| Load Item | Offset (offset) |
| Load Source Feed By Name | Source Name (sourceName) |
| Load Source Feed By Index | Source Index (sourceIndex) |
| Next | None |
| Previous | None |
Text Ticker
| Method | Parameters |
|---|---|
| Set Speed | Speed (Speed) |
| Set Direction | Direction (Direction) |
Clock, Weather, RSS Ticker, and Remote Control
These widgets have no widget-specific methods in the Actions Method menu. RSS Ticker and Remote Control still expose widget-specific events. Clock and Weather expose only the shared widget events.
Action Events
An event determines when an action runs. The Event list changes with the Source. Media events expose condition fields that you can use to restrict the action. Widgets also inherit On Freeze, On Unfreeze, and Mouse Click / Touch.
Channel, Layout, and Media Zone Events
| Event | Source | Triggered When | Exposes Condition Fields |
|---|---|---|---|
| On Load | Channel or Layout | The channel or layout loads. Layout On Load also exposes Time Start. | Layout: Time Start. Channel: No. |
| On Unload | Layout | The layout unloads. | Time Start |
| On Click | Channel | The channel is clicked. | No |
| On Timeout | Channel | The channel timeout occurs. | No |
| On Content Up Begin | Channel | Content-up playback begins. | Time Start |
| On Content Up End | Channel | Content-up playback ends. | Time Start |
| End Of Playlist | Media Zone | The media playlist completes its playback duration. | Yes |
| Media Complete | Media Zone | A content item completes its playback duration. | Yes |
| Media Loaded | Media Zone | A content item finishes loading. Also exposes Is First Item and Is Last Item. | Yes |
| Playout Interval | Media Zone | The current play count matches the playout interval. | No |
| On Freeze | Widget | The widget is removed from a layout. | No |
| On Unfreeze | Widget | The widget is added to a layout. | No |
| Mouse Click / Touch | Widget | The widget is clicked, or the designated area of a touch screen is touched. | No |
Widget-Specific Events
These events appear when the Source is the matching widget, in addition to the shared widget events.
| Source | Event | Event Payload Fields |
|---|---|---|
| Table Listing | Item Click / Touch, Row Click / Touch, Column Click / Touch | Name |
| Media Container | Item On Load, Item On Click | Item ID, ID, Item Caption, Caption, Item Text, Text, Tag, Media Tag |
| Media Container | Page Load | Page Offset, Next Page, Previous Page, Is First Page, Is Last Page |
| Event Calendar | Event On Load, Event On Click | Index, Title, Location, Description, Start Date, Start Time, End Date, End Time |
| RSS Viewer | Item Loaded | Item Name, Item Title, Item Image, Item Description |
| RSS Ticker | On Channel load | Channel name |
| Text Ticker | On Ticker Item Available, On Item Loaded | None |
| Plain Text | Text Changed | Text |
| Remote Control | Number 0–9 button on press; Number buttons on press; Command on toggle; plus named control-button events (Info, Help, Show ip, Left, Right, Up, Down, Page down, Page up, Volume down, Volume up, channel down, channel up, blue, red, green, yellow, guide, menu, exit, input, last, rewind, fast forward, skip forward, stop, pause, play, mute, power, enter) | Number buttons on press: Numbers. Command on toggle: Commands. Named buttons: none. |
Condition Fields
Conditions define the requirements that must be met before an action runs. Combine a condition field, an operator, and a value. The available fields change with the selected Source and Event.
| Condition Field | What It Checks |
|---|---|
| Title | The title value available to the action condition. |
| Media Title | The title of the media item. |
| Media File | The media file value. |
| Media Type | The type of media item. |
| Media Description | The media description value. |
| Media Playout Tags Rule | The playout tag rule associated with the media item. |
| Media Index | The media item index in the playlist or zone sequence. |
| Is First Item | Whether the media item is the first item in the playlist. Available on Media Loaded. |
| Is Last Item | Whether the media item is the last item in the playlist. Available on Media Loaded. |
Use Condition Logic to control how multiple conditions are evaluated.
| Condition Logic | Behavior |
|---|---|
| At least one condition is met | The action runs when any one configured condition is true. |
| All conditions are met | The action runs only when every configured condition is true. |
Condition Operators
| Operator | Use To Check Whether the Field |
|---|---|
| equals | Matches the defined value exactly. |
| not equals | Does not match the defined value. |
| is greater than | Is greater than the defined value. |
| is less than | Is less than the defined value. |
| is greater than or equal | Is greater than or equal to the defined value. |
| is less than or equal | Is less than or equal to the defined value. |
| contains | Contains the defined value. |
| does not contain | Does not contain the defined value. |
| starts with | Begins with the defined value. |
| ends with | Ends with the defined value. |