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

package/types/ViewModels/Blocks/Lms/LearningCourseRequirement/learningCourseRequirementBag.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 { RequirementType } from "@Obsidian/Enums/Lms/requirementType";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** A bag containing Learning Course Requirement information. */
+export type LearningCourseRequirementBag = {
+    /** 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 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/LearningGradingSystemDetail/learningGradingSystemBag.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 { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The item details for the Learning Grading System Detail block. */
+export type LearningGradingSystemBag = {
+    /** 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 description of the grading system. */
+    description?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets a value indicating whether this grading system is active. */
+    isActive: boolean;
+
+    /** Gets or sets the name of the grading system. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Lms/LearningGradingSystemDetail/learningGradingSystemDetailOptionsBag.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 Grading System Detail block. */
+export type LearningGradingSystemDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Lms/LearningGradingSystemList/learningGradingSystemListOptionsBag.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 Grading System List block. */
+export type LearningGradingSystemListOptionsBag = {
+};

package/types/ViewModels/Blocks/Lms/LearningGradingSystemScaleDetail/learningGradingSystemScaleBag.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 { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The item details for the Learning Grading System Scale Detail block. */
+export type LearningGradingSystemScaleBag = {
+    /** 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 description of the grading system scale. */
+    description?: string | null;
+
+    /** Gets or sets the highlight color of the grading system scale. */
+    highlightColor?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets a value indicating whether this grading system scale is considered passing. */
+    isPassing: boolean;
+
+    /** Gets or sets the name of the grading system scale. */
+    name?: string | null;
+
+    /** Gets or sets the minimum threshold percentage of the grading system scale. */
+    thresholdPercentage: number;
+};

package/types/ViewModels/Blocks/Lms/LearningGradingSystemScaleDetail/learningGradingSystemScaleDetailOptionsBag.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 Grading System Scale Detail block. */
+export type LearningGradingSystemScaleDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Lms/LearningGradingSystemScaleList/learningGradingSystemScaleListOptionsBag.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 Grading System Scale List block. */
+export type LearningGradingSystemScaleListOptionsBag = {
+    /** Gets or sets the IdKey of the LearningGradingSystem for the current page. */
+    learningGradingSystemIdKey?: string | null;
+};

package/types/ViewModels/Blocks/Lms/LearningParticipantDetail/learningParticipantBag.d.ts

@@ -0,0 +1,69 @@
+//------------------------------------------------------------------------------
+// <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";
+
+export type LearningParticipantBag = {
+    /**
+     * Gets or sets the number of absences for this participant in this class.
+     * If the Class doesn't take attendance null will be returned.
+     */
+    absences?: number | null;
+
+    /** Gets or sets the label style for the students absences in the class. */
+    absencesLabelStyle?: string | null;
+
+    /** 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 grade percent achieved for this participant. */
+    currentGradePercent: number;
+
+    /** Gets or sets the text for the currently achieved Rock.Model.LearningGradingSystemScale. */
+    currentGradeText?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets whether the particpiant is a facilitator. */
+    isFacilitator: boolean;
+
+    /** Gets or sets the note specific to this class participant. */
+    note?: string | null;
+
+    /** Gets or sets the (group type) role of the participant. */
+    participantRole?: ListItemBag | null;
+
+    /** Gets or sets the Rock.Model.Person representing the GroupMember. */
+    personAlias?: ListItemBag | null;
+
+    /** Gets or sets the shcedule time text for the participant detail. */
+    scheduledTime?: string | null;
+
+    /** Gets or sets the semester name for the participant detail. */
+    semesterName?: string | null;
+};

package/types/ViewModels/Blocks/Lms/LearningParticipantDetail/learningParticipantDetailOptionsBag.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 { ConfigurationMode } from "@Obsidian/Enums/Lms/configurationMode";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+export type LearningParticipantDetailOptionsBag = {
+    /** Gets or sets whether the current person is authorized to view grades. */
+    canViewGrades: boolean;
+
+    /** Gets or sets the list of available roles for the class. */
+    classRoles?: ListItemBag[] | null;
+
+    /** Gets or sets the configuration mode of the Program. */
+    configurationMode: ConfigurationMode;
+};

package/types/ViewModels/Blocks/Lms/LearningProgramCompletionDetail/learningProgramCompletionBag.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 { CompletionStatus } from "@Obsidian/Enums/Lms/completionStatus";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The item details for the Learning Program Completion Detail block. */
+export type LearningProgramCompletionBag = {
+    /** 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 student's completion status for the program. */
+    completionStatus: CompletionStatus;
+
+    /** Gets or sets the date the student completed the Rock.Model.LearningProgram. */
+    endDate?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the name of the related person. */
+    personName?: string | null;
+
+    /** Gets or sets the date the student started the Rock.Model.LearningProgram. */
+    startDate?: string | null;
+};

package/types/ViewModels/Blocks/Lms/LearningProgramCompletionDetail/learningProgramCompletionDetailBag.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 { CompletionStatus } from "@Obsidian/Enums/Lms/completionStatus";
+
+/** The item details for the Learning Activity Completion Detail block. */
+export type LearningProgramCompletionBag = {
+
+    /** Gets or sets the student's completion status for the program. */
+    completionStatus: CompletionStatus;
+
+    /** Gets or sets the date the student completed the Rock.Model.LearningProgram. */
+    endDate?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the name of the related person. */
+    personName: string | null;
+
+    /** Gets or sets the date the student started the Rock.Model.LearningProgram. */
+    startDate?: string | null;
+};

package/types/ViewModels/Blocks/Lms/LearningProgramCompletionDetail/learningProgramCompletionDetailOptionsBag.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 Program Completion Detail block. */
+export type LearningProgramCompletionDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Lms/LearningProgramCompletionList/learningProgramCompletionListOptionsBag.d.ts

@@ -0,0 +1,27 @@
+//------------------------------------------------------------------------------
+// <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 LearningProgramCompletionListOptionsBag = {
+    /** Gets or sets whether the semester column is shown. */
+    showSemesterColumn: boolean;
+};

package/types/ViewModels/Blocks/Lms/LearningProgramDetail/learningProgramBag.d.ts

@@ -0,0 +1,121 @@
+//------------------------------------------------------------------------------
+// <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";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type LearningProgramBag = {
+    /** Gets or sets the number of absences at which a critical alert should be triggered. */
+    absencesCriticalCount?: number | null;
+
+    /** Gets or sets the number of absences at which a warning should be triggered. */
+    absencesWarningCount?: number | null;
+
+    /** Gets or sets the number of active classes in the Program. */
+    activeClasses: number;
+
+    /** Gets or sets the number of active students in the Program. */
+    activeStudents: number;
+
+    /** Gets or sets the additional settings json. */
+    additionalSettingsJson?: string | null;
+
+    /** 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 related Rock.Model.Category for the program. */
+    category?: ListItemBag | null;
+
+    /** Gets or sets the Rock.Model.Category.HighlightColor for the program. */
+    categoryColor?: string | null;
+
+    /** Gets or sets the Rock.Model.Category identifier. */
+    categoryId?: number | null;
+
+    /** Gets or sets the number of students who have completed this Program. */
+    completions: number;
+
+    /** Gets or sets the related completion WorkflowType for the program. */
+    completionWorkflowType?: ListItemBag | null;
+
+    /** Gets or sets the Id of the Rock.Model.WorkflowType that is triggered when the program is completed by a student. */
+    completionWorkflowTypeId?: number | null;
+
+    /** Gets or sets the configuration mode of the LearningProgram. */
+    configurationMode?: ConfigurationMode | null;
+
+    /** Gets or sets the default LearningGradingSystem for the program. */
+    defaultGradingSystem?: ListItemBag | null;
+
+    /** Gets or sets the Description of the LearningProgram. */
+    description?: string | null;
+
+    /** Gets or sets the color of the highlight. */
+    highlightColor?: string | null;
+
+    /** Gets or sets the icon CSS class. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the related Rock.Model.BinaryFile for the program. */
+    imageBinaryFile?: ListItemBag | null;
+
+    /** Gets or sets the binary file id of the image for the LearningProgram. */
+    imageBinaryFileId?: number | null;
+
+    /** Gets a value indicating whether this LearningProgram is active. */
+    isActive: boolean;
+
+    /**
+     * Gets a value indicating whether this LearningProgram tracks student's completion of the program.
+     * Once a LearningProgram begins this value cannot be changed.
+     */
+    isCompletionStatusTracked: boolean;
+
+    /**
+     * Indicates whether or not this LearningProgram should
+     * be displayed in public contexts (e.g. on a public site).
+     */
+    isPublic: boolean;
+
+    /** Gets or sets the name of the LearningProgram. */
+    name?: string | null;
+
+    /** Gets or sets the public name of the LearningProgram. */
+    publicName?: string | null;
+
+    /** Gets or sets whether the KPIs are visible. */
+    showKpis: boolean;
+
+    /** Gets or sets the summary text of the LearningProgram. */
+    summary?: string | null;
+
+    /** Gets or sets the related Rock.Model.SystemCommunication for the program. */
+    systemCommunication?: ListItemBag | null;
+};