models

Documentation

Index

• Constants
• type BlockIPAddressParams
• type BlockIPAddressResult
• type FrontEndData
• type FrontEndFileData
  • func NewFrontEndFileData(frontEndPath string, fileName string, contentType string, ...) (fefd FrontEndFileData, err error)
• type IsIPAddressBlockedParams
• type IsIPAddressBlockedResult
• type PingParams
• type PingResult
• type RequestId
• type Settings
• type ShowDiagnosticDataParams
• type ShowDiagnosticDataResult
• type UrlParameter
  • func NewUrlParameterFromHttpRequest(req *http.Request) (up *UrlParameter, err error)

Constants

const (
	UrlParameter_ForumId    = "f"
	UrlParameter_ThreadId   = "t"
	UrlParameter_PageNumber = "p"
)

const (
	ErrRequestIsNotSet              = "request is not set"
	ErrUnsupportedParameter         = "unsupported parameter: %v"
	ErrDuplicateParameter           = "duplicate parameter: %v"
	ErrMultipleObjectTypesRequested = "multiple object types were requested"
)

Types

type BlockIPAddressParams

type BlockIPAddressParams struct {
	cmr.CommonParams

	// IP address of a client to block.
	UserIPA string `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 uint `json:"blockTimeSec"`
}

type BlockIPAddressResult

type BlockIPAddressResult struct {
	cmr.CommonResult

	OK bool `json:"ok"`
}

type FrontEndData

type FrontEndData struct {
	AdminHtmlPage FrontEndFileData
	AdminJs       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     string
	FilePath    string
	ContentType string
	CachedFile  []byte
}

FrontEndFileData is auxiliary data for a front end static file.

func NewFrontEndFileData

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

type IsIPAddressBlockedParams

type IsIPAddressBlockedParams struct {
	cmr.CommonParams

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

type IsIPAddressBlockedResult

type IsIPAddressBlockedResult struct {
	cmr.CommonResult

	IsBlocked bool `json:"isBlocked"`
}

type PingParams

type PingParams = cmr.PingParams

type PingResult

type PingResult = cmr.PingResult

type RequestId

type RequestId = uint

type Settings

type Settings struct {
	Version                   uint   `json:"version"`
	ProductVersion            string `json:"productVersion"`
	SiteName                  string `json:"siteName"`
	SiteDomain                string `json:"siteDomain"`
	CaptchaFolder             string `json:"captchaFolder"`
	SessionMaxDuration        uint   `json:"sessionMaxDuration"`
	MessageEditTime           uint   `json:"messageEditTime"`
	PageSize                  uint   `json:"pageSize"`
	ApiFolder                 string `json:"apiFolder"`
	PublicSettingsFileName    string `json:"publicSettingsFileName"`
	IsFrontEndEnabled         bool   `json:"isFrontEndEnabled"`
	FrontEndStaticFilesFolder string `json:"frontEndStaticFilesFolder"`
}

type ShowDiagnosticDataParams

type ShowDiagnosticDataParams struct{}

type ShowDiagnosticDataResult

type ShowDiagnosticDataResult struct {
	cmr.CommonResult
	cmr.RequestsCount
}

type UrlParameter

type UrlParameter struct {
	ForumId    *uint
	ThreadId   *uint
	PageNumber *uint
}

UrlParameter is a set of URL query parameters.

func NewUrlParameterFromHttpRequest

func NewUrlParameterFromHttpRequest(req *http.Request) (up *UrlParameter, err error)