GSF.Web by Grid Protection Alliance

<PackageReference Include="GSF.Web" Version="2.1.262-beta" />

---

API Diff between 2.1.262-beta and 2.4.10-beta

46 Additions 89 Removals

GSF.Web

• public class PostData
• public static class WebExtensions
  • public const string PostDataKey = "GSF_PostData"
  • public static void AddBasicAuthenticationHeader(this HttpClient client, string userName, string password)
  • public static void AddEmbeddedResourceAssembly(Assembly assembly)
  • public static bool EmbeddedResourceExists(string resourceName)
  • public static string FixForwardSpacing(this string script, int spaces = 4, bool forceFixed = false)
  • public static PostData GetPostData(this HttpRequestMessage request)
  • public static Task<PostData> GetPostDataAsync(this HttpRequestMessage request, CancellationToken cancellationToken)
  • public static string FixForwardSpacing(this string script, int spaces = 4)
  • public static MvcHtmlString IncludeResouce(this HtmlHelper helper, string resourceName)
  • public static MvcHtmlString IncludeUrl(this HtmlHelper helper, string url)
  • public static Stream OpenEmbeddedResourceStream(string resourceName)
  • public static DateTime ParseJsonTimestamp(this string timestamp)
  • public static MvcHtmlString RenderResource(this HtmlHelper helper, string resourceName, Type modelType = null, object model = null)
  • public static MvcHtmlString RenderResource<T>(this HtmlHelper helper, string resourceName, T model)
  • public static string ToAbsoluteUrl(this HtmlHelper helper, string url)

GSF.Web.Embedded

• public class EmbeddedResourceProvider : VirtualPathProvider

GSF.Web.Hosting

• public interface IHostedHttpHandler
• public class ReadonlyWebServerOptions
• public class WebPageController : ApiController
  • public AdoDataConnection Database { get; set; }
  • public string DefaultWebPage { get; set; }
  • public Task<HttpResponseMessage> GetPage(string pageName, CancellationToken cancellationToken)
  • public Task<HttpResponseMessage> PostPage(string pageName, CancellationToken cancellationToken)
  • public static IDependencyResolver GetDependencyResolver(WebServer webServer, string defaultWebPage = null, object model = null, Type modelType = null, AdoDataConnection connection = null)
  • public Task<HttpResponseMessage> GetPage()
  • public Task<HttpResponseMessage> GetPage(string pageName)
  • public Task<HttpResponseMessage> GetPage(string folder1, string pageName)
  • public Task<HttpResponseMessage> GetPage(string folder1, string folder2, string pageName)
  • public Task<HttpResponseMessage> GetPage(string folder1, string folder2, string folder3, string pageName)
  • public Task<HttpResponseMessage> GetPage(string folder1, string folder2, string folder3, string folder4, string pageName)
  • public Task<HttpResponseMessage> GetPage(string folder1, string folder2, string folder3, string folder4, string folder5, string pageName)
  • public Task<HttpResponseMessage> PostPage(string pageName, object postData)
  • public Task<HttpResponseMessage> PostPage(string folder1, string pageName, object postData)
  • public Task<HttpResponseMessage> PostPage(string folder1, string folder2, string pageName, object postData)
  • public Task<HttpResponseMessage> PostPage(string folder1, string folder2, string folder3, string pageName, object postData)
  • public Task<HttpResponseMessage> PostPage(string folder1, string folder2, string folder3, string folder4, string pageName, object postData)
  • public Task<HttpResponseMessage> PostPage(string folder1, string folder2, string folder3, string folder4, string folder5, string pageName, object postData)
• public static class WebPageControllerAppBuilderExtensions
• public class WebServer
  • public ReadonlyWebServerOptions Options { get; }
  • public bool ClientCacheEnabled { get; set; }
  • public string WebRootPath { get; }
  • public WebServer(WebServerOptions options = null, IRazorEngine razorEngineCS = null, IRazorEngine razorEngineVB = null)
  • public WebServer(string webRootPath = null, IRazorEngine razorEngineCS = null, IRazorEngine razorEngineVB = null)
  • public Task<HttpResponseMessage> RenderResponse(HttpRequestMessage request, string pageName, CancellationToken cancellationToken, object model = null, Type modelType = null, AdoDataConnection database = null)
  • public Task<HttpResponseMessage> RenderResponse(HttpRequestMessage request, string pageName, object model = null, Type modelType = null, AdoDataConnection database = null, object postData = null)
• public class WebServerOptions

GSF.Web.Hubs

• public class DataContextHubClient : HubClientBase
• public class DataContextOperations : HubClientOperationsBase<DataContextHubClient>
• public abstract class HubClientBase : IHubClient, IDisposable
• public abstract class HubClientOperationsBase<T> where T : IHubClient
• public interface IHubClient : IDisposable
• public interface IRecordOperationsHub : IDisposable
• public class RecordOperationsCache
• public class RecordOperationsCache<T> : RecordOperationsCache where T : IHub
• public abstract class RecordOperationsHub<T> : Hub, IRecordOperationsHub, IDisposable where T : IHub, IRecordOperationsHub

GSF.Web.Model

• public class DataContext : IDisposable
  • public const string UrlValidation = "^(?:(?:[a-zA-Z][a-zA-Z0-9.+-]*:\\/\\/)?[a-zA-Z0-9][a-zA-Z0-9.-]*(?::[0-9]+)?(?:\\/[^ \"]*)?|mailto:[a-zA-Z0-9!#$%&'*+-\\/=?^_`{|}~][a-zA-Z0-9!#$%&'*+-\\/=?^_`{|}~.]*@[a-zA-Z0-9][a-zA-Z0-9.-]*)$"
  • public Dictionary<Type, IEnumerable<KeyValuePair<string, string>>> CustomTableOperationTokens { get; }
  • public AdoSecurityProvider SecurityProvider { get; }
  • public string AddSelectField<TModel, TOption>(string fieldName, string optionValueFieldName, string optionLabelFieldName = null, string optionSortFieldName = null, string fieldLabel = null, string fieldID = null, string groupDataBinding = null, string labelDataBinding = null, string requiredDataBinding = null, string customDataBinding = null, string dependencyFieldName = null, string optionDataBinding = null, string toolTip = null, bool initialFocus = false, RecordRestriction restriction = null, bool allowUnset = false, string unsetCaption = "Select value...", bool addEmptyRow = false, string emptyRowValue = "", bool showNoRecordOption = false, string noRecordValue = "-1", string noRecordText = "No records")
  • public string AddSelectField<TOption>(string fieldName, bool required, string optionValueFieldName, string optionLabelFieldName = null, string optionSortFieldName = null, string fieldLabel = null, string fieldID = null, string groupDataBinding = null, string labelDataBinding = null, string requiredDataBinding = null, string customDataBinding = null, string dependencyFieldName = null, string optionDataBinding = null, string toolTip = null, bool initialFocus = false, RecordRestriction restriction = null, bool allowUnset = false, string unsetCaption = "Select value...", bool addEmptyRow = false, string emptyRowValue = "", bool showNoRecordOption = false, string noRecordValue = "-1", string noRecordText = "No records")
  • public string AddSelectField<TModel>(Dictionary<string, string> options, string fieldName, bool required, string fieldLabel = null, string fieldID = null, string groupDataBinding = null, string labelDataBinding = null, string requiredDataBinding = null, string customDataBinding = null, string dependencyFieldName = null, string optionDataBinding = null, string toolTip = null, bool initialFocus = false, bool allowUnset = false, string unsetCaption = "Select value...", bool addEmptyRow = false, string emptyRowValue = "", bool showNoRecordOption = false, string noRecordValue = "-1", string noRecordText = "No records")
  • public string AddSelectFieldFromEnum<TModel, TOption>(string fieldName, string fieldLabel = null, string fieldID = null, string groupDataBinding = null, string labelDataBinding = null, string requiredDataBinding = null, string customDataBinding = null, string dependencyFieldName = null, string optionDataBinding = null, string toolTip = null, bool initialFocus = false, bool allowUnset = false, string unsetCaption = "Select value...", bool addEmptyRow = false, string emptyRowValue = "", bool showNoRecordOption = false, string noRecordValue = "-1", string noRecordText = "No records") where TOption : struct, IConvertible
  • public string AddSelectFieldFromEnum<TOption>(string fieldName, bool required, string fieldLabel = null, string fieldID = null, string groupDataBinding = null, string labelDataBinding = null, string requiredDataBinding = null, string customDataBinding = null, string dependencyFieldName = null, string optionDataBinding = null, string toolTip = null, bool initialFocus = false, bool allowUnset = false, string unsetCaption = "Select value...", bool addEmptyRow = false, string emptyRowValue = "", bool showNoRecordOption = false, string noRecordValue = "-1", string noRecordText = "No records") where TOption : struct, IConvertible
  • public string AddSelectField<TModel, TOption>(string fieldName, string optionValueFieldName, string optionLabelFieldName = null, string optionSortFieldName = null, string fieldLabel = null, string fieldID = null, string groupDataBinding = null, string labelDataBinding = null, string requiredDataBinding = null, string customDataBinding = null, string dependencyFieldName = null, string optionDataBinding = null, string toolTip = null, bool initialFocus = false, RecordRestriction restriction = null, bool showNoRecordOption = false, string noRecordValue = "-1", string noRecordText = "No records")
  • public string AddSelectField<TOption>(string fieldName, bool required, string optionValueFieldName, string optionLabelFieldName = null, string optionSortFieldName = null, string fieldLabel = null, string fieldID = null, string groupDataBinding = null, string labelDataBinding = null, string requiredDataBinding = null, string customDataBinding = null, string dependencyFieldName = null, string optionDataBinding = null, string toolTip = null, bool initialFocus = false, RecordRestriction restriction = null, bool showNoRecordOption = false, string noRecordValue = "-1", string noRecordText = "No records")
  • public void EstablishUserRolesForPage<TModel>(RecordOperationsCache cache, object viewBag)
  • public void EstablishUserRolesForPage(Type model, RecordOperationsCache cache, object viewBag)
  • public void EstablishUserRolesForPage<TModel>(RecordOperationsCache cache, object viewBag)
  • public void EstablishUserRolesForPage(Type model, RecordOperationsCache cache, object viewBag)
  • public string RenderLookupFunction<TModel>(string valueFieldName, string keyFieldName = "ID", string lookupFunctionName = null, string arrayName = null)
  • public string GetScriptResource(string scriptName)
  • public string RenderViewModelConfiguration<TModel>(RecordOperationsCache cache, object viewBag, string defaultSortField = null, string hubClassName = "GSF.Web.Security.SecurityHub", string hubScriptName = "securityHub", object[] parentKeys)
  • public string RenderViewModelConfiguration<TModel>(RecordOperationsCache cache, object viewBag, string defaultSortField = null, string hubName = "dataHub", object[] parentKeys)
  • public bool UserIsInGroup(SecurityPrincipal securityPrincipal, string group)
  • public bool UserIsInGroup(SecurityPrincipal securityPrincipal, string[] groups)
  • public bool UserIsInRole(SecurityPrincipal securityPrincipal, string role)
  • public bool UserIsInRole(SecurityPrincipal securityPrincipal, string[] roles)
  • public bool UserIsInGroup(string group)
  • public bool UserIsInGroup(string[] groups)
  • public bool UserIsInRole(string role)
  • public bool UserIsInRole(string[] roles)
• public abstract class ExtendedTemplateBase : TemplateBase
• public abstract class ExtendedTemplateBase<T> : TemplateBase<T>
• public class HtmlHelper
• public interface IRecordOperationsHub : IDisposable
  • RecordOperationsCache RecordOperationsCache { get; }
• public class ModelController<T> : ApiController
• public class RazorEngine<TLanguage> : IRazorEngine, IRazorEngineService, IDisposable where TLanguage : LanguageConstraint
  • public void Compile(string name, Type modelType = null)
  • public Task PreCompile(Action<Exception> exceptionHandler, string templatePath)
  • public Task PreCompile(Type modelType, Action<Exception> exceptionHandler, string templatePath)
• public class RazorView
  • public ReadonlyWebServerOptions WebServerOptions { get; set; }
  • public RazorView(IRazorEngine razorEngine, string templateName, object model = null, Type modelType = null, Type pagedViewModelDataType = null, Type pagedViewModelHubType = null, AdoDataConnection database = null, Action<Exception> exceptionHandler = null, ReadonlyWebServerOptions webServerOptions = null)
  • public RazorView(IRazorEngine razorEngine, string templateName, object model = null, Type modelType = null, Type pagedViewModelDataType = null, Type pagedViewModelHubType = null, AdoDataConnection database = null, Action<Exception> exceptionHandler = null)
  • public string Execute(HttpRequestMessage request, HttpResponseMessage response)
  • public Task<string> ExecuteAsync(HttpRequestMessage request, HttpResponseMessage response, CancellationToken cancellationToken)
  • public string Execute(HttpRequestMessage request, object postData)
  • public Task ExecuteAsync(HttpRequestMessage requestMessage, object postData)
• public class UrlHelper
• public class RecordOperationsCache
  • public RecordOperationsCache(Type hub)
  • public Tuple<string, string>[] GetRecordOperations<TModel>()
  • public Tuple<string, string>[] GetRecordOperations(Type model)

GSF.Web.Model.Handlers

• public class CsvDownloadHandler : IHttpHandler, IHostedHttpHandler

GSF.Web.Model.HubOperations

• public static class DirectoryBrowserOperations
• public interface IDirectoryBrowserOperations

GSF.Web.Security

• public static class AntiForgery
• public static class AntiForgeryConfig
• public static class AppBuilderExtensions
• public class AuthenticationHandler : AuthenticationHandler<AuthenticationOptions>
• public class AuthenticationMiddleware : AuthenticationMiddleware<AuthenticationOptions>
• public sealed class AuthenticationOptions : AuthenticationOptions
• public class AuthorizationCache
  • public static void CacheAuthorization(string userName, string securitySettingsCategory)
• public class AuthorizeControllerRoleAttribute : FilterAttribute, IAuthorizationFilter, IExceptionFilter
  • public string SecuritySettingsCategory { get; set; }
  • public string SettingsCategory { get; set; }
• public class AuthorizeHubRoleAttribute : AuthorizeAttribute
  • public string SecuritySettingsCategory { get; set; }
  • public string SettingsCategory { get; set; }
• public static class HttpConfigurationExtensions
• public interface IAntiForgeryAdditionalDataProvider
• public sealed class ReadonlyAuthenticationOptions
• public class SecurityHub : Hub, IRecordOperationsHub, IDisposable
  • public RecordOperationsCache RecordOperationsCache { get; }
  • public SecurityHub(Action<string, UpdateType> logStatusMessageFunction, Action<Exception> logExceptionFunction)
  • public SecurityHub(string settingsCategory, Action<string, UpdateType> logStatusMessageFunction, Action<Exception> logExceptionFunction)
  • public SecurityHub(DataContext dataContext)
  • public static RecordOperationsCache GetRecordOperationsCache()
  • public Guid GetDefaultNodeID()
  • public bool Logout(string sessionCookieValue)
• public class SessionHandler : DelegatingHandler
• public class ValidateRequestVerificationTokenAttribute : ActionFilterAttribute

GSF.Web.Shared

• public static class Resources
• public class SharedHub : RecordOperationsHub<SharedHub>
• public class SubscriberHub : Hub

GSF.Web.Shared.Model

• public class Company
• public class Statistic
• public class Vendor
• public class VendorDevice