diff options
author | vnugent <public@vaughnnugent.com> | 2023-01-09 16:02:13 -0500 |
---|---|---|
committer | vnugent <public@vaughnnugent.com> | 2023-01-09 16:02:13 -0500 |
commit | 0bf1695b1685b727a251e72ba9f24a3372486c27 (patch) | |
tree | 5ed6cdbbaefeafaf321a32fea26ae192cb2c9a6b /lib | |
parent | d59c59248d4674ce97c957b140816fd37eab2f93 (diff) |
invalid doc files
Diffstat (limited to 'lib')
-rw-r--r-- | lib/VNLib.Plugins.Extensions.Data/src/VNLib.Plugins.Extensions.Data.xml | 476 | ||||
-rw-r--r-- | lib/VNLib.Plugins.Extensions.Loading/src/VNLib.Plugins.Extensions.Loading.xml | 260 |
2 files changed, 0 insertions, 736 deletions
diff --git a/lib/VNLib.Plugins.Extensions.Data/src/VNLib.Plugins.Extensions.Data.xml b/lib/VNLib.Plugins.Extensions.Data/src/VNLib.Plugins.Extensions.Data.xml deleted file mode 100644 index 2f7736e..0000000 --- a/lib/VNLib.Plugins.Extensions.Data/src/VNLib.Plugins.Extensions.Data.xml +++ /dev/null @@ -1,476 +0,0 @@ -<?xml version="1.0"?> -<!-- -Copyright (c) 2022 Vaughn Nugent ---> -<doc> - <assembly> - <name>VNLib.Plugins.Extensions.Data</name> - </assembly> - <members> - <member name="T:VNLib.Plugins.Extensions.Data.Abstractions.IBulkDataStore`1"> - <summary> - An abstraction that defines a Data-Store that supports - bulk data operations - </summary> - <typeparam name="T">The data-model type</typeparam> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IBulkDataStore`1.DeleteBulkAsync(System.Collections.Generic.ICollection{`0})"> - <summary> - Deletes a collection of records from the store - </summary> - <param name="records">A collection of records to delete</param> - <returns>A task the resolves the number of entires removed from the store</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IBulkDataStore`1.UpdateBulkAsync(System.Collections.Generic.ICollection{`0})"> - <summary> - Updates a collection of records - </summary> - <param name="records">The collection of records to update</param> - <returns>A task the resolves an error code (should evaluate to false on failure, and true on success)</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IBulkDataStore`1.CreateBulkAsync(System.Collections.Generic.ICollection{`0})"> - <summary> - Creates a bulk collection of records as entries in the store - </summary> - <param name="records">The collection of records to add</param> - <returns>A task the resolves an error code (should evaluate to false on failure, and true on success)</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IBulkDataStore`1.AddOrUpdateBulkAsync(System.Collections.Generic.ICollection{`0})"> - <summary> - Creates or updates individual records from a bulk collection of records - </summary> - <param name="records">The collection of records to add</param> - <returns>A task the resolves an error code (should evaluate to false on failure, and true on success)</returns> - </member> - <member name="T:VNLib.Plugins.Extensions.Data.Abstractions.IDataStore`1"> - <summary> - An abstraction that defines a Data-Store and common - operations that retrieve or manipulate records of data - </summary> - <typeparam name="T">The data-model type</typeparam> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IDataStore`1.GetCountAsync"> - <summary> - Gets the total number of records in the current store - </summary> - <returns>A task that resolves the number of records in the store</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IDataStore`1.GetCountAsync(System.String)"> - <summary> - Gets the number of records that belong to the specified constraint - </summary> - <param name="specifier">A specifier to constrain the reults</param> - <returns>The number of records that belong to the specifier</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IDataStore`1.GetSingleAsync(System.String)"> - <summary> - Gets a record from its key - </summary> - <param name="key">The key identifying the unique record</param> - <returns>A promise that resolves the record identified by the specified key</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IDataStore`1.GetSingleAsync(System.String[])"> - <summary> - Gets a record from its key - </summary> - <param name="specifiers">A variable length specifier arguemnt array for retreiving a single application</param> - <returns></returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IDataStore`1.GetSingleAsync(`0)"> - <summary> - Gets a record from the store with a partial model, intended to complete the model - </summary> - <param name="record">The partial model used to query the store</param> - <returns>A task the resolves the completed data-model</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IDataStore`1.GetCollectionAsync(System.Collections.Generic.ICollection{`0},System.String,System.Int32)"> - <summary> - Fills a collection with enires retireved from the store using the specifer - </summary> - <param name="collection">The collection to add entires to</param> - <param name="specifier">A specifier argument to constrain results</param> - <param name="limit">The maximum number of elements to retrieve</param> - <returns>A Task the resolves to the number of items added to the collection</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IDataStore`1.GetCollectionAsync(System.Collections.Generic.ICollection{`0},System.Int32,System.String[])"> - <summary> - Fills a collection with enires retireved from the store using a variable length specifier - parameter - </summary> - <param name="collection">The collection to add entires to</param> - <param name="limit">The maximum number of elements to retrieve</param> - <param name="args"></param> - <returns>A Task the resolves to the number of items added to the collection</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IDataStore`1.UpdateAsync(`0)"> - <summary> - Updates an entry in the store with the specified record - </summary> - <param name="record">The record to update</param> - <returns>A task the resolves an error code (should evaluate to false on failure, and true on success)</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IDataStore`1.CreateAsync(`0)"> - <summary> - Creates a new entry in the store representing the specified record - </summary> - <param name="record">The record to add to the store</param> - <returns>A task the resolves an error code (should evaluate to false on failure, and true on success)</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IDataStore`1.DeleteAsync(`0)"> - <summary> - Deletes one or more entrires from the store matching the specified record - </summary> - <param name="record">The record to remove from the store</param> - <returns>A task the resolves the number of records removed(should evaluate to false on failure, and deleted count on success)</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IDataStore`1.DeleteAsync(System.String)"> - <summary> - Deletes one or more entires from the store matching the specified unique key - </summary> - <param name="key">The unique key that identifies the record</param> - <returns>A task the resolves the number of records removed(should evaluate to false on failure, and deleted count on success)</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IDataStore`1.DeleteAsync(System.String[])"> - <summary> - Deletes one or more entires from the store matching the supplied specifiers - </summary> - <param name="specifiers">A variable length array of specifiers used to delete one or more entires</param> - <returns>A task the resolves the number of records removed(should evaluate to false on failure, and deleted count on success)</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IDataStore`1.AddOrUpdateAsync(`0)"> - <summary> - Updates an entry in the store if it exists, or creates a new entry if one does not already exist - </summary> - <param name="record">The record to add to the store</param> - <returns>A task the resolves the result of the operation</returns> - </member> - <member name="T:VNLib.Plugins.Extensions.Data.Abstractions.IPaginatedDataStore`1"> - <summary> - Defines a Data-Store that can retirieve and manipulate paginated - data - </summary> - <typeparam name="T">The data-model type</typeparam> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IPaginatedDataStore`1.GetPageAsync(System.Collections.Generic.ICollection{`0},System.Int32,System.Int32)"> - <summary> - Gets a collection of records using a pagination style query, and adds the records to the collecion - </summary> - <param name="collection">The collection to add records to</param> - <param name="page">Pagination page to get records from</param> - <param name="limit">The maximum number of items to retrieve from the store</param> - <returns>A task that resolves the number of items added to the collection</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.Abstractions.IPaginatedDataStore`1.GetPageAsync(System.Collections.Generic.ICollection{`0},System.Int32,System.Int32,System.String[])"> - <summary> - Gets a collection of records using a pagination style query with constraint arguments, and adds the records to the collecion - </summary> - <param name="collection">The collection to add records to</param> - <param name="page">Pagination page to get records from</param> - <param name="limit">The maximum number of items to retrieve from the store</param> - <param name="constraints">A params array of strings to constrain the result set from the db</param> - <returns>A task that resolves the number of items added to the collection</returns> - </member> - <member name="T:VNLib.Plugins.Extensions.Data.Abstractions.IUserEntity"> - <summary> - Defines an entity base that has an owner, identified by its user-id - </summary> - </member> - <member name="P:VNLib.Plugins.Extensions.Data.Abstractions.IUserEntity.UserId"> - <summary> - The user-id of the owner of the entity - </summary> - </member> - <member name="T:VNLib.Plugins.Extensions.Data.DbModelBase"> - <summary> - Provides a base for DBSet Records with a timestamp/version - a unique ID key, and create/modified timestamps - </summary> - </member> - <member name="P:VNLib.Plugins.Extensions.Data.DbModelBase.Id"> - <inheritdoc/> - </member> - <member name="P:VNLib.Plugins.Extensions.Data.DbModelBase.Version"> - <inheritdoc/> - </member> - <member name="P:VNLib.Plugins.Extensions.Data.DbModelBase.Created"> - <inheritdoc/> - </member> - <member name="P:VNLib.Plugins.Extensions.Data.DbModelBase.LastModified"> - <inheritdoc/> - </member> - <member name="T:VNLib.Plugins.Extensions.Data.DbStore`1"> - <summary> - Implements basic data-store functionality with abstract query builders - </summary> - <typeparam name="T">A <see cref="T:VNLib.Plugins.Extensions.Data.DbModelBase"/> implemented type</typeparam> - </member> - <member name="P:VNLib.Plugins.Extensions.Data.DbStore`1.RecordIdBuilder"> - <summary> - Gets a unique ID for a new record being added to the store - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.NewContext"> - <summary> - Gets a new <see cref="T:VNLib.Plugins.Extensions.Data.TransactionalDbContext"/> ready for use - </summary> - <returns></returns> - </member> - <member name="P:VNLib.Plugins.Extensions.Data.DbStore`1.ListRental"> - <summary> - An object rental for entity collections - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.AddOrUpdateAsync(`0)"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.UpdateAsync(`0)"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.CreateAsync(`0)"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.AddOrUpdateQueryBuilder(VNLib.Plugins.Extensions.Data.TransactionalDbContext,`0)"> - <summary> - Builds a query that attempts to get a single entry from the - store based on the specified record if it does not have a - valid <see cref="P:VNLib.Plugins.Extensions.Data.DbModelBase.Id"/> property - </summary> - <param name="context">The active context to query</param> - <param name="record">The record to search for</param> - <returns>A query that yields a single record if it exists in the store</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.UpdateQueryBuilder(VNLib.Plugins.Extensions.Data.TransactionalDbContext,`0)"> - <summary> - Builds a query that attempts to get a single entry from the - store to update based on the specified record - </summary> - <param name="context">The active context to query</param> - <param name="record">The record to search for</param> - <returns>A query that yields a single record to update if it exists in the store</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.OnRecordUpdate(`0,`0)"> - <summary> - Updates the current record (if found) to the new record before - storing the updates. - </summary> - <param name="newRecord">The new record to capture data from</param> - <param name="currentRecord">The current record to be updated</param> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.DeleteAsync(System.String)"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.DeleteAsync(`0)"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.DeleteAsync(System.String[])"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.DeleteQueryBuilder(VNLib.Plugins.Extensions.Data.TransactionalDbContext,System.String[])"> - <summary> - Builds a query that results in a single entry to delete from the - constraint arguments - </summary> - <param name="context">The active context</param> - <param name="constraints">A variable length parameter array of query constraints</param> - <returns>A query that yields a single record (or no record) to delete</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetCollectionAsync(System.Collections.Generic.ICollection{`0},System.String,System.Int32)"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetCollectionAsync(System.Collections.Generic.ICollection{`0},System.Int32,System.String[])"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetCollectionQueryBuilder(VNLib.Plugins.Extensions.Data.TransactionalDbContext,System.String)"> - <summary> - Builds a query to get a count of records constrained by the specifier - </summary> - <param name="context">The active context to run the query on</param> - <param name="specifier">The specifier constrain</param> - <returns>A query that can be counted</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetCollectionQueryBuilder(VNLib.Plugins.Extensions.Data.TransactionalDbContext,System.String[])"> - <summary> - Builds a query to get a collection of records based on an variable length array of parameters - </summary> - <param name="context">The active context to run the query on</param> - <param name="constraints">An arguments array to constrain the results of the query</param> - <returns>A query that returns a collection of records from the store</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetCountAsync"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetCountAsync(System.String)"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetCountQueryBuilder(VNLib.Plugins.Extensions.Data.TransactionalDbContext,System.String)"> - <summary> - Builds a query to get a count of records constrained by the specifier - </summary> - <param name="context">The active context to run the query on</param> - <param name="specifier">The specifier constrain</param> - <returns>A query that can be counted</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetSingleAsync(System.String)"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetSingleAsync(`0)"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetSingleAsync(System.String[])"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetSingleQueryBuilder(VNLib.Plugins.Extensions.Data.TransactionalDbContext,System.String[])"> - <summary> - Builds a query to get a single record from the variable length parameter arguments - </summary> - <param name="context">The context to execute query against</param> - <param name="constraints">Arguments to constrain the results of the query to a single record</param> - <returns>A query that yields a single record</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetSingleQueryBuilder(VNLib.Plugins.Extensions.Data.TransactionalDbContext,`0)"> - <summary> - <para> - Builds a query to get a single record from the specified record. - </para> - <para> - Unless overridden, performs an ID based query for a single entry - </para> - </summary> - <param name="context">The context to execute query against</param> - <param name="record">A record to referrence the lookup</param> - <returns>A query that yields a single record</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetPageAsync(System.Collections.Generic.ICollection{`0},System.Int32,System.Int32)"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetPageAsync(System.Collections.Generic.ICollection{`0},System.Int32,System.Int32,System.String[])"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.DbStore`1.GetPageQueryBuilder(VNLib.Plugins.Extensions.Data.TransactionalDbContext,System.String[])"> - <summary> - Builds a query to get a collection of records based on an variable length array of parameters - </summary> - <param name="context">The active context to run the query on</param> - <param name="constraints">An arguments array to constrain the results of the query</param> - <returns>A query that returns a paginated collection of records from the store</returns> - </member> - <member name="T:VNLib.Plugins.Extensions.Data.IDbModel"> - <summary> - Represents a basic data model for an EFCore entity - for support in data-stores - </summary> - </member> - <member name="P:VNLib.Plugins.Extensions.Data.IDbModel.Id"> - <summary> - A unique id for the entity - </summary> - </member> - <member name="P:VNLib.Plugins.Extensions.Data.IDbModel.Created"> - <summary> - The <see cref="T:System.DateTimeOffset"/> the entity was created in the store - </summary> - </member> - <member name="P:VNLib.Plugins.Extensions.Data.IDbModel.LastModified"> - <summary> - The <see cref="T:System.DateTimeOffset"/> the entity was last modified in the store - </summary> - </member> - <member name="P:VNLib.Plugins.Extensions.Data.IDbModel.Version"> - <summary> - Entity concurrency token - </summary> - </member> - <member name="T:VNLib.Plugins.Extensions.Data.ProtectedDbStore`1"> - <summary> - A data store that provides unique identities and protections based on an entity that has an owner <see cref="T:VNLib.Plugins.Extensions.Data.Abstractions.IUserEntity"/> - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.ProtectedDbStore`1.GetCollectionQueryBuilder(VNLib.Plugins.Extensions.Data.TransactionalDbContext,System.String[])"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.ProtectedDbStore`1.GetSingleQueryBuilder(VNLib.Plugins.Extensions.Data.TransactionalDbContext,System.String[])"> - <summary> - Gets a single item contrained by a given user-id and item id - </summary> - <param name="context"></param> - <param name="constraints"></param> - <returns></returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.ProtectedDbStore`1.GetSingleQueryBuilder(VNLib.Plugins.Extensions.Data.TransactionalDbContext,`0)"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.ProtectedEntityExtensions.UpdateAsync``1(VNLib.Plugins.Extensions.Data.Abstractions.IDataStore{``0},``0,System.String)"> - <summary> - Updates the specified record within the store - </summary> - <param name="store"></param> - <param name="record">The record to update</param> - <param name="userId">The userid of the record owner</param> - <returns>A task that evaluates to the number of records modified</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.ProtectedEntityExtensions.CreateAsync``1(VNLib.Plugins.Extensions.Data.Abstractions.IDataStore{``0},``0,System.String)"> - <summary> - Updates the specified record within the store - </summary> - <param name="store"></param> - <param name="record">The record to update</param> - <param name="userId">The userid of the record owner</param> - <returns>A task that evaluates to the number of records modified</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.ProtectedEntityExtensions.GetSingleAsync``1(VNLib.Plugins.Extensions.Data.Abstractions.IDataStore{``0},System.String,System.String)"> - <summary> - Gets a single entity from its ID and user-id - </summary> - <param name="store"></param> - <param name="key">The unique id of the entity</param> - <param name="userId">The user's id that owns the resource</param> - <returns>A task that resolves the entity or null if not found</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.ProtectedEntityExtensions.DeleteAsync``1(VNLib.Plugins.Extensions.Data.Abstractions.IDataStore{``0},System.String,System.String)"> - <summary> - Deletes a single entiry by its ID only if it belongs to the speicifed user - </summary> - <param name="store"></param> - <param name="key">The unique id of the entity</param> - <param name="userId">The user's id that owns the resource</param> - <returns>A task the resolves the number of eneities deleted (should evaluate to true or false)</returns> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.TransactionalDbContext.#ctor"> - <summary> - <inheritdoc/> - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.TransactionalDbContext.#ctor(Microsoft.EntityFrameworkCore.DbContextOptions)"> - <summary> - <inheritdoc/> - </summary> - </member> - <member name="P:VNLib.Plugins.Extensions.Data.TransactionalDbContext.Transaction"> - <summary> - The transaction that was opened on the current context - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.TransactionalDbContext.Dispose"> - <inheritdoc/> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.TransactionalDbContext.OpenTransactionAsync(System.Threading.CancellationToken)"> - <summary> - Opens a single transaction on the current context. If a transaction is already open, - it is disposed and a new transaction is begun. - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.TransactionalDbContext.CommitTransactionAsync(System.Threading.CancellationToken)"> - <summary> - Invokes the <see cref="M:Microsoft.EntityFrameworkCore.Storage.IDbContextTransaction.Commit"/> on the current context - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.TransactionalDbContext.RollbackTransctionAsync(System.Threading.CancellationToken)"> - <summary> - Invokes the <see cref="M:Microsoft.EntityFrameworkCore.Storage.IDbContextTransaction.Rollback"/> on the current context - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Data.TransactionalDbContext.DisposeAsync"> - <inheritdoc/> - </member> - </members> -</doc> diff --git a/lib/VNLib.Plugins.Extensions.Loading/src/VNLib.Plugins.Extensions.Loading.xml b/lib/VNLib.Plugins.Extensions.Loading/src/VNLib.Plugins.Extensions.Loading.xml deleted file mode 100644 index 963f506..0000000 --- a/lib/VNLib.Plugins.Extensions.Loading/src/VNLib.Plugins.Extensions.Loading.xml +++ /dev/null @@ -1,260 +0,0 @@ -<?xml version="1.0"?> -<!-- -Copyright (c) 2022 Vaughn Nugent ---> -<doc> - <assembly> - <name>VNLib.Plugins.Extensions.Loading</name> - </assembly> - <members> - <member name="T:VNLib.Plugins.Extensions.Loading.Configuration.ConfigurationNameAttribute"> - <summary> - Specifies a configuration variable name in the plugin's configuration - containing data specific to the type - </summary> - </member> - <member name="F:VNLib.Plugins.Extensions.Loading.Configuration.ConfigurationNameAttribute.ConfigVarName"> - <summary> - - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Configuration.ConfigurationNameAttribute.#ctor(System.String)"> - <summary> - Initializes a new <see cref="T:VNLib.Plugins.Extensions.Loading.Configuration.ConfigurationNameAttribute"/> - </summary> - <param name="configVarName">The name of the configuration variable for the class</param> - </member> - <member name="T:VNLib.Plugins.Extensions.Loading.Configuration.ConfigurationExtensions"> - <summary> - Contains extensions for plugin configuration specifc extensions - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Configuration.ConfigurationExtensions.GetConfigForType``1(VNLib.Plugins.PluginBase)"> - <summary> - Retrieves a top level configuration dictionary of elements for the specified type. - The type must contain a <see cref="T:VNLib.Plugins.Extensions.Loading.Configuration.ConfigurationNameAttribute"/> - </summary> - <typeparam name="T">The type to get the configuration of</typeparam> - <param name="plugin"></param> - <returns>A <see cref="T:System.Collections.Generic.Dictionary`2"/> of top level configuration elements for the type</returns> - <exception cref="T:System.ObjectDisposedException"></exception> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Configuration.ConfigurationExtensions.GetConfig(VNLib.Plugins.PluginBase,System.String)"> - <summary> - Retrieves a top level configuration dictionary of elements with the specified property name, - from the plugin config first, or falls back to the host config file - </summary> - <param name="plugin"></param> - <param name="propName">The config property name to retrieve</param> - <returns>A <see cref="T:System.Collections.Generic.Dictionary`2"/> of top level configuration elements for the type</returns> - <exception cref="T:System.ObjectDisposedException"></exception> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Configuration.ConfigurationExtensions.TryGetConfig(VNLib.Plugins.PluginBase,System.String)"> - <summary> - Retrieves a top level configuration dictionary of elements with the specified property name, - from the plugin config first, or falls back to the host config file - </summary> - <param name="plugin"></param> - <param name="propName">The config property name to retrieve</param> - <returns>A <see cref="T:System.Collections.Generic.Dictionary`2"/> of top level configuration elements for the type</returns> - <exception cref="T:System.ObjectDisposedException"></exception> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Configuration.ConfigurationExtensions.GetConfigForType(VNLib.Plugins.PluginBase,System.Type)"> - <summary> - Retrieves a top level configuration dictionary of elements for the specified type. - The type must contain a <see cref="T:VNLib.Plugins.Extensions.Loading.Configuration.ConfigurationNameAttribute"/> - </summary> - <param name="plugin"></param> - <param name="type">The type to get configuration data for</param> - <returns>A <see cref="T:System.Collections.Generic.Dictionary`2"/> of top level configuration elements for the type</returns> - <exception cref="T:System.ObjectDisposedException"></exception> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Configuration.ConfigurationExtensions.GetConfig(VNLib.Plugins.PluginBase,System.Object)"> - <summary> - Shortcut extension for <see cref="M:VNLib.Plugins.Extensions.Loading.Configuration.ConfigurationExtensions.GetConfigForType``1(VNLib.Plugins.PluginBase)"/> to get - config of current class - </summary> - <param name="obj">The object that a configuration can be retrieved for</param> - <param name="plugin">The plugin containing configuration variables</param> - <returns>A <see cref="T:System.Collections.Generic.Dictionary`2"/> of top level configuration elements for the type</returns> - <exception cref="T:System.ObjectDisposedException"></exception> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Configuration.ConfigurationExtensions.HasConfigForType``1(VNLib.Plugins.PluginBase)"> - <summary> - Determines if the current plugin configuration contains the require properties to initialize - the type - </summary> - <typeparam name="T"></typeparam> - <param name="plugin"></param> - <returns>True if the plugin config contains the require configuration property</returns> - </member> - <member name="T:VNLib.Plugins.Extensions.Loading.Events.AsyncIntervalAttribute"> - <summary> - When added to a method schedules it as a callback on a specified interval when - the plugin is loaded, and stops when unloaded - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Events.AsyncIntervalAttribute.#ctor(System.Int32)"> - <summary> - Intializes the <see cref="T:VNLib.Plugins.Extensions.Loading.Events.AsyncIntervalAttribute"/> with the specified timeout in milliseconds - </summary> - <param name="milliseconds">The interval in milliseconds</param> - </member> - <member name="T:VNLib.Plugins.Extensions.Loading.Events.IntervalResultionType"> - <summary> - The configurable event interval resulution type - </summary> - </member> - <member name="F:VNLib.Plugins.Extensions.Loading.Events.IntervalResultionType.Milliseconds"> - <summary> - Specifies event interval resolution in milliseconds - </summary> - </member> - <member name="F:VNLib.Plugins.Extensions.Loading.Events.IntervalResultionType.Seconds"> - <summary> - Specifies event interval resolution in seconds - </summary> - </member> - <member name="F:VNLib.Plugins.Extensions.Loading.Events.IntervalResultionType.Minutes"> - <summary> - Specifies event interval resolution in minutes - </summary> - </member> - <member name="F:VNLib.Plugins.Extensions.Loading.Events.IntervalResultionType.Hours"> - <summary> - Specifies event interval resolution in hours - </summary> - </member> - <member name="T:VNLib.Plugins.Extensions.Loading.Events.ConfigurableAsyncIntervalAttribute"> - <summary> - When added to a method schedules it as a callback on a specified interval when - the plugin is loaded, and stops when unloaded - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Events.ConfigurableAsyncIntervalAttribute.#ctor(System.String,VNLib.Plugins.Extensions.Loading.Events.IntervalResultionType)"> - <summary> - Initializes a <see cref="T:VNLib.Plugins.Extensions.Loading.Events.ConfigurableAsyncIntervalAttribute"/> with the specified - interval property name - </summary> - <param name="configPropName">The configuration property name for the event interval</param> - <param name="resolution">The time resoltion for the event interval</param> - </member> - <member name="T:VNLib.Plugins.Extensions.Loading.Events.EventHandle"> - <summary> - Represents a handle to a scheduled event interval that is managed by the plugin but may be cancled by disposing the instance - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Events.EventHandle.Pause"> - <summary> - Pauses the event timer until the <see cref="T:VNLib.Utils.OpenHandle"/> is released or disposed - then resumes to the inital interval period - </summary> - <returns>A <see cref="T:VNLib.Utils.OpenHandle"/> that restores the timer to its initial state when disposed</returns> - <exception cref="T:System.ObjectDisposedException"></exception> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Events.EventHandle.Free"> - <inheritdoc/> - </member> - <member name="T:VNLib.Plugins.Extensions.Loading.Events.EventManagment"> - <summary> - Provides event schedueling extensions for plugins - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Events.EventManagment.ScheduleInterval``1(VNLib.Plugins.PluginBase,System.Func{``0,System.Threading.Tasks.Task},``0,System.TimeSpan)"> - <summary> - Schedules an asynchronous event interval for the current plugin, that is active until canceled or until the plugin unloads - </summary> - <typeparam name="TState">Stateful event argument</typeparam> - <param name="plugin"></param> - <param name="asyncCallback">An asyncrhonous callback method.</param> - <param name="state"></param> - <param name="interval">The event interval</param> - <returns>An <see cref="T:VNLib.Plugins.Extensions.Loading.Events.EventHandle"/> that can manage the interval state</returns> - <exception cref="T:System.ObjectDisposedException"></exception> - <remarks>If exceptions are raised during callback execution, they are written to the plugin's default log provider</remarks> - </member> - <member name="T:VNLib.Plugins.Extensions.Loading.LoadingExtensions"> - <summary> - Provides common loading (and unloading when required) extensions for plugins - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.LoadingExtensions.GetPasswords(VNLib.Plugins.PluginBase)"> - <summary> - Gets the plugins ambient <see cref="T:VNLib.Plugins.Essentials.Accounts.PasswordHashing"/> if loaded, or loads it if required. This class will - be unloaded when the plugin us unloaded. - </summary> - <param name="plugin"></param> - <returns>The ambient <see cref="T:VNLib.Plugins.Essentials.Accounts.PasswordHashing"/></returns> - <exception cref="T:System.OverflowException"></exception> - <exception cref="T:System.Collections.Generic.KeyNotFoundException"></exception> - <exception cref="T:System.ObjectDisposedException"></exception> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.LoadingExtensions.GetUserManager(VNLib.Plugins.PluginBase)"> - <summary> - Gets or loads the plugin's ambient <see cref="T:VNLib.Plugins.Essentials.Users.UserManager"/>, with the specified user-table name, - or the default table name - </summary> - <param name="plugin"></param> - <returns>The ambient <see cref="T:VNLib.Plugins.Essentials.Users.UserManager"/> for the current plugin</returns> - <exception cref="T:System.Collections.Generic.KeyNotFoundException"></exception> - <exception cref="T:System.ObjectDisposedException"></exception> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.LoadingExtensions.IsDebug(VNLib.Plugins.PluginBase)"> - <summary> - Determintes if the current plugin config has a debug propety set - </summary> - <param name="plugin"></param> - <returns>True if debug mode is enabled, false otherwise</returns> - <exception cref="T:System.ObjectDisposedException"></exception> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.LoadingExtensions.ThrowIfUnloaded(VNLib.Plugins.PluginBase)"> - <summary> - Internal exception helper to raise <see cref="T:System.ObjectDisposedException"/> if the plugin has been unlaoded - </summary> - <param name="plugin"></param> - <exception cref="T:System.ObjectDisposedException"></exception> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Routing.RoutingExtensions.Route``1(VNLib.Plugins.PluginBase,System.String)"> - <summary> - Constructs and routes the specific endpoint type for the current plugin - </summary> - <typeparam name="T">The <see cref="T:VNLib.Plugins.IEndpoint"/> type</typeparam> - <param name="plugin"></param> - <param name="pluginConfigPathName">The path to the plugin sepcific configuration property</param> - <exception cref="T:System.Reflection.TargetInvocationException"></exception> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Routing.RoutingExtensions.Route``1(VNLib.Plugins.PluginBase)"> - <summary> - Constructs and routes the specific endpoint type for the current plugin - </summary> - <typeparam name="T">The <see cref="T:VNLib.Plugins.IEndpoint"/> type</typeparam> - <param name="plugin"></param> - <exception cref="T:System.Reflection.TargetInvocationException"></exception> - </member> - <member name="T:VNLib.Plugins.Extensions.Loading.Sql.SqlDbConnectionLoader"> - <summary> - Provides common basic SQL loading extensions for plugins - </summary> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Sql.SqlDbConnectionLoader.GetConnectionFactory(VNLib.Plugins.PluginBase)"> - <summary> - Gets (or loads) the ambient sql connection factory for the current plugin - </summary> - <param name="plugin"></param> - <returns>The ambient <see cref="T:System.Data.Common.DbConnection"/> factory</returns> - <exception cref="T:System.Collections.Generic.KeyNotFoundException"></exception> - <exception cref="T:System.ObjectDisposedException"></exception> - </member> - <member name="M:VNLib.Plugins.Extensions.Loading.Sql.SqlDbConnectionLoader.GetContextOptions(VNLib.Plugins.PluginBase)"> - <summary> - Gets (or loads) the ambient <see cref="T:Microsoft.EntityFrameworkCore.DbContextOptions"/> configured from - the ambient sql factory - </summary> - <param name="plugin"></param> - <returns>The ambient <see cref="T:Microsoft.EntityFrameworkCore.DbContextOptions"/> for the current plugin</returns> - <exception cref="T:System.Collections.Generic.KeyNotFoundException"></exception> - <exception cref="T:System.ObjectDisposedException"></exception> - <remarks>If plugin is in debug mode, writes log data to the default log</remarks> - </member> - </members> -</doc> |