models

Documentation

Index

• type BlockIPAddressParams
• type BlockIPAddressResult
• type FrontEndData
• type FrontEndFileData
  • func NewFrontEndFileData(frontEndPath cm.Path, fileName cm.Path, contentType string, ...) (fefd FrontEndFileData, err error)
• type IsIPAddressBlockedParams
• type IsIPAddressBlockedResult
• type PingParams
• type PingResult
• type Settings
• type ShowDiagnosticDataParams
• type ShowDiagnosticDataResult

Types

type BlockIPAddressParams

type BlockIPAddressParams struct {
	cmr.CommonParams

	// IP address of a client to block.
	UserIPA cm.IPAS `json:"userIPA"`

	// Block time in seconds.
	// This is a period for which the specified IP address will be blocked. If
	// for some reason a record with the specified IP address already exists,
	// this time will be added to an already existing value.
	BlockTimeSec cmb.Count `json:"blockTimeSec"`
}

type BlockIPAddressResult

type BlockIPAddressResult = cmr.CommonResultWithSuccess

type FrontEndData

type FrontEndData struct {
	AdminHtmlPage FrontEndFileData
	AdminJs       FrontEndFileData
	ApiJs         FrontEndFileData
	ArgonJs       FrontEndFileData
	ArgonWasm     FrontEndFileData
	BppJs         FrontEndFileData
	CssStyles     FrontEndFileData
	FavIcon       FrontEndFileData
	IndexHtmlPage FrontEndFileData
	LoaderScript  FrontEndFileData
}

FrontEndData is auxiliary data for front end.

type FrontEndFileData

type FrontEndFileData struct {
	UrlPath     cm.Path
	FilePath    cm.Path
	ContentType string
	CachedFile  []byte
}

FrontEndFileData is auxiliary data for a front end static file.

func NewFrontEndFileData

func NewFrontEndFileData(frontEndPath cm.Path, fileName cm.Path, contentType string, frontendAssetsFolder cm.Path) (fefd FrontEndFileData, err error)

type IsIPAddressBlockedParams

type IsIPAddressBlockedParams struct {
	cmr.CommonParams

	// IP address of a client to check.
	UserIPA cm.IPAS `json:"userIPA"`
}

type IsIPAddressBlockedResult

type IsIPAddressBlockedResult struct {
	cmr.CommonResult

	IsBlocked cmb.Flag `json:"isBlocked"`
}

type PingParams

type PingParams = cmr.PingParams

type PingResult

type PingResult = cmr.PingResult

type Settings

type Settings struct {
	Version                   cmb.Count `json:"version"`
	ProductVersion            cmb.Text  `json:"productVersion"`
	SiteName                  cmb.Text  `json:"siteName"`
	SiteDomain                cmb.Text  `json:"siteDomain"`
	CaptchaFolder             cm.Path   `json:"captchaFolder"`
	SessionMaxDuration        cmb.Count `json:"sessionMaxDuration"`
	MessageEditTime           cmb.Count `json:"messageEditTime"`
	PageSize                  cmb.Count `json:"pageSize"`
	ApiFolder                 cm.Path   `json:"apiFolder"`
	PublicSettingsFileName    cm.Path   `json:"publicSettingsFileName"`
	IsFrontEndEnabled         cmb.Flag  `json:"isFrontEndEnabled"`
	FrontEndStaticFilesFolder cm.Path   `json:"frontEndStaticFilesFolder"`
	NotificationCountLimit    cmb.Count `json:"notificationCountLimit"`
}

type ShowDiagnosticDataParams

type ShowDiagnosticDataParams struct{}

type ShowDiagnosticDataResult

type ShowDiagnosticDataResult struct {
	cmr.CommonResult
	cmr.RequestsCount
}