@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerCloneSettingsBag.d.ts

@@ -0,0 +1,57 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The clone settings to indicate how group schedules should be cloned. */
+export type GroupSchedulerCloneSettingsBag = {
+    /** Gets or sets the available destination dates. */
+    availableDestinationDates?: ListItemBag[] | null;
+
+    /** Gets or sets the available groups. */
+    availableGroups?: ListItemBag[] | null;
+
+    /** Gets or sets the available locations. */
+    availableLocations?: ListItemBag[] | null;
+
+    /** Gets or sets the available schedules. */
+    availableSchedules?: ListItemBag[] | null;
+
+    /** Gets or sets the available source dates. */
+    availableSourceDates?: ListItemBag[] | null;
+
+    /** Gets or sets the ISO 8601 selected destination date. */
+    selectedDestinationDate?: string | null;
+
+    /** Gets or sets the selected groups. */
+    selectedGroups?: string[] | null;
+
+    /** Gets or sets the selected locations. */
+    selectedLocations?: string[] | null;
+
+    /** Gets or sets the selected schedules. */
+    selectedSchedules?: string[] | null;
+
+    /** Gets or sets the ISO 8601 selected source date. */
+    selectedSourceDate?: string | null;
+};

package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerFiltersBag.d.ts

@@ -0,0 +1,51 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { GroupSchedulerLocationsBag } from "@Obsidian/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerLocationsBag";
+import { GroupSchedulerSchedulesBag } from "@Obsidian/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerSchedulesBag";
+import { SlidingDateRangeBag } from "@Obsidian/ViewModels/Controls/slidingDateRangeBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The filters to limit what is shown on the Group scheduler. */
+export type GroupSchedulerFiltersBag = {
+    /** Gets or sets the selected date range. */
+    dateRange?: SlidingDateRangeBag | null;
+
+    /** Gets or sets the first "end of week" date, based on the selected date range. */
+    firstEndOfWeekDate?: string | null;
+
+    /** Gets or sets the friendly date range, based on the selected date range. */
+    friendlyDateRange?: string | null;
+
+    /** Gets or sets the selected groups. */
+    groups?: ListItemBag[] | null;
+
+    /** Gets or sets the last "end of week" date, based on the selected date range. */
+    lastEndOfWeekDate?: string | null;
+
+    /** Gets or sets the available and selected locations. */
+    locations?: GroupSchedulerLocationsBag | null;
+
+    /** Gets or sets the available and selected schedules. */
+    schedules?: GroupSchedulerSchedulesBag | null;
+};

package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerGetPreferencesBag.d.ts

@@ -0,0 +1,31 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The information needed to get existing group member scheduling preferences for the group scheduler. */
+export type GroupSchedulerGetPreferencesBag = {
+    /** Gets or sets the attendance identifier. */
+    attendanceId: number;
+
+    /** Gets or sets the group member identifier. */
+    groupMemberId: number;
+};

package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerInitializationBox.d.ts

@@ -0,0 +1,45 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { GroupSchedulerAppliedFiltersBag } from "@Obsidian/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerAppliedFiltersBag";
+
+/** The box that contains all the initialization information for the Group Scheduler block. */
+export type GroupSchedulerInitializationBox = {
+    /** Gets or sets the applied filters, to limit what is shown on the Group Scheduler. */
+    appliedFilters?: GroupSchedulerAppliedFiltersBag | null;
+
+    /** Gets or sets whether to disallow group selection. */
+    disallowGroupSelection: boolean;
+
+    /**
+     * Gets or sets the error message. A non-empty value indicates that
+     * an error is preventing the block from being displayed.
+     */
+    errorMessage?: string | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerLocationsBag.d.ts

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The available and selected locations for the Group Scheduler. */
+export type GroupSchedulerLocationsBag = {
+    /** Gets or sets the available locations. */
+    availableLocations?: ListItemBag[] | null;
+
+    /** Gets or sets the selected locations. */
+    selectedLocations?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerOccurrenceBag.d.ts

@@ -0,0 +1,79 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The information needed to identify a specific occurrence to be scheduled within the Group Scheduler. */
+export type GroupSchedulerOccurrenceBag = {
+    /** Gets or sets the attendance occurrence ID for this occurrence. */
+    attendanceOccurrenceId: number;
+
+    /** Gets or sets the desired capacity for this occurrence. */
+    desiredCapacity?: number | null;
+
+    /** Gets or sets the group ID for this occurrence. */
+    groupId: number;
+
+    /** Gets or sets the group location order for this occurrence. */
+    groupLocationOrder: number;
+
+    /** Gets or sets the group name for this occurrence. */
+    groupName?: string | null;
+
+    /** Gets or sets whether scheduling is enabled for this occurrence. */
+    isSchedulingEnabled: boolean;
+
+    /** Gets or sets the location ID for this occurrence. */
+    locationId: number;
+
+    /** Gets or sets the location name for this occurrence. */
+    locationName?: string | null;
+
+    /** Gets or sets the maximum capacity for this occurrence. */
+    maximumCapacity?: number | null;
+
+    /** Gets or sets the minimum capacity for this occurrence. */
+    minimumCapacity?: number | null;
+
+    /** Gets the occurrence date. */
+    occurrenceDate?: string | null;
+
+    /** Gets or sets the occurrence date and time. */
+    occurrenceDateTime?: string | null;
+
+    /** Gets or sets the parent group ID (if any) for this occurrence. */
+    parentGroupId?: number | null;
+
+    /** Gets or sets the parent group name (if any) for this occurrence. */
+    parentGroupName?: string | null;
+
+    /** Gets or sets the schedule ID for this occurrence. */
+    scheduleId: number;
+
+    /** Gets or sets the schedule name for this occurrence. */
+    scheduleName?: string | null;
+
+    /** Gets or sets the schedule order for this occurrence. */
+    scheduleOrder: number;
+
+    /** Gets or sets the ISO 8601 Sunday date for this occurrence. */
+    sundayDate?: string | null;
+};

package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerPreferenceBag.d.ts

@@ -0,0 +1,31 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The information describing a group member's scheduling preference for the group scheduler. */
+export type GroupSchedulerPreferenceBag = {
+    /** Gets or sets the date this schedule preference should take effect. */
+    scheduleStartDate?: string | null;
+
+    /** Gets or sets the schedule template identifier. */
+    scheduleTemplate?: string | null;
+};

package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerPreferencesBag.d.ts

@@ -0,0 +1,43 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { GroupSchedulerPreferenceBag } from "@Obsidian/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerPreferenceBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The information describing a group member's existing scheduling preferences for the group scheduler. */
+export type GroupSchedulerPreferencesBag = {
+    /** Gets or sets the available schedule templates. */
+    availableScheduleTemplates?: ListItemBag[] | null;
+
+    /** Gets or sets the error message, if any. */
+    errorMessage?: string | null;
+
+    /** Gets or sets friendly descriptions of existing preferences that match the current group, but not the current schedule, if any. */
+    otherPreferencesForGroup?: string[] | null;
+
+    /** Gets or sets the existing preference that matches the current group and schedule, if any. */
+    schedulePreference?: GroupSchedulerPreferenceBag | null;
+
+    /** Gets or sets the warning message, if any. */
+    warningMessage?: string | null;
+};

package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerResourceSettingsBag.d.ts

@@ -0,0 +1,43 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ResourceListSourceType } from "@Obsidian/Enums/Blocks/Group/Scheduling/resourceListSourceType";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The resource settings to indicate how individuals should be selected for assignment within the group scheduler. */
+export type GroupSchedulerResourceSettingsBag = {
+    /** Gets or sets the enabled resource list source types, from which individuals may be scheduled. */
+    enabledResourceListSourceTypes?: ResourceListSourceType[] | null;
+
+    /** Gets or sets the resource alternate group (if any). */
+    resourceAlternateGroup?: ListItemBag | null;
+
+    /** Gets or sets the resource data view (if any). */
+    resourceDataView?: ListItemBag | null;
+
+    /** Gets or sets the selected resource group member filter type. */
+    resourceGroupMemberFilterType: number;
+
+    /** Gets or sets the selected resource list source type. */
+    resourceListSourceType: ResourceListSourceType;
+};

package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerSchedulesBag.d.ts

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The available and selected schedules for the Group Scheduler. */
+export type GroupSchedulerSchedulesBag = {
+    /** Gets or sets the available schedules. */
+    availableSchedules?: ListItemBag[] | null;
+
+    /** Gets or sets the selected schedules. */
+    selectedSchedules?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerSendNowResponseBag.d.ts

@@ -0,0 +1,37 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The outcome of a request to send confirmation communications to scheduled individuals. */
+export type GroupSchedulerSendNowResponseBag = {
+    /** Gets or sets the count of communications sent. */
+    communicationsSentCount: number;
+
+    /** Gets or sets the count of communications to send. */
+    communicationsToSendCount: number;
+
+    /** Gets or sets the errors encountered while attempting to send communications. */
+    errors?: string[] | null;
+
+    /** Gets or sets the warnings encountered while attempting to send communications. */
+    warnings?: string[] | null;
+};

package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerUnassignedResourceCountBag.d.ts

@@ -0,0 +1,48 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * The information about unassigned resource counts (attendance records without a location)
+ * for an occurrence date, schedule and group combo for the group scheduler.
+ */
+export type GroupSchedulerUnassignedResourceCountBag = {
+    /** Gets or sets the attendance occurrence identifier. */
+    attendanceOccurrenceId: number;
+
+    /** Gets or sets the group identifier. */
+    groupId: number;
+
+    /** Gets or sets the unique identifier. */
+    guid?: Guid | null;
+
+    /** Gets or sets the occurrence date. */
+    occurrenceDate?: string | null;
+
+    /** Gets or sets the count of unassigned resources. */
+    resourceCount: number;
+
+    /** Gets or sets the schedule identifier. */
+    scheduleId: number;
+};

package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerUpdatePreferenceBag.d.ts

@@ -0,0 +1,40 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { UpdateSchedulePreferenceMode } from "@Obsidian/Enums/Blocks/Group/Scheduling/updateSchedulePreferenceMode";
+import { GroupSchedulerPreferenceBag } from "@Obsidian/ViewModels/Blocks/Group/Scheduling/GroupScheduler/groupSchedulerPreferenceBag";
+
+/** The information needed to update a group member's scheduling preference for the group scheduler. */
+export type GroupSchedulerUpdatePreferenceBag = {
+    /** Gets or sets the attendance identifier. */
+    attendanceId: number;
+
+    /** Gets or sets the group member identifier. */
+    groupMemberId: number;
+
+    /** Gets or sets the preference that should be applied. */
+    schedulePreference?: GroupSchedulerPreferenceBag | null;
+
+    /** Gets or sets the mode to be used when applying this update. */
+    updateMode: UpdateSchedulePreferenceMode;
+};

package/types/ViewModels/Blocks/Group/landingPageContentBag.d.ts

@@ -0,0 +1,36 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/** A class representing the content we need to pass into mobile. */
+export type LandingPageContentBag = {
+    /** Gets or sets the XAML content. */
+    content?: string | null;
+
+    /** Gets or sets the selected group Guid, only used if SkipPage is true. */
+    groupGuid?: Guid | null;
+
+    /** Gets or sets a boolean representing whether or not to skip the landing page. */
+    skipPage: boolean;
+};