ObscreenInstall

Summary

Create a new slide with specified settings in the Obscreen platform.

Inputs

• slideMode (required) — Select the type of slide: Regular or Notification.
• contentId (required) — Select or specify the content ID to display on the slide.
• playlistId (required) — Select or specify the playlist ID where the slide will be added.
• schedulingStart (required) — Choose the scheduling strategy for the slide start.
• datetimeStart — Set the specific start date and time for scheduling.
• dayStart — Select the start day for scheduling (1 for Monday to 7 for Sunday, applicable for 'inweek' scheduling).
• timeStart — Define the start time for scheduling (format: H:M, applicable for 'inweek' scheduling).
• schedulingEnd — Choose the scheduling strategy for the slide end.
• datetimeEnd — Set the specific end date and time for scheduling.
• dayEnd — Select the end day for scheduling (1 for Monday to 7 for Sunday, applicable for 'inweek' scheduling).
• timeEnd — Define the end time for scheduling (format: H:M, applicable for 'inweek' scheduling).
• durationMode — Select duration mode for the slide: Fixed, Delegate, or Endless.
• duration — Set the duration of the slide in seconds (only if Fixed duration mode is selected).
• enabled — Specify if the slide should be enabled.
• position — Set the position of the slide in the playlist.
• notificationDuration — Set the duration for the notification in seconds if scheduling end is set to duration.
• cronStart — Specify a cron expression for scheduling the notification.

Output shape

a single record

Returns the details of the created slide. Ensure to handle scheduling options carefully based on slide modes.

Examples

Example 1: Create a regular slide

Setting slideMode to 'Regular', providing content and playlist IDs, and defining duration.

Example 2: Create a notification slide

Setting slideMode to 'Notification', scheduling with date & time, and defining end scheduling.