SDK 参考

支持平台:

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

public typedescription
class ContentEventArgs为内容操作事件提供数据
class ContentFormLoadEventArgs为内容编辑(新增)页面的载入事件提供数据
delegate ContentFormLoadEventHandler表示将用于处理内容编辑(新增)页面的载入事件的方法
class ContentFormSubmitEventArgs为内容编辑(新增)页面的提交事件提供数据
class ContentTranslateEventArgs为内容转移事件提供数据
static class Context封装系统上下文相关信息
class DatabaseType系统支持的数据库类型
class DatabaseTypeConverter字符串与DatabaseType转换类
class DataType系统支持的数据库数据类型
class DataTypeConverter字符串与DataType转换类
interface IAccessTokenAccess Token接口
interface IAdminApi管理员及权限Api接口
interface IAdministratorInfo管理员实体接口。 对应数据库中的xycms_Administrator表
interface IApiCollection插件可调用的Api集合接口
interface IAttributes可扩展属性的对象接口。 系统以键/值对的方式存储数据,键不区分大小写
interface IChannelApi栏目Api接口
interface IChannelInfo栏目实体接口。 对应数据库中的xycms_Channel表
interface IConfigApi插件及系统配置Api接口
interface IContentApi内容Api接口
interface IContentContext内容事件关联的上下文
interface IContentInfo内容实体接口。 内容表默认名称为model_Content,XYCMS 后台可以新建新的内容表,或者修改现有内容表的字段
interface IDatabaseApi数据库操作Api接口
interface IEnvironment插件运行环境接口
interface IJobContext包含XYCMS Cli命令行执行任务时的上下文信息
interface ILogInfo日志实体接口
interface IMetadata插件元数据接口
class Initializer插件初始化类,此类的方法由系统调用,在插件开发时请勿直接使用
class InputListItem表示列表中的数据项
class InputStyle表示表单的输入样式
class InputType表单的输入类型
class InputTypeConverter字符串与InputType转换类
interface IParseApiSTL解析Api接口
interface IParseContextSTL解析上下文
interface IPermissions登录账号的权限
interface IPluginApi插件Api接口
interface IRequest访问插件时的认证请求
interface IService插件服务注册接口。 插件服务注册接口是插件机制的核心,用于定义插件能够提供的各种服务,一个方法对应一个事件或者一个功能
interface ISiteApi站点Api接口
interface ISiteInfo站点实体接口。 对应数据库中的xycms_Site表
interface IUserApi用户Api接口
interface IUserInfo用户实体接口
interface IUtilsApi工具类Api接口
class Menu插件菜单。 插件菜单可显示在系统头部、左侧或者内容列表中
class ParseEventArgs为STL解析事件提供数据
abstract class PluginBase插件父类,所有插件必须继承此类并实现Startup方法
class RestApiEventArgsRest Api
delegate RestApiEventHandler表示将用于处理Rest Api请求事件的方法
class TableColumn数据库表字段信息
class TemplateType系统支持的模板类型
class TemplateTypeConverter字符串与TemplateType转换类
class ValidateType表单输入的验证规则类型
class ValidateTypeConverter字符串与ValidateType转换类