Versions Compared

Key

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

Excerpt

Enables developers to generate a list of timeranges for when a specific dimension scope is available.

The AvailableTimeRanges class enables developers

Use the AvailableTimeRanges class to generate a list of

timeranges

time ranges for when a specific dimension scope is available. This method does not only inspect

Availbility

Availability records, but also existing Reservations that might block a dimension from being booked. It is useful for answering questions like: ‘When can this room be booked?’ or ‘Given these Staff members, who is available when?’. When used for Resources, you can include Services that must be available for the booking.

Methods

Expand
titleB25.AvailableTimeRanges.getTimeRanges

Description

This method takes a dimension scope, a date range, and a prototype Reservation. It will return a list of available time ranges mapped by date and dimension.

Signature

Code Block
global static B25.AvailableTimeRanges.Result getTimeRanges(B25.AvailableTimeRanges.Context context)

Parameters

Code Block
B25.AvailableTimeRanges.Context

An instance of B25.AvailableTimeRanges.Context. This class wraps the input parameters, such as the dimension scope, a date range, and a prototype Reservation.

Return Type

Code Block
B25.AvailableTimeRanges.Result

An instance of B25.AvailableTimeRanges.Result. This contains a list of available time ranges mapped by date and dimension.

...