api.rst

API Reference

Here are all public uAdmin functions, their format, and how to use them in the project.

• Full List
• Categorized List

Full List

Back To Top

• uadmin.ABTest
• uadmin.ABTestClick
• uadmin.ABTestType
• uadmin.ABTestValue
• uadmin.Action
• uadmin.AdminPage
• uadmin.ALERT
• uadmin.All
• uadmin.AllowedHosts
• uadmin.AllowedIPs
• uadmin.Approval
• uadmin.ApprovalAction
• uadmin.ApprovalHandleFunc
• uadmin.Avg
• uadmin.AvgTable
• uadmin.BindIP
• uadmin.BlockedIPs
• uadmin.CacheTranslation
• uadmin.CheckRateLimit
• uadmin.Choice
• uadmin.ClearDB
• uadmin.CookieTimeout
• uadmin.Count
• uadmin.CountTable
• uadmin.CRITICAL
• uadmin.CachePermissions
• uadmin.CacheSessions
• uadmin.CheckCSRF
• uadmin.CustomTranslation
• uadmin.DashboardMenu
• uadmin.Database
• uadmin.DataType
• uadmin.DBSettings
• uadmin.DEBUG
• uadmin.DebugDB
• uadmin.DefaultMediaPermission
• uadmin.Delete
• uadmin.DeleteList
• uadmin.DisableAdminUI
• uadmin.EmailFrom
• uadmin.EmailPassword
• uadmin.EmailSMTPServer
• uadmin.EmailSMTPServerPort
• uadmin.EmailUsername
• uadmin.EMERGENCY
• uadmin.EncryptKey
• uadmin.ERROR
• uadmin.ErrorHandleFunc
• uadmin.F
• uadmin.FavIcon
• uadmin.FieldList
• uadmin.FieldType
• uadmin.Filter
• uadmin.FilterBuilder
• uadmin.FilterList
• uadmin.FilterSorted
• uadmin.FilterSortedTable
• uadmin.FilterSortedValue
• uadmin.FilterTable
• uadmin.GenerateBase32
• uadmin.GenerateBase64
• uadmin.Get
• uadmin.GetABTest
• uadmin.GetActiveLanguages
• uadmin.GetDB
• uadmin.GetDefaultLanguage
• uadmin.GetFieldsAPI
• uadmin.GetForm
• uadmin.GetID
• uadmin.GetImageSizer
• uadmin.GetModelsAPI
• uadmin.GetRemoteIP
• uadmin.GetSetting
• uadmin.GetSorted
• uadmin.GetSortedTable
• uadmin.GetString
• uadmin.GetStringer
• uadmin.GetTable
• uadmin.GetUserFromRequest
• uadmin.GetValueSorted
• uadmin.GroupPermission
• uadmin.Handler
• uadmin.HideInDashboarder
• uadmin.HTTPLogFormat
• uadmin.IncrementMetric
• uadmin.INFO
• uadmin.IsAuthenticated
• uadmin.JSONMarshal
• uadmin.Language
• uadmin.Log
• uadmin.Logo
• uadmin.LogAdd
• uadmin.LogDelete
• uadmin.LogEdit
• uadmin.LogHTTPRequests
• uadmin.Login
• uadmin.Login2FA
• uadmin.Logout
• uadmin.LogRead
• uadmin.LogTrail
• uadmin.Max
• uadmin.MaxImageHeight
• uadmin.MaxImageWidth
• uadmin.MaxTable
• uadmin.MaxUploadFileSize
• uadmin.Min
• uadmin.MinTable
• uadmin.Model
• uadmin.ModelList
• uadmin.ModelSchema
• uadmin.NewMetric
• uadmin.NewModel
• uadmin.NewModelArray
• uadmin.OptimizeSQLQuery
• uadmin.OK
• uadmin.OTPAlgorithm
• uadmin.OTPDigits
• uadmin.OTPPeriod
• uadmin.OTPSkew
• uadmin.PageLength
• uadmin.PasswordAttempts
• uadmin.PasswordTimeout
• uadmin.Port
• uadmin.Preload
• uadmin.PublicMedia
• uadmin.RateLimit
• uadmin.RateLimitBurst
• uadmin.Register
• uadmin.RegisterInlines
• uadmin.RenderHTML
• uadmin.RenderMultiHTML
• uadmin.ReportingLevel
• uadmin.ReportTimeStamp
• uadmin.RestrictSessionIP
• uadmin.RetainMediaVersions
• uadmin.ReturnJSON
• uadmin.RootURL
• uadmin.Salt
• uadmin.Save
• uadmin.Schema
• uadmin.SendEmail
• uadmin.ServerReady
• uadmin.Session
• uadmin.SetMetric
• uadmin.SetSessionCookie
• uadmin.Setting
• uadmin.SettingCategory
• uadmin.SiteName
• uadmin.SQLInjection
• uadmin.StartSecureServer
• uadmin.StartServer
• uadmin.StaticHandler
• uadmin.Std
• uadmin.StdTable
• uadmin.Sum
• uadmin.SumTable
• uadmin.Syslogf
• uadmin.SystemMetrics
• uadmin.Tf
• uadmin.Theme
• uadmin.TimeMetric
• uadmin.Trail
• uadmin.TrailLoggingLevel
• uadmin.Translate
• uadmin.TranslateSchema
• uadmin.Update
• uadmin.User
• uadmin.UserGroup
• uadmin.UserMetrics
• uadmin.UserPermission
• uadmin.ValidateIP
• uadmin.Version
• uadmin.VersionCodeName
• uadmin.WARNING
• uadmin.WORKING

Categorized List

Back To Top

• A/B Test Functions
• Approval Functions
• Basic Functions
• Database Functions
• Email Functions
• For Customizing Records
• For Fetching Records
• Handler Functions
• Language Functions
• Log Functions
• Metric Functions
• Model Functions
• Network Functions
• Print Functions
• Register Functions
• Security Functions
• Setting Functions
• User Functions

A/B Test Functions

Back To Top (Categorized List)

• uadmin.ABTest
• uadmin.ABTestClick
• uadmin.ABTestType
• uadmin.ABTestValue
• uadmin.FieldList
• uadmin.GetABTest
• uadmin.ModelList

Approval Functions

Back To Top (Categorized List)

• uadmin.Approval
• uadmin.ApprovalAction
• uadmin.ApprovalHandleFunc

Basic Functions

Back To Top (Categorized List)

• uadmin.DisableAdminUI
• uadmin.FavIcon
• uadmin.Logo
• uadmin.MaxImageHeight
• uadmin.MaxImageWidth
• uadmin.MaxUploadFileSize
• uadmin.PageLength
• uadmin.RetainMediaVersions
• uadmin.ServerReady
• uadmin.SiteName
• uadmin.StartServer
• uadmin.Theme

Database Functions

Back To Top (Categorized List)

• uadmin.ClearDB
• uadmin.Database
• uadmin.DBSettings
• uadmin.DebugDB
• uadmin.GetDB
• uadmin.OptimizeSQLQuery

Email Functions

Back To Top (Categorized List)

• uadmin.EmailFrom
• uadmin.EmailPassword
• uadmin.EmailSMTPServer
• uadmin.EmailSMTPServerPort
• uadmin.EmailUsername
• uadmin.SendEmail

For Customizing Records

Back To Top (Categorized List)

• uadmin.Delete
• uadmin.DeleteList
• uadmin.F
• uadmin.ModelSchema
• uadmin.Save
• uadmin.Schema
• uadmin.Update

For Fetching Records

Back To Top (Categorized List)

• uadmin.AdminPage
• uadmin.All
• uadmin.Avg
• uadmin.AvgTable
• uadmin.Choice
• uadmin.Count
• uadmin.CountTable
• uadmin.Filter
• uadmin.FilterBuilder
• uadmin.FilterList
• uadmin.FilterSorted
• uadmin.FilterSortedTable
• uadmin.FilterSortedValue
• uadmin.FilterTable
• uadmin.Get
• uadmin.GetFieldsAPI
• uadmin.GetForm
• uadmin.GetID
• uadmin.GetImageSizer
• uadmin.GetModelsAPI
• uadmin.GetSorted
• uadmin.GetSortedTable
• uadmin.GetString
• uadmin.GetStringer
• uadmin.GetTable
• uadmin.GetValueSorted
• uadmin.Max
• uadmin.MaxTable
• uadmin.Min
• uadmin.MinTable
• uadmin.Preload
• uadmin.RenderHTML
• uadmin.RenderMultiHTML
• uadmin.Std
• uadmin.StdTable
• uadmin.Sum
• uadmin.SumTable

Handler Functions

Back To Top (Categorized List)

• uadmin.Handler
• uadmin.StaticHandler
• uadmin.UploadImageHandler

Language Functions

Back To Top (Categorized List)

• uadmin.CacheTranslation
• uadmin.CustomTranslation
• uadmin.GetActiveLanguages
• uadmin.GetDefaultLanguage
• uadmin.Language
• uadmin.Tf
• uadmin.Translate
• uadmin.TranslateSchema

Log Functions

Back To Top (Categorized List)

• uadmin.Action
• uadmin.HTTPLogFormat
• uadmin.Log
• uadmin.LogAdd
• uadmin.LogDelete
• uadmin.LogEdit
• uadmin.LogHTTPRequests
• uadmin.LogRead
• uadmin.LogTrail
• uadmin.Syslogf
• uadmin.TrailLoggingLevel

Metric Functions

Back To Top (Categorized List)

• uadmin.IncrementMetric
• uadmin.NewMetric
• uadmin.SetMetric
• uadmin.SystemMetrics
• uadmin.TimeMetric
• uadmin.UserMetrics

Model Functions

Back To Top (Categorized List)

• uadmin.DashboardMenu
• uadmin.HideInDashboarder
• uadmin.Model
• uadmin.NewModel
• uadmin.NewModelArray

Network Functions

Back To Top (Categorized List)

• uadmin.AllowedHosts
• uadmin.AllowedIPs
• uadmin.BindIP
• uadmin.BlockedIPs
• uadmin.CheckRateLimit
• uadmin.GetRemoteIP
• uadmin.Port
• uadmin.RateLimit
• uadmin.RateLimitBurst
• uadmin.RestrictSessionIP
• uadmin.ValidateIP

Print Functions

Back To Top (Categorized List)

• uadmin.ALERT
• uadmin.CRITICAL
• uadmin.DEBUG
• uadmin.EMERGENCY
• uadmin.ERROR
• uadmin.ErrorHandleFunc
• uadmin.INFO
• uadmin.JSONMarshal
• uadmin.OK
• uadmin.ReportingLevel
• uadmin.ReportTimeStamp
• uadmin.ReturnJSON
• uadmin.Trail
• uadmin.Version
• uadmin.VersionCodeName
• uadmin.WARNING
• uadmin.WORKING

Register Functions

Back To Top (Categorized List)

• uadmin.Register
• uadmin.RegisterInlines

Security Functions

Back To Top (Categorized List)

• uadmin.CheckCSRF
• uadmin.DefaultMediaPermission
• uadmin.EncryptKey
• uadmin.GenerateBase32
• uadmin.GenerateBase64
• uadmin.GroupPermission
• uadmin.OTPAlgorithm
• uadmin.OTPDigits
• uadmin.OTPPeriod
• uadmin.OTPSkew
• uadmin.PasswordAttempts
• uadmin.PasswordTimeout
• uadmin.PublicMedia
• uadmin.Salt
• uadmin.SQLInjection
• uadmin.StartSecureServer
• uadmin.UserPermission

Setting Functions

Back To Top (Categorized List)

• uadmin.DataType
• uadmin.GetSetting
• uadmin.Setting
• uadmin.SettingCategory

User Functions

Back To Top (Categorized List)

• uadmin.CachePermissions
• uadmin.CacheSessions
• uadmin.CookieTimeout
• uadmin.GetUserFromRequest
• uadmin.IsAuthenticated
• uadmin.Login
• uadmin.Login2FA
• uadmin.Logout
• uadmin.Session
• uadmin.SetSessionCookie
• uadmin.User
• uadmin.UserGroup

Page:

.. toctree::
   :maxdepth: 1

   api/ab_test_functions
   api/approval_functions
   api/basic_functions
   api/customizing_records
   api/database_functions
   api/email_functions
   api/fetching_records
   api/handler_functions
   api/language_functions
   api/log_functions
   api/metric_functions
   api/model_functions
   api/network_functions
   api/print_functions
   api/register_functions
   api/security_functions
   api/setting_functions
   api/field_type
   api/user_functions