📄️ Overview
The library is imported into the script as follows:
📄️ RestFilter
The RestFilter class is a data structure used for representing a filter configuration in the context of a RESTful service. It contains properties that define various aspects of the filter, including the filter conditions, sorting criteria, requested columns, pagination parameters, and additional parameters.
📄️ FilterColumn
The FilterColumn class represents a single filter column used for filtering data. It contains properties that define the filter criteria, such as the column name, the value to be filtered, the comparison operator, and other related options. Here are the key properties of the FilterColumn class:
📄️ SortColumn
The SortColumn class is a data structure used to represent a sorting criterion within a filter configuration. It is typically used in conjunction with the RestFilter class to specify the sorting behavior for a data retrieval operation. Here are the properties of the SortColumn class:
📄️ RequestColumn
The RequestColumn class is a data structure used to represent a column or field in a data retrieval request or filter configuration. It provides properties to specify various aspects of the column, such as its name, aggregation, expression, alias, and additional modifiers. Here are the properties of the RequestColumn class:
📄️ Parameter
The Parameter class is used in script related functionality.
📄️ DbSorting
The DbSorting enum is used to represent the sorting order in a database query. It has two possible values:
📄️ Comparer
The Comparer enum represents various comparison operations that can be performed in filtering or querying data. It includes the following comparison operators:
📄️ Concat
The Concat enum represents logical concatenation operators used in combining multiple conditions or clauses in a logical expression. It includes the following concatenation operators:
📄️ Aggregation
The Aggregation enum represents different types of aggregations that can be applied to a column or expression in data processing operations. It includes the following aggregation types:
📄️ ECCLevel
The ECCLevel enum represents the error correction capability levels for QR codes. QR codes can have different levels of error correction to ensure data integrity and readability. The enum includes the following error correction levels:
📄️ Guid
The Guid struct is the built-in type from the System namespace that represents a globally unique identifier.
📄️ DBUser
The DBUser class represents a simplified version of a user in the database. Here's a breakdown of its structure and functionality:
📄️ SaveUser
The SaveUser class represents the information required to save a user in the application's security system. Here's a breakdown of its Properties:
📄️ User
The User class represents a user entity in the application. Here's a breakdown of its structure:
📄️ JTokeType
The JTokenType enum represents the types of tokens that can be encountered when working with JSON data. Here's a breakdown of the enum values:
📄️ JObject
It contains asynchronous methods for writing and loading a JObject from a JsonReader.
📄️ JToken
The JToken class is part of the library's support for working with JSON data. The code includes asynchronous versions of the WriteTo and Load methods for the JObject class.
📄️ JArray
The code includes two methods
📄️ HttpStatusCode
This enumeration contains a set of values representing the status codes defined for HTTP
📄️ HttpResult
This class represents the result of an HTTP request and contains the following properties:
📄️ UpdateColumn
This class represents a wrapper object used to update a column in some context. Is only used in the script in connection with a bulk operation on Document store databases. It is used as a parameter in two functions in the BulkOperations class (DeleteFrom and Update). It contains the following properties:
📄️ WhereArrayPart
This class represents a part of an array used in the context of column updates. It has the following properties:
📄️ Role
This class represents a role in a security system and extends the BaseObject class. The Role class has several properties with various attributes applied to them:
📄️ ContainerSecurity
The code represents the security settings for a container. The ContainerSecurity class has the following properties:
📄️ StructureAccess
It represents the different levels of access or permissions that can be granted to a container's structure. The enumeration consists of three members:
📄️ ContainerDataSecurity
This class represents the security settings for data within a container. The class has the following properties:
📄️ ContainerFieldSecurity
This class represents the security settings for a specific field within a container. The class has the following properties:
📄️ DataAccess
It defines an enumeration named DataAccess which represents different levels of data access permissions. The DataAccess enumeration has the following values:
📄️ ContainerFieldFilter
The ContainerFieldFilter class has the following properties:
📄️ ReaderStruct
It is a wrapper class to provide the relational reader and a close event. The ReaderStruct class encapsulates a data reader along with an associated action to be executed when the reader needs to be closed or its resources need to be released. This can be useful for managing and closing data readers in a structured manner, ensuring that the resources are properly disposed of when they are no longer needed. The reader is necessary to read data from a relational source. It has two properties:
📄️ MediaSource
A class which represents a media source entity. Here's an overview of the properties and their purpose:
📄️ NonDatabaseResourceItem
A class which represents a non-database resource item. Here's an overview of the properties:
📄️ ContainerElement
Is a base class for all fields in all structures in framework. This class is only used in the script to read the field properties of a structure (e.g. ContainerClassObject). System module “ContainerAccess” -> function “GetFields”