ToiSchedulerServiceSeries Interface Reference

Description

This is the documentation for ToiSchedulerServiceSeries.

Technical Preview:
This structure is a TECHNICAL PREVIEW, it may change. Structure containing information about an existing series

Use toi.statics.ToiSchedulerServiceSeries.create(<id>, <category>, <activityType>, <start>, <duration>, <weekdays>, <originalNumberOfOccurences>) to create an instance of ToiSchedulerServiceSeries.

import "ToiSchedulerServiceSeries.idl";

List of all members.

Public Attributes

attribute
ToiSchedulerService::TToiSeriesId 		id
attribute string category
attribute string activityType
attribute
ToiSchedulerService::TToiTime 		start
attribute long duration
attribute long weekdays
attribute long originalNumberOfOccurences

Member Data Documentation

attribute string ToiSchedulerServiceSeries::activityType

The activity type.

attribute string ToiSchedulerServiceSeries::category

The category the series belongs to.

attribute long ToiSchedulerServiceSeries::duration

The duration. A value < 0 means no OnScheduledStop will be sent

attribute ToiSchedulerService::TToiSeriesId ToiSchedulerServiceSeries::id

Series identifier.

attribute long ToiSchedulerServiceSeries::originalNumberOfOccurences

The number of occurrences originally scheduled for this recurrent booking. If some occurrences have been removed, the value might not reflect the actual number of bookings connected to this recurrent booking.

attribute ToiSchedulerService::TToiTime ToiSchedulerServiceSeries::start

The start time of the series.

attribute long ToiSchedulerServiceSeries::weekdays

Bit mask indicating which days a recurring booking shall happen.