@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Blocks/Core/LocationDetail/locationBag.d.ts

@@ -0,0 +1,85 @@
+//------------------------------------------------------------------------------
+// <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";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type LocationBag = {
+    /** Gets or sets the address fields. */
+    addressFields?: AddressControlBag | 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 threshold that will prevent checkin (no option to override) */
+    firmRoomThreshold?: number | null;
+
+    /** Gets or sets the formatted HTML address. */
+    formattedHtmlAddress?: string | null;
+
+    /** Gets or sets the geo fence well known text. */
+    geoFence_WellKnownText?: string | null;
+
+    /** Gets or sets the GeoFence image HTML. */
+    geoFenceImageHtml?: string | null;
+
+    /** Gets or sets the geo point well known text. */
+    geoPoint_WellKnownText?: string | null;
+
+    /** Gets or sets the GeoPoint image HTML. */
+    geoPointImageHtml?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the image identifier. */
+    imageId?: number | null;
+
+    /** Gets or sets a value indicating whether this instance is active. */
+    isActive: boolean;
+
+    /** Gets or sets flag indicating if GeoPoint is locked (shouldn't be geocoded again) */
+    isGeoPointLocked?: boolean | null;
+
+    /**
+     * Gets or sets the Id of the LocationType Rock.Model.DefinedValue that is used to identify the type of Rock.Model.Location
+     * that this is. Examples: Campus, Building, Room, etc
+     */
+    locationTypeValue?: ListItemBag | null;
+
+    /** Gets or sets the Location's Name. */
+    name?: string | null;
+
+    /** Gets or sets the if the location's parent Location.  */
+    parentLocation?: ListItemBag | null;
+
+    /** Gets or sets the Rock.Model.Device Id of the printer (if any) associated with the location. */
+    printerDevice?: ListItemBag | null;
+
+    /** Gets or sets a threshold that will prevent checkin unless a manager overrides */
+    softRoomThreshold?: number | null;
+};

package/types/ViewModels/Blocks/Core/LocationDetail/locationDetailOptionsBag.d.ts

@@ -0,0 +1,29 @@
+//------------------------------------------------------------------------------
+// <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";
+
+export type LocationDetailOptionsBag = {
+    /** Gets or sets the printer device options. */
+    printerDeviceOptions?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Core/NoteTypeDetail/noteTypeBag.d.ts

@@ -0,0 +1,82 @@
+//------------------------------------------------------------------------------
+// <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 { NoteFormatType } from "@Obsidian/Enums/Core/noteFormatType";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type NoteTypeBag = {
+    /** Gets or sets a value indicating whether attachments are allowed for this note type. */
+    allowsAttachments: boolean;
+
+    /** Gets or sets a value indicating whether [allows replies]. */
+    allowsReplies: boolean;
+
+    /** Gets or sets a value indicating whether [allows watching]. */
+    allowsWatching: 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 a value indicating whether [automatic watch authors]. */
+    autoWatchAuthors: boolean;
+
+    /** Gets or sets the Rock.Model.BinaryFileType that will be used for attachments. */
+    binaryFileType?: ListItemBag | null;
+
+    /** Gets or sets the color of each note. */
+    color?: string | null;
+
+    /** Gets or sets the Rock.Model.EntityType of the entities that Notes of this NoteType  */
+    entityType?: ListItemBag | null;
+
+    /** Gets or sets the type of formatting used by notes of this type. */
+    formatType: NoteFormatType;
+
+    /** Gets or sets the name of an icon CSS class.  */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if mentions are supported on this note type. */
+    isMentionEnabled: boolean;
+
+    /** Gets or sets a flag indicating that this NoteType is part of the Rock core system/framework. This property is required. */
+    isSystem: boolean;
+
+    /** Gets or sets the maximum reply depth. */
+    maxReplyDepth?: number | null;
+
+    /** Gets or sets the Name of the NoteType. This property is required. */
+    name?: string | null;
+
+    /** Gets or sets a value indicating whether to show the entity type picker to allow user selection. */
+    showEntityTypePicker: boolean;
+
+    /** Gets or sets a value indicating whether the type is user selectable. */
+    userSelectable: boolean;
+};

package/types/ViewModels/Blocks/Core/NoteTypeDetail/noteTypeDetailOptionsBag.d.ts

@@ -0,0 +1,25 @@
+//------------------------------------------------------------------------------
+// <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 NoteTypeDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/Notes/deleteNoteRequestBag.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>
+//
+
+/** Describes a request to delete an existing note. */
+export type DeleteNoteRequestBag = {
+    /** Gets or sets the identifier of the note to be deleted. */
+    idKey?: string | null;
+};

package/types/ViewModels/Blocks/Core/Notes/editNoteRequestBag.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>
+//
+
+/** Describes a request to begin editing an existing note. */
+export type EditNoteRequestBag = {
+    /** Gets or sets the identifier of the note to be edited. */
+    idKey?: string | null;
+};

package/types/ViewModels/Blocks/Core/Notes/noteBag.d.ts

@@ -0,0 +1,82 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Describes an existing note that should be displayed to the person. */
+export type NoteBag = {
+    /** Gets or sets the unique anchor identifier used to link to this note. */
+    anchorId?: string | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the caption text of the note. */
+    caption?: string | null;
+
+    /** Gets or sets the identifier of the person that created this note. */
+    createdByIdKey?: string | null;
+
+    /** Gets or sets the name of the person that created this created. */
+    createdByName?: string | null;
+
+    /** Gets or sets the photo URL of the person that created this note. */
+    createdByPhotoUrl?: string | null;
+
+    /** Gets or sets the created date time. */
+    createdDateTime?: string | null;
+
+    /** Gets or sets the name of the person that edited this note. */
+    editedByName?: string | null;
+
+    /** Gets or sets the edited date time. */
+    editedDateTime?: string | null;
+
+    /** Gets or sets the identifier of the note. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this note is an alert note. */
+    isAlert: boolean;
+
+    /** Gets or sets a value indicating whether this note is deletable. */
+    isDeletable: boolean;
+
+    /** Gets or sets a value indicating whether this note is editable. */
+    isEditable: boolean;
+
+    /** Gets or sets a value indicating whether this note should be pinned to top */
+    isPinned: boolean;
+
+    /** Gets or sets a value indicating whether this note is a private note. */
+    isPrivate: boolean;
+
+    /** Gets or sets a value indicating whether this note is currently being watched. */
+    isWatching: boolean;
+
+    /** Gets or sets the note type identifier. */
+    noteTypeIdKey?: string | null;
+
+    /** Gets or sets the parent note identifier. */
+    parentNoteIdKey?: string | null;
+
+    /** Gets or sets the text of the note. */
+    text?: string | null;
+};

package/types/ViewModels/Blocks/Core/Notes/noteEditBag.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>
+//
+
+/** Describes a note that is in edit mode. */
+export type NoteEditBag = {
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the created date time. */
+    createdDateTime?: string | null;
+
+    /** Gets or sets the identifier of the note. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this note is an alert note. */
+    isAlert: boolean;
+
+    /** Gets or sets a value indicating whether this note should be pinned to the top of the list. */
+    isPinned: boolean;
+
+    /** Gets or sets a value indicating whether this note is private. */
+    isPrivate: boolean;
+
+    /** Gets or sets the note type identifier. */
+    noteTypeIdKey?: string | null;
+
+    /** Gets or sets the parent note identifier. */
+    parentNoteIdKey?: string | null;
+
+    /** Gets or sets the text of the note. */
+    text?: string | null;
+};

package/types/ViewModels/Blocks/Core/Notes/noteTypeBag.d.ts

@@ -0,0 +1,60 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/**
+ * Describes a single type of note that might be included in the list
+ * of notes.
+ */
+export type NoteTypeBag = {
+    /** Gets or sets a value indicating whether replies to this note type are allowed. */
+    allowsReplies: boolean;
+
+    /** Gets or sets a value indicating whether notes of this type can be watched. */
+    allowsWatching: boolean;
+
+    /** Gets or sets the attributes defined on this note type. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the color. */
+    color?: string | null;
+
+    /** Gets or sets the icon CSS class that represents the note type. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the identifier of the note type. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether notes of this type can use mentions. */
+    isMentionEnabled: boolean;
+
+    /** Gets or sets the maximum reply depth. */
+    maxReplyDepth: number;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+
+    /** Gets or sets a value indicating whether the person can select this note type. */
+    userSelectable: boolean;
+};

package/types/ViewModels/Blocks/Core/Notes/notesInitializationBox.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 { NoteBag } from "@Obsidian/ViewModels/Blocks/Core/Notes/noteBag";
+import { NoteTypeBag } from "@Obsidian/ViewModels/Blocks/Core/Notes/noteTypeBag";
+
+export type NotesInitializationBox = {
+    /** Gets or sets a value indicating whether the add note editor should always be visible. */
+    addAlwaysVisible: boolean;
+
+    /** Gets or sets a value indicating whether the note type heading should be visible. */
+    displayNoteTypeHeading: boolean;
+
+    /** Gets or sets the identifier key of the context entity for this block. */
+    entityIdKey?: string | null;
+
+    /** Gets or sets the entity type identifier of the context entity for this block. */
+    entityTypeIdKey?: string | null;
+
+    /** Gets or sets the error message. */
+    errorMessage?: string | null;
+
+    /** Gets or sets a value indicating whether replies should be automatically expanded. */
+    expandReplies: boolean;
+
+    /** Gets or sets a value indicating whether notes should be displayed in descending order. */
+    isDescending: boolean;
+
+    /** Gets or sets a value indicating whether this block is in light mode. */
+    isLightMode: boolean;
+
+    /** Gets or sets the note label that describes a single note. */
+    noteLabel?: string | null;
+
+    /** Gets or sets the notes to display. */
+    notes?: NoteBag[] | null;
+
+    /** Gets or sets the note types configured on the block. */
+    noteTypes?: NoteTypeBag[] | null;
+
+    /** Gets or sets the avatar URL of the current person. */
+    personAvatarUrl?: string | null;
+
+    /** Gets or sets a value indicating whether adding notes is allowed. */
+    showAdd: boolean;
+
+    /** Gets or sets a value indicating whether the alert checkbox should be shown. */
+    showAlertCheckBox: boolean;
+
+    /** Gets or sets a value indicating whether the created date override should be visible. */
+    showCreateDateInput: boolean;
+
+    /** Gets or sets a value indicating whether private checkbox should be shown. */
+    showPrivateCheckBox: boolean;
+
+    /** Gets or sets a value indicating whether security button should be shown. */
+    showSecurityButton: boolean;
+
+    /** Gets or sets the panel title. */
+    title?: string | null;
+
+    /** Gets or sets the title icon CSS class. */
+    titleIconCssClass?: string | null;
+
+    /** Gets or sets a value indicating whether person icons should be shown. */
+    usePersonIcon: boolean;
+};

package/types/ViewModels/Blocks/Core/Notes/saveNoteRequestBag.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 { NoteEditBag } from "@Obsidian/ViewModels/Blocks/Core/Notes/noteEditBag";
+
+/** Describes a request to save changes to an existing note. */
+export type SaveNoteRequestBag = {
+    /** Gets or sets the bag that contains the changes that should be made to the note. */
+    bag?: NoteEditBag | null;
+
+    /** Gets the valid properties of the Rock.ViewModels.Blocks.Core.Notes.SaveNoteRequestBag.Bag. */
+    validProperties?: string[] | null;
+};

package/types/ViewModels/Blocks/Core/Notes/watchNoteRequestBag.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>
+//
+
+/** Describes a request to watch or unwatch an existing note. */
+export type WatchNoteRequestBag = {
+    /** Gets or sets the identifier of the note to be watched or unwatched. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating if the note should be watched or not. */
+    isWatching: boolean;
+};

package/types/ViewModels/Blocks/Core/NotificationMessageList/getMessageActionRequestBag.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>
+//
+
+/** Describes the request sent to the GetMessageAction block action. */
+export type GetMessageActionRequestBag = {
+    /** Gets or sets the identifier key of the notification message. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether to mark the message as read. */
+    isRead: boolean;
+};