Skip to main content

Back

Index

Classes

ClassDescription
Filters-
Sorts-

Interfaces

InterfaceDescription
AdminForthBulkAction-
AdminForthConfig-
AdminForthConfigCustomization-
AdminForthForeignResource-
AdminForthInputConfigMain configuration object for AdminForth
AdminForthResourceResource describes one table or collection in database. AdminForth generates set of pages for 'list', 'show', 'edit', 'create', 'filter' operations for each resource.
AdminForthResourceColumn-
AdminForthResourceColumnInput-
AdminForthResourceInput-
HttpExtra-
IAdminForth-
IAdminForthAuth-
IAdminForthDataSourceConnector-
IAdminForthDataSourceConnectorBaseInterface that exposes methods to interact with AdminForth in standard way
IAdminForthDataSourceConnectorConstructor-
IAdminForthFilter-
IAdminForthHttpResponse-
IAdminForthPlugin-
IAdminForthRestAPI-
IAdminForthSort-
ICodeInjector-
IConfigValidator-
IExpressHttpServerImplement this interface to create custom HTTP server adapter for AdminForth.
IHttpServerImplement this interface to create custom HTTP server adapter for AdminForth.
IOperationalResource-
IWebSocketBroker-
IWebSocketClient-
ResourceOptions-
ResourceOptionsInputGeneral options for resource.

Type Aliases

Type aliasDescription
AdminForthDataSourceData source describes database connection which will be used to fetch data for resources. Each resource should use one data source.
AfterCreateSaveFunction-
AfterDataSourceResponseFunctionModify response to change how data is returned after fetching from database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
AfterDeleteSaveFunctionModify record to change how data is saved to database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
AfterEditSaveFunction-
AllowedActionValueDefines whether user has access to an action, can statically be Boolean or function which returns Boolean or string with error message
AllowedActions-
AllowedActionsInputObject which describes allowed actions for user.
BeforeCreateSaveFunction-
BeforeDataSourceRequestFunctionModify query to change how data is fetched from database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
BeforeDeleteSaveFunctionModify record to change how data is saved to database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
BeforeEditSaveFunction-
BeforeLoginConfirmationFunctionAllow to get user data before login confirmation, will triger when user try to login.
FDataFilter-
FDataSort-
ShowIn-
ShowInInputObject which describes on what pages should column be displayed on.
ShowInLegacyInput-
ShowInModernInput-