• Api Documentation
Show / Hide Table of Contents
  • Softadmin.Api
    • AdminMessageException
    • CustomComponent
    • ICookies
    • ICredentialsStore
    • 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

Class Plugin

Base class of all plugins.

Inheritance
System.Object
Plugin
LoginPlugin
UserAuthenticationPlugin
LogoutPlugin
PagePlugin
Namespace: Softadmin.Api
Assembly: Softadmin.Api.dll
Syntax
public abstract class Plugin : MarshalByRefObject
Remarks

Plugins are developer-provided classes that add extra functionality to the platform.

Properties

Cookies

Gets or sets the current cookies.

Declaration
public ICookies Cookies { get; set; }
Property Value
Type Description
ICookies

Environment

Gets or sets information about the current environment.

Declaration
public IEnvironment Environment { get; set; }
Property Value
Type Description
IEnvironment

RequestFactory

Gets or sets the plugin's database request factory. All requests will use the procedure that the plugin is bound to.

Declaration
public IDbRequestFactory RequestFactory { get; set; }
Property Value
Type Description
IDbRequestFactory

SessionVariables

Gets or sets the current session variables.

Declaration
public ISessionVariables SessionVariables { get; set; }
Property Value
Type Description
ISessionVariables

SystemSettings

Gets or sets the current system settings.

Declaration
public ISystemSettings SystemSettings { get; set; }
Property Value
Type Description
ISystemSettings

Methods

CreateObjRef(Type)

Declaration
public sealed override System.Runtime.Remoting.ObjRef CreateObjRef(Type requestedType)
Parameters
Type Name Description
Type requestedType
Returns
Type Description
System.Runtime.Remoting.ObjRef
In This Article
Back to top Generated by DocFX