Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Retrieves the next page of the ScheduledPresentation list associated with a specified Group instance (or ScheduledBrightWallPresnetation list associated with a specified BrightWallGroup instance). The list is sorted by the [DateTime] ExpirationDate of the ScheduledPresentation entity-relations. The returned list will contain no more items than the defined page size.

...

ScheduledPresentation AddScheduledPresentation(int groupId, ScheduledPresentation entity)

Schedules a Presentation instance for a specified Group instance (or a BrightWallPresentation instance for a specified BrightWallGroup instance) and updates related service files in the storage. If successful, this method will return a newly created ScheduledPresentation or ScheduledBrightWallPresentation entity-relation. This method will return Null if an error occurs.

...

Updates the settings of the specified ScheduledPresentation or ScheduledBrightWallPresentation instance and related service files in storage.

...

  • [ScheduledPresentation] entity: A ScheduledPresentation/ScheduledBrightWallPresentation object instance with an initialized instance [int] Id and an updated Presentation/BrightWallPresentation [int] Id and/or [string] Name. The instance must also contain StartTime, Duration, IsRecurrent, EventDate, RecurrenceStartDate, RecurrenceEndDate, and DaysOfWeek properties. All other properties will be ignored. If this parameter is set to Null, then the method will immediately return Null without an Error. A descriptive error will be returned if any of the following conditions occur:
    • The specified ScheduledPresentation/ScheduledBrightWallPresentation [int] Id does not correspond to an existing instance.
    • The specified Presentation/BrightWallPresentation [int] Id or [string] Name does not correspond to an existing instance.
    • The [TimeSpan] StartTime value of the ScheduledPresentation/ScheduledBrightWallPresentation entity-relation is less than “00:00:00” or greater than “24:00:00”.
    • The [TimeSpan] Duration value of the ScheduledPresentation/ScheduledBrightWallPresentation entity-relation is less than “00:00:00” or greater than “24:00:00” minus the [TimeSpan] StartTime.
    • A recurrent schedule does not have Start Time, Duration, or Days of Week values.
    • A recurrent schedule contains a Recurrence Start Date value but not a Recurrence End Date value, or vice-versa.
    • A specified Recurrence Start Date value is greater than the Recurrence End Date value.
    • A non-recurrent schedule does not have Event Date, Start Time, or Duration values.
    • The specified ScheduledPresentation/ScheduledBrightWallPresentation instance conflicts with another Presentation/BrightWallPresentation instance already scheduled for the group.

...

Completely overwrites one or more schedules associated with the specified Group or BrightWallGroup instance and updates related service files in the storage. This method returns True only if it is completely successful. Otherwise, it will return False.

...

  • [int] groupId: The identifier of the Group/BrightWallGroup instance to modify. If the [int] Id does not correspond to an existing Group/BrightWallGroup instance, the method will immediately return False without an error.
  • [ScheduledPresentation[]] entities: A list of ScheduledPresentation instances or ScheduledBrightWallPresentation instances, each containing an initialized [int] Id and/or [string] Name. Each instance should also contain the following properties: StartTime, Duration, IsRecurrent, EventDate, RecurrenceStartDate, RecurrenceEndDate, and DaysofWeek. All other properties will be ignored. If this parameter is set to Null or is passed an empty list, the method will delete all existing presentation entities associated with the specified Group/BrightWallGroup instance. A descriptive error will be returned if any of the following conditions occur:
    • The specified [int] Id or [string] Name does not correspond to an existing Presentation or BrightWallPresentation instance.
    • The ScheduledPresentation instance(s) are specified for a BrightWallGroup instance.
    • The ScheduledBrightWallPresentation instance(s) are scheduled for a BrightWallGroup instance.
    • The [TimeSpan] StartTime value of the ScheduledPresentation or ScheduledBrightWallPresentation entity-relation is less than “00:00:00” or greater than “24:00:00”.
    • The [TimeSpan] Duration value of the ScheduledPresentation or ScheduledBrightWallPresentation entity-relation is less than “00:00:00” or greater than “24:00:00” minus the [TimeSpan] StartTime.
    • A recurrent schedule does not have Start Time, Duration, or Days of Week values.
    • A recurrent schedule contains a Recurrence Start Date value but not a Recurrence End Date value, or vice-versa.
    • A specified Recurrence Start Date value is greater than the Recurrence End Date value.
    • A non-recurrent schedule does not have Event Date, Start Time, or Duration values.
    • The specified ScheduledPresentation/ ScheduledBrightWallPresentation instances conflict with each other.
bool RemoveScheduledPresentation(int scheduledPresentationId)

Deletes the specified ScheduledPresentation or ScheduledBrightWallPresentation instance and updates related service files in the storage. This method returns True only if completely successful. Otherwise, it will return False.

...