SDK 參考

支持平台:

.NET Framework 4.0,.NET Framework 4.5,.NET Core 5.0。

public typedescription
class ContentEventArgs爲内容操作事(shì)件提供數據
class ContentFormLoadEventArgs爲内容編輯(新增)頁面(miàn)的載入事(shì)件提供數據
delegate ContentFormLoadEventHandler表示將(jiāng)用于處理内容編輯(新增)頁面(miàn)的載入事(shì)件的方法
class ContentFormSubmitEventArgs爲内容編輯(新增)頁面(miàn)的提交事(shì)件提供數據
class ContentTranslateEventArgs爲内容轉移事(shì)件提供數據
static class Context封裝系統上下文相關信息
class DatabaseType系統支持的數據庫類型
class DatabaseTypeConverter字符串與DatabaseType轉換類
class DataType系統支持的數據庫數據類型
class DataTypeConverter字符串與DataType轉換類
interface IAccessTokenAccess Token接口
interface IAdminApi管理員及權限Api接口
interface IAdministratorInfo管理員實體接口。 對(duì)應數據庫中的xycms_Administrator表
interface IApiCollection插件可調用的Api集合接口
interface IAttributes可擴展屬性的對(duì)象接口。 系統以鍵/值對(duì)的方式存儲數據,鍵不區分大小寫
interface IChannelApi欄目Api接口
interface IChannelInfo欄目實體接口。 對(duì)應數據庫中的xycms_Channel表
interface IConfigApi插件及系統配置Api接口
interface IContentApi内容Api接口
interface IContentContext内容事(shì)件關聯的上下文
interface IContentInfo内容實體接口。 内容表默認名稱爲model_Content,XYCMS 後(hòu)台可以新建新的内容表,或者修改現有内容表的字段
interface IDatabaseApi數據庫操作Api接口
interface IEnvironment插件運行環境接口
interface IJobContext包含XYCMS Cli命令行執行任務時(shí)的上下文信息
interface ILogInfo日志實體接口
interface IMetadata插件元數據接口
class Initializer插件初始化類,此類的方法由系統調用,在插件開(kāi)發(fā)時(shí)請勿直接使用
class InputListItem表示列表中的數據項
class InputStyle表示表單的輸入樣(yàng)式
class InputType表單的輸入類型
class InputTypeConverter字符串與InputType轉換類
interface IParseApiSTL解析Api接口
interface IParseContextSTL解析上下文
interface IPermissions登錄賬号的權限
interface IPluginApi插件Api接口
interface IRequest訪問插件時(shí)的認證請求
interface IService插件服務注冊接口。 插件服務注冊接口是插件機制的核心,用于定義插件能(néng)夠提供的各種(zhǒng)服務,一個方法對(duì)應一個事(shì)件或者一個功能(néng)
interface ISiteApi站點Api接口
interface ISiteInfo站點實體接口。 對(duì)應數據庫中的xycms_Site表
interface IUserApi用戶Api接口
interface IUserInfo用戶實體接口
interface IUtilsApi工具類Api接口
class Menu插件菜單。 插件菜單可顯示在系統頭部、左側或者内容列表中
class ParseEventArgs爲STL解析事(shì)件提供數據
abstract class PluginBase插件父類,所有插件必須繼承此類并實現Startup方法
class RestApiEventArgsRest Api
delegate RestApiEventHandler表示將(jiāng)用于處理Rest Api請求事(shì)件的方法
class TableColumn數據庫表字段信息
class TemplateType系統支持的模闆類型
class TemplateTypeConverter字符串與TemplateType轉換類
class ValidateType表單輸入的驗證規則類型
class ValidateTypeConverter字符串與ValidateType轉換類