• Api Documentation
Show / Hide Table of Contents
  • Softadmin.Api
    • AdminMessageException
    • CustomComponent
    • ICookies
    • IEnvironment
    • IForwardState
    • IHttpHeaders
    • IParameters
    • ISessionVariables
    • ISystemSettings
    • Plugin
  • Softadmin.Api.Database
    • IDbRequest
    • IDbRequestFactory
  • Softadmin.Api.Diagnostics
    • ILogger
  • Softadmin.Api.Login
    • IUserState
    • LoginPlugin
    • PostLoginPlugin
    • PreLoginPlugin
    • UserAuthenticationPlugin
  • Softadmin.Api.Logout
    • LogoutPlugin
  • Softadmin.Api.Page
    • ICustomPage
    • PagePlugin
  • Softadmin.Api.Ui
    • IDebugWindow
    • IProgressWindow

Namespace Softadmin.Api

Root namespace for the Softadmin® public API.

Using the API

To write code that extends Softadmin® you'll subclass one of:

  • CustomComponent
  • PreLoginPlugin
  • PostLoginPlugin
  • UserAuthenticationPlugin
  • LogoutPlugin
  • PagePlugin
Caution

Unless noted otherwise no API class should be assumed to be thread-safe.

Classes

AdminMessageException

Custom components and some plugins can throw exceptions of this type to show a helpful error message to the user.

CustomComponent

Subclass to implement components that can be called by Custom Component pages.

Plugin

Base class of all plugins.

Interfaces

ICookies

Provides read-only access to the HTTP cookies.

IEnvironment

Exposes information about the Softadmin® system.

IForwardState

Where the user should be forwarded to.

IHttpHeaders

Provides access to the HTTP headers passed with the page request.

IParameters

Wraps the passing fields and parameters for a page and supplies conversion to a fixed number of types.

ISessionVariables

Provides access to the session variables.

ISystemSettings

Provides access to the system settings, also known as application variables.

Back to top Generated by DocFX