Documentation > Services API

Service Template API Library

Use the services API to create input fields, etc...

Last updated: Build ()

NameDescriptionType
CrownPeakField

Class for common CMS parameters. Implements the ICrownPeakField interface.

Class

DateTimeWithZone

Class to represent date and time.

Class

ExportSiteRoot

CMS Transfer Framework to output XML format

Class

Helper

SiteBuilder Helper class. Contains methods to assist in export and import.

Class

HyperLink

Class that uses the fields from ServicesInput.ShowHyperLink to build out an HTML link. If the imageLinkOption is enabled for ServicesInput.ShowHyperLink, call ServicesInput.HyperLink.ToString(LinkOutputType) instead of the default ToString(). Otherwise an empty string is returned.

Class

ImportSiteRoot

CMS Transfer Framework to create site based on XML

Class

LinkListType

Enumerated type used for ServicesOutput.BuildHyperLinkList LinkListType.UnorderedList renders a

    list LinkListType.OrderedList renders a
      list LinkListType.MenuList renders an HTML5 list

      Class

      LinkOutputType

      Enumerated type used for ServicesOutput.HyperLink.ToString(LinkOutputType) LinkOutputType.TextLink (default) renders an tag wrapping a text title. LinkOutputType.Imagelink renders an tag wrapping an image associated with the field set.

      Class

      LocaleId

      LocaleId is a class used by other methods that defines properties of the locale, an ID and folder path

      Class

      ServicesCommon

      Class for common CMS Fields.

      Class

      ServicesHelpDocTemplates

      Used in a custom help asset.

      Class

      ServicesInput

      // * ServicesInput - WYSIWYG * This include is meant to house and structure all the various types of WYSIWYGs. This code is broken out from inc_input_elements primarily just to make the file easier to manage. Each of the WYSIWYG functions is just a few lines and is self defining.

      Class

      ServicesMinifier

      Class for Minfication of CSS and JS

      Class

      ServicesOutput

      Output template utility methods for commonly used output code.

      Class

      ServicesPostInput

      PostInput template utility methods for commonly used post-input code.

      Class

      ServicesSiteBuilder

      SiteBuilder template and utility methods for exporting and importing entire websites/projects.

      Class

      ServicesTMF

      Translational Model Framework utility and helper methods.

      Class

      ServicesUtil

      General utility methods for the Services Library.

      Class

      ShowDate

      Enumerated types used for ServicesInput.ShowInputHeader

      Class

      ShowHyperLinkParams

      Initializes a new instance of the class with the default parameters.

      Class

      ShowSummary

      Enumerated types used for ServicesInput.ShowInputHeader

      Class

      SiteBuilderInfo

      Info fields used in export and import of sites. Mostly auto populated during import.

      Class

      SiteBuilderLog

      Uses Util.Log to save log messages in the context of the given asset with the given message string. The log will be added to the asset's History (Properties > History) with the action type "Custom" and will only be displayed when "Custom" is selected from the drop-down.

      Class

      SiteBuilderModel

      Set default models. If none of the path are provided, it will use default paths. Read the class to see the default paths

      Class

      SiteBuilderType

      Binary node type for binary wrapper. Used by private methods.

      Class

      Connect with CrownPeak