Table of Contents

Namespace BiExcellence.OpenBi.Api.HtmlItems

Classes

CmsItemTemplate

A per-tag, per-language HTML item template - how one html item is rendered. Tag, Name and Language together are its key. Used as both the request and response body.

CmsItemTemplateHistory

A saved version of a CmsItemTemplate. Every save of a template stores a copy here, so the newest record is the current content; the server keeps the newest ELEMENT_HISTORY_LIMIT (default 5) per tag, id and language.

HtmlItem

One html item the server knows, as GET htmlitems lists it.

HtmlItemDefinition

One html item with the parameters it accepts, as GET htmlitems/{tagName} returns it.

HtmlItemParameter

One attribute an html item takes.

HtmlItemReplacementParameter

One placeholder an html item replaces inside its template.

OpenBiApiClientHtmlItemTemplateExtensions

Extension methods for the /htmlitems REST API: the items the server knows, what each one accepts, and the templates that render them.

Interfaces

ICmsItemTemplate

A per-tag, per-language HTML item template - how one html item is rendered. Tag, Name and Language together are its key. Used as both the request and response body.

ICmsItemTemplateHistory

A saved version of a CmsItemTemplate. Every save of a template stores a copy here, so the newest record is the current content; the server keeps the newest ELEMENT_HISTORY_LIMIT (default 5) per tag, id and language.

IHtmlItem

One html item the server knows, as GET htmlitems lists it.

IHtmlItemDefinition

One html item with the parameters it accepts, as GET htmlitems/{tagName} returns it.

IHtmlItemParameter

One attribute an html item takes.

IHtmlItemReplacementParameter

One placeholder an html item replaces inside its template.