@rockrms/obsidian-framework 1.16.9-rc.1 → 17.0.43

package/types/ViewModels/Blocks/Lms/LearningClassAnnouncementDetail/LearningClassAnnouncementDetailOptionsBag.d.ts

@@ -0,0 +1,28 @@
+//------------------------------------------------------------------------------
+// <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 additional configuration options for the Learning Class Announcement Detail block. */
+export type LearningClassAnnouncementDetailOptionsBag = {
+    /** Gets or sets the character limit for the configured SMS medium. */
+    smsCharacterLimit: number;
+};

package/types/ViewModels/Blocks/Lms/LearningClassAnnouncementDetail/learningClassAnnouncementBag.d.ts

@@ -0,0 +1,52 @@
+//------------------------------------------------------------------------------
+// <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 { CommunicationMode } from "@Obsidian/Enums/Lms/communicationMode";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The item details for the Learning Class Announcement Detail block. */
+export type LearningClassAnnouncementBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the communication mode for the announcement. */
+    communicationMode: CommunicationMode;
+
+    /** Gets or sets whether the announcement has been sent. */
+    communicationSent: boolean;
+
+    /** Gets or sets the main content of the announcement. */
+    description?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the date and time the announcement will be published. */
+    publishDateTime?: string | null;
+
+    /** Gets or sets the title of the announcement. */
+    title?: string | null;
+};

package/types/ViewModels/Blocks/Lms/LearningClassContentPageDetail/LearningClassContentPageDetailOptionsBag.d.ts

@@ -0,0 +1,26 @@
+//------------------------------------------------------------------------------
+// <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 additional configuration options for the Learning Class Content Page Detail block. */
+export type LearningClassContentPageDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Lms/LearningClassContentPageDetail/learningClassContentPageBag.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 { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The item details for the Learning Class Announcement Detail block. */
+export type LearningClassContentPageBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the main content of the page. */
+    content?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the LearningClassId that this content relates to. */
+    learningClassId: number;
+
+    /** Gets or sets the date and time the page will be available. */
+    startDateTime?: string | null;
+
+    /** Gets or sets the title of the page. */
+    title?: string | null;
+};

package/types/ViewModels/Blocks/Lms/LearningClassDetail/learningClassBag.d.ts

@@ -0,0 +1,87 @@
+//------------------------------------------------------------------------------
+// <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 { LearningClassFacilitatorBag } from "@Obsidian/ViewModels/Blocks/Lms/LearningClassDetail/learningClassFacilitatorBag";
+import { LearningClassLocationBag } from "@Obsidian/ViewModels/Blocks/Lms/LearningClassDetail/learningClassLocationBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The item details for the Learning Class Detail block. */
+export type LearningClassBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the Rock.Model.Campus that this Group is associated with. */
+    campus?: ListItemBag | null;
+
+    /** Gets or sets the related LearningCourse code. */
+    courseCode?: string | null;
+
+    /** Gets or sets the related LearningCourse name. */
+    courseName?: string | null;
+
+    /** Gets or sets the default LearningGradingSystem defined by the LearningProgram. */
+    defaultGradingSystem?: ListItemBag | null;
+
+    /** Gets or sets the optional description of the group. */
+    description?: string | null;
+
+    /** Gets or sets the list of facilitators for this learning class. */
+    facilitators?: LearningClassFacilitatorBag[] | null;
+
+    /** Gets or sets the related LearningGradingSystem. */
+    gradingSystem?: ListItemBag | null;
+
+    /** Gets or sets the GroupCapacity (maximum allowed students override). */
+    groupCapacity?: number | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this is an active group. This value is required. */
+    isActive: boolean;
+
+    /** Gets or sets a value indicating whether the group should be shown in group finders */
+    isPublic: boolean;
+
+    /** Gets or Sets the Location that is associated with the LearningClass. */
+    location?: LearningClassLocationBag | null;
+
+    /** Gets or sets the Name of the Group. This property is required. */
+    name?: string | null;
+
+    /** Gets or sets the Rock.Model.Schedule. */
+    schedule?: ListItemBag | null;
+
+    /** Gets or sets the related Rock.Model.LearningSemester. */
+    semester?: ListItemBag | null;
+
+    /** Gets or sets the number of students in the class. */
+    studentCount: number;
+
+    /** Gets or sets whether this class takes attendance. */
+    takesAttendance: boolean;
+};

package/types/ViewModels/Blocks/Lms/LearningClassDetail/learningClassDetailOptionsBag.d.ts

@@ -0,0 +1,49 @@
+//------------------------------------------------------------------------------
+// <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 { ConfigurationMode } from "@Obsidian/Enums/Lms/configurationMode";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The additional configuration options for the Learning Class Detail block. */
+export type LearningClassDetailOptionsBag = {
+    /** Gets or sets the number of active classes using the default grading system. */
+    activeClassesUsingDefaultGradingSystem: number;
+
+    /** Gets or sets whether the current person is authorized to view grades. */
+    canViewGrades: boolean;
+
+    /** Gets or sets whether the course has announcements enabled. */
+    courseAllowsAnnouncements: boolean;
+
+    /** Gets or sets the available grading systems. */
+    gradingSystems?: ListItemBag[] | null;
+
+    /** Gets or sets the related Rock.Model.LearningProgram's configuration mode. */
+    programConfigurationMode?: ConfigurationMode | null;
+
+    /** Gets or sets the available semesters for this course. */
+    semesters?: ListItemBag[] | null;
+
+    /** Gets or sets the character limit of the SMS medium. */
+    smsMediumCharacterLimit: number;
+};

package/types/ViewModels/Blocks/Lms/LearningClassDetail/learningClassFacilitatorBag.d.ts

@@ -0,0 +1,49 @@
+//------------------------------------------------------------------------------
+// <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";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The facilitator details for the Learning Class Detail block. */
+export type LearningClassFacilitatorBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the facilitator list item. */
+    facilitator?: ListItemBag | null;
+
+    /** Gets or sets the email for the facilitator. */
+    facilitatorEmail?: string | null;
+
+    /** Gets or sets the facilitator name. */
+    facilitatorName?: string | null;
+
+    /** Gets or sets the facilitator role. */
+    facilitatorRole?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+};

package/types/ViewModels/Blocks/Lms/LearningClassDetail/learningClassLocationBag.d.ts

@@ -0,0 +1,32 @@
+//------------------------------------------------------------------------------
+// <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 { AddressControlBag } from "@Obsidian/ViewModels/Controls/addressControlBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Represents one of two possible kinds of locations for the Learning Class Detail block. */
+export type LearningClassLocationBag = {
+    address?: AddressControlBag | null;
+
+    namedLocation?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Lms/LearningClassList/learningClassListOptionsBag.d.ts

@@ -0,0 +1,39 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+export type LearningClassListOptionsBag = {
+    /** Gets or sets whether the block has a valid course parameter. */
+    hasValidCourse: boolean;
+
+    /** Gets or sets whether the course column is shown. */
+    showCourseColumn: boolean;
+
+    /** Gets or sets whether the location column is shown. */
+    showLocationColumn: boolean;
+
+    /** Gets or sets whether the schedule column is shown. */
+    showScheduleColumn: boolean;
+
+    /** Gets or sets whether the semester column is shown. */
+    showSemesterColumn: boolean;
+};

package/types/ViewModels/Blocks/Lms/LearningCourseDetail/learningCourseBag.d.ts

@@ -0,0 +1,101 @@
+//------------------------------------------------------------------------------
+// <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 { LearningCourseRequirementBag } from "@Obsidian/ViewModels/Blocks/Lms/LearningCourseRequirement/learningCourseRequirementBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** A bag containing Learning Course information. */
+export type LearningCourseBag = {
+    /** Indicates whether or not this course allows students to access after completion. */
+    allowHistoricalAccess: boolean;
+
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the Rock.Model.LearningCourse.Category for the LearningCourse. */
+    category?: ListItemBag | null;
+
+    /** Gets or sets the Rock.Model.Category highlight color. */
+    categoryColor?: string | null;
+
+    /** Gets or sets the Rock.Model.WorkflowType of the LearningCourse. */
+    completionWorkflowType?: ListItemBag | null;
+
+    /** Gets or sets the code for the course. */
+    courseCode?: string | null;
+
+    /** Gets or sets the course requirements for this course. */
+    courseRequirements?: LearningCourseRequirementBag[] | null;
+
+    /** Gets or sets the number of credits awarded for successful completion of the course. */
+    credits: number;
+
+    /** Gets or sets the IdKey of the default learning class for the course. */
+    defaultLearningClassIdKey?: string | null;
+
+    /** Gets or sets the description of the course. */
+    description?: string | null;
+
+    /** Gets or sets the description of the course as HTML. */
+    descriptionAsHtml?: string | null;
+
+    /** Indicates whether or not this course allows announcements. */
+    enableAnnouncements: boolean;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the ImageBinaryFile for the LearningCourse. */
+    imageBinaryFile?: ListItemBag | null;
+
+    /** Gets or sets a value indicating whether this course is active. */
+    isActive: boolean;
+
+    /**
+     * Indicates whether or not this course should 
+     * be displayed in public contexts (e.g. on a public site).
+     */
+    isPublic: boolean;
+
+    /** Gets or sets the number of students at which to stop accepting enrollments. */
+    maxStudents?: number | null;
+
+    /** Gets or sets the name of the course. */
+    name?: string | null;
+
+    /** Gets or sets the color of the highlight for the the learning program. */
+    programHighlightColor?: string | null;
+
+    /** Gets or sets the icon CSS class for the the learning program. */
+    programIconCssClass?: string | null;
+
+    /** Gets or sets the public name of the course. */
+    publicName?: string | null;
+
+    /** Gets or sets the summary text of the course. */
+    summary?: string | null;
+};

package/types/ViewModels/Blocks/Lms/LearningCourseDetail/learningCourseDetailOptionsBag.d.ts

@@ -0,0 +1,30 @@
+//------------------------------------------------------------------------------
+// <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 { ConfigurationMode } from "@Obsidian/Enums/Lms/configurationMode";
+
+/** The additional configuration options for the Learning Course Detail block. */
+export type LearningCourseDetailOptionsBag = {
+    /** Gets or sets the configuration mode of the course's learning program. */
+    configurationMode: ConfigurationMode;
+};

package/types/ViewModels/Blocks/Lms/LearningCourseDetail/learningCourseRequirementBag.d.ts

@@ -0,0 +1,44 @@
+//------------------------------------------------------------------------------
+// <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 { RequirementType } from "@Obsidian/Enums/Lms/requirementType";
+
+export type LearningCourseRequirementBag = {
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the id key of the course with requirements. */
+    learningCourseIdKey?: string | null;
+
+    /** Gets or sets the course code of the course that's required. */
+    requiredLearningCourseCode?: string | null;
+
+    /** Gets or sets the id key of the course that's required. */
+    requiredLearningCourseIdKey?: string | null;
+
+    /** Gets or sets the name of the course that's required. */
+    requiredLearningCourseName?: string | null;
+
+    /** Gets or sets the requirement type. */
+    requirementType: RequirementType;
+};

package/types/ViewModels/Blocks/Lms/LearningCourseList/learningCourseListOptionsBag.d.ts

@@ -0,0 +1,26 @@
+//------------------------------------------------------------------------------
+// <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 additional configuration options for the Learning Course List block. */
+export type LearningCourseListOptionsBag = {
+};