Scheduled Presentation Entity (2022/06)

Owned by BrightSign TechDocs
Last updated: Nov 17, 2023
2 min read

The scheduled presentation entity is structured as follows:

entity:

  • Id int read-only: A unique identifier for the scheduled presentation instance

  • PresentationId int read-write: The identifier for the scheduled presentation instance

  • PresentationName string read-write: The name of the scheduled presentation instance

  • IsRecurrent bool read-write: A flag indicating whether the scheduled playback recurs every week

  • EventDate Nullable<DateTime> read-write: Specifies the date when a non-recurrent presentation should begin playing. This value is null for recurring presentations. See DateTime for more information about this data type.

  • StartTime TimeSpan read-write: The time of day when playback begins. See TimeSpan for more information about this data type.

  • Duration TimeSpan read-write: The duration of the playback window. See TimeSpan for more information about this data type.

  • RecurrenceStartDate Nullable<DateTime> read-write: A timestamp indicating when recurring playback begins. If this value is null, then recurring playback begins immediately when scheduled. See DateTime for more information about this data type.

  • RecurrenceEndDate Nullable<DateTime> read-write: A timestamp indicating when recurring playback ends. If this value is null, then recurring playback will not end. See DateTime for more information about this data type.

  • DaysOfWeek DayOfWeek read-write: The days of the week during which the recurring schedule is active. See DayOfWeek for more information about this data type.

  • CreationDate DateTime read-only: A timestamp indicating when the ScheduledPresentation instance was created on BSN.cloud. See DateTime for more information about this data type.

  • LastModifiedDate DateTime read-only: A timestamp indicating when the ScheduledPresentation instance was last modified on BSN.cloud. See DateTime for more information about this data type.

  • ExpirationDate Nullable<DateTime> read-only: A timestamp indicating when the scheduled presentation instance will expire. If this value is null, then the instance will never expire. See DateTime for more information about this data type.

  • InterruptScheduling bool read-write: Whether or not the presentation can be interrupted. You can use this to schedule a presentation to interrupt a regular presentation at a specific time, but that interrupting presentation can not itself be interrupted.