Class CPBaseClass

Namespace

Contensive.BaseClasses

Assembly

CPBase.dll

CP - The object passed to an addon in the add-ons execute method. See the AddonBaseClass for details of the addon execute method.

public abstract class CPBaseClass

Inheritance

object

CPBaseClass

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Addon

The addon class handles access to an add-on's features. Use the Utils object to run an cpcore.addon. An instance of the Addon class is passed to the executing addon in the MyAddon object so it can access any features needed. See the CPAddonBaseClass for more details.

public abstract CPAddonBaseClass Addon { get; }

Property Value

CPAddonBaseClass

AdminUI

Classes and methods to create forms for the admin user interface

public abstract CPAdminUIBaseClass AdminUI { get; }

Property Value

CPAdminUIBaseClass

Cache

The Cache objects handles caching. Use this class to save blocks of data you will use again. See CPCacheBaseClass for more details.

public abstract CPCacheBaseClass Cache { get; }

Property Value

CPCacheBaseClass

CdnFiles

read and write cdn files, like content uploads. Sites with static front-ends may put static files here.

public abstract CPFileSystemBaseClass CdnFiles { get; }

Property Value

CPFileSystemBaseClass

Content

The Content class handles functions related to content meta such as determining the table used for a content definition, getting a recordid based on the name, or accessing the methods that control workflow publishing. See CPContentBaseClass for more details.

public abstract CPContentBaseClass Content { get; }

Property Value

CPContentBaseClass

Date

The Db object handles direct access to the Database. The ContentSet functions in the CPCSBaseClass are prefered for general use. See the CPDBBaseClass for more details.

public abstract CPDateBaseClass Date { get; }

Property Value

CPDateBaseClass

Db

The Db object handles direct access to the Database. The ContentSet functions in the CPCSBaseClass are prefered for general use. See the CPDBBaseClass for more details.

public abstract CPDbBaseClass Db { get; }

Property Value

CPDbBaseClass

Doc

The Doc object handles features related to the document (page) being contructed in the current call. See CPDocBaseClass for more details.

public abstract CPDocBaseClass Doc { get; }

Property Value

CPDocBaseClass

Email

The Email object handles email functions. See CPEmailBaseClass for more information.

public abstract CPEmailBaseClass Email { get; }

Property Value

CPEmailBaseClass

File

Legacy file object. Use FileCdn, FileAppRoot, FilePrivate and tempFiles.

[Obsolete("Deprecated. Use cp.CdnFiles, cp.wwwFiles, cp.privateFiles and cp.TempFiles.")]
public abstract CPFileBaseClass File { get; }

Property Value

CPFileBaseClass

Group

The Group Object accesses group features. Group Features generally associate people and roles. See CPGroupBaseClass for more details.

public abstract CPGroupBaseClass Group { get; }

Property Value

CPGroupBaseClass

Html

The HTML class handles functions used to read and produce HTML elements. See CPHtmlBaseClass for more details.

public abstract CPHtmlBaseClass Html { get; }

Property Value

CPHtmlBaseClass

Html5

The HTML class handles functions used to read and produce HTML elements. See CPHtmlBaseClass for more details.

public abstract CPHtml5BaseClass Html5 { get; }

Property Value

CPHtml5BaseClass

Http

Helper class for common http request methods. For saving http verbs to files, see the file object

public abstract CPHttpBaseClass Http { get; }

Property Value

CPHttpBaseClass

Image

Image controller

public abstract CPImageBaseClass Image { get; }

Property Value

CPImageBaseClass

JSON

utilities for json

public abstract CPJSONBaseClass JSON { get; }

Property Value

CPJSONBaseClass

Layout

manage application layout records.

public abstract CPLayoutBaseClass Layout { get; }

Property Value

CPLayoutBaseClass

Log

The Log class manages server logs

public abstract CPLogBaseClass Log { get; }

Property Value

CPLogBaseClass

MQTT

publish to an mqtt broker

public abstract CPMQTTBaseClass MQTT { get; }

Property Value

CPMQTTBaseClass

MessageQueue

read and write messages to a standard message queue

public abstract CPMessageQueueBaseClass MessageQueue { get; }

Property Value

CPMessageQueueBaseClass

Mustache

Manage mustache compatible template language operations

public abstract CPMustacheBaseClass Mustache { get; }

Property Value

CPMustacheBaseClass

MyAddon

The MyAddon object is an instance of the Addon class created before an add-ons execute method is called. See CPAddonBaseClass for more details.

[Obsolete("Deprecated. Use CP.Addon.id to create a model.", false)]
public abstract CPAddonBaseClass MyAddon { get; }

Property Value

CPAddonBaseClass

PrivateFiles

read and write files not available to the Internet

public abstract CPFileSystemBaseClass PrivateFiles { get; }

Property Value

CPFileSystemBaseClass

Request

The Request object handles data associated with the request from the visitor. See CPRequestBaseClass for more details.

public abstract CPRequestBaseClass Request { get; }

Property Value

CPRequestBaseClass

Response

The Response object handles the stream of data back to the visitor. See CPResponseBaseClass for more details.

public abstract CPResponseBaseClass Response { get; }

Property Value

CPResponseBaseClass

SMS

Text messaging services

public abstract CPSMSBaseClass SMS { get; }

Property Value

CPSMSBaseClass

Secrets

exposes base credentials and methods to get/set credentials

public abstract CPSecretsBaseClass Secrets { get; }

Property Value

CPSecretsBaseClass

Security

read and write files in a temporary location.

public abstract CPSecurityBaseClass Security { get; }

Property Value

CPSecurityBaseClass

ServerConfig

Server configuration

public abstract ServerConfigBaseModel ServerConfig { get; }

Property Value

ServerConfigBaseModel

Site

The Site Class handles features related to the current site. See CPSiteBaseClass for more details.

public abstract CPSiteBaseClass Site { get; }

Property Value

CPSiteBaseClass

TempFiles

A local file system that automatically deletes files

public abstract CPFileSystemBaseClass TempFiles { get; }

Property Value

CPFileSystemBaseClass

User

The User Class handles details related to the user and its related people record. See CPUserBaseClass for more details.

public abstract CPUserBaseClass User { get; }

Property Value

CPUserBaseClass

UserError

The UserError Class handles error handling for those conditions you want the user to know about or correct. For example an login error. See the CPUserErrorBaseClass for more details.

public abstract CPUserErrorBaseClass UserError { get; }

Property Value

CPUserErrorBaseClass

Utils

The Utils class handles basic utilities and other features not classified. See CPUtilsBaseClass for more details.

public abstract CPUtilsBaseClass Utils { get; }

Property Value

CPUtilsBaseClass

Version

Contensive version

public abstract string Version { get; }

Property Value

string

Visit

The Visit Class handles details related to the visit. For instance it holds the number of pages hit so far and has methods for adding and modifying user defined visit properties. See CPVisitBaseClass for more details.

public abstract CPVisitBaseClass Visit { get; }

Property Value

CPVisitBaseClass

Visitor

The Visitor Class handles details related to the visitor. For instance it holds the browser type used by the visitor. See CPVisitorBaseClass for more details.

public abstract CPVisitorBaseClass Visitor { get; }

Property Value

CPVisitorBaseClass

WwwFiles

read and write files in the root folder of the application (appRoot, wwwRoot,htdocs,etc)

public abstract CPFileSystemBaseClass WwwFiles { get; }

Property Value

CPFileSystemBaseClass

Methods

BlockNew()

Construct new Block object. See CPBlockBaseClass for Block Details

public abstract CPBlockBaseClass BlockNew()

Returns

CPBlockBaseClass

CSNew()

Construct new CS object. See CPCSBaseClass for CS object details

public abstract CPCSBaseClass CSNew()

Returns

CPCSBaseClass

DbNew(string)

Construct new Db object. CP.Db methods are for the default datasource. Use this method to create a db object for other datasources. See CPDbBaseClass for Db object details

public abstract CPDbBaseClass DbNew(string DataSourceName)

Parameters

DataSourceName string

Returns

CPDbBaseClass

Returns a new Db class. If the Datasource cannot be opened an exception is thrown.

GetAppConfig()

The current application

public abstract AppConfigBaseModel GetAppConfig()

Returns

AppConfigBaseModel

GetAppConfig(string)

Return the configuration of the app name specified. Use

public abstract AppConfigBaseModel GetAppConfig(string appName)

Parameters

appName string

Returns

AppConfigBaseModel

GetAppNameList()

A list of the names (keys) for all apps on this server groups

public abstract List<string> GetAppNameList()

Returns

List<string>