GrapeCity.Forguncy.Commands.IServerCommandExecuteContext

接口 IServerCommandExecuteContext

当在服务器端执行实现了ICommandExecutableInServerSide接口的命令时，从服务器端传递的上下文信息。

命名空间: GrapeCity.Forguncy.Commands

程序集: Forguncy.Commands.dll

语法

public interface IServerCommandExecuteContext

属性

AppBaseUrl

应用的Base Url。

声明

string AppBaseUrl { get; }

属性值

类型	描述
string

AppFolder

应用的目录

声明

string AppFolder { get; }

属性值

类型	描述
string

AppLocalBaseUrl

应用的本地Base Url。

声明

string AppLocalBaseUrl { get; }

属性值

类型	描述
string

CacheService

缓存服务

声明

ICacheService CacheService { get; }

属性值

类型	描述
ICacheService

Context

返回IOwinContext类的实例。

声明

HttpContext Context { get; }

属性值

类型	描述
Microsoft.AspNetCore.Http.HttpContext

CurrentServerCommandName

服务端命令的名称。

声明

string CurrentServerCommandName { get; }

属性值

类型	描述
string

CurrentUserName

当前登陆用户名称

声明

[Obsolete("Please use GetCurrentUserNameAsync() instead")]
string CurrentUserName { get; }

属性值

类型	描述
string

DataAccess

用于操作数据库的上下文信息。

声明

IDataAccess DataAccess { get; }

属性值

类型	描述
IDataAccess

ExportHelper

用于导出页面的上下文信息。

声明

IExportHelper ExportHelper { get; }

属性值

类型	描述
IExportHelper

Log

用于记录日志的上下文环境。

声明

ILog Log { get; }

属性值

类型	描述
ILog

Parameters

当前上下文中可用参数。

声明

IDictionary<string, object> Parameters { get; }

属性值

类型	描述
System.Collections.Generic.IDictionary<TKey, TValue><string, object>

ServiceProvider

服务提供者

声明

IServiceProvider ServiceProvider { get; }

属性值

类型	描述
System.IServiceProvider

UserInfos

用于操作用户的上下文环境。

声明

IUserInfos UserInfos { get; }

属性值

类型	描述
IUserInfos

方法

EvaluateFormula(object)

计算公式的工具方法，返回公式的计算结果。

声明

[Obsolete("EvaluateFormula is deprecated, please use EvaluateFormulaAsync instead")]
object EvaluateFormula(object value)

参数

类型	名称	描述
object	value	原始公式字符串。

返回值

类型	描述
object	公式的计算结果。

EvaluateFormulaAsync(object)

计算公式的工具方法，返回公式的计算结果。

声明

Task<object> EvaluateFormulaAsync(object value)

参数

类型	名称	描述
object	value	原始公式字符串。

返回值

类型	描述
System.Threading.Tasks.Task<TResult><object>	公式的计算结果。

EvaluateFormulaInContentAsync(object, Dictionary<string, object>)

计算字符串中的公式，如 aaa,[=参数1],bbb 假设‘参数1’的值为ccc则计算结果为 aaa,ccc,bbb

声明

Task<object> EvaluateFormulaInContentAsync(object value, Dictionary<string, object> formulaValues)

参数

类型	名称	描述
object	value	原始公式字符串。
System.Collections.Generic.Dictionary<TKey, TValue><string, object>	formulaValues	用于缓存公式计算结果。

返回值

类型	描述
System.Threading.Tasks.Task<TResult><object>	公式的计算结果。

EvaluateQueryConditionValueFormula(object)

计算查询条件的工具方法，返回查询条件的计算结果。

声明

[Obsolete("EvaluateQueryConditionValueFormula is deprecated, please use EvaluateQueryConditionValueFormulaAsync instead")]
object EvaluateQueryConditionValueFormula(object queryCondition)

参数

类型	名称	描述
object	queryCondition	原始查询条件。

返回值

类型	描述
object	查询条件的计算结果。

EvaluateQueryConditionValueFormulaAsync(object, NullFormulaValueQueryPolicy)

计算查询条件的工具方法，返回查询条件的计算结果。

声明

Task<object> EvaluateQueryConditionValueFormulaAsync(object queryCondition, NullFormulaValueQueryPolicy nullFormulaValueQueryPolicy)

参数

类型	名称	描述
object	queryCondition	原始查询条件。
NullFormulaValueQueryPolicy	nullFormulaValueQueryPolicy	公式计算值为空时查询策略。

返回值

类型	描述
System.Threading.Tasks.Task<TResult><object>	查询条件的计算结果。

EvaluateQueryConditionValueFormulaAsync(object)

计算查询条件的工具方法，返回查询条件的计算结果。

声明

Task<object> EvaluateQueryConditionValueFormulaAsync(object queryCondition)

参数

类型	名称	描述
object	queryCondition	原始查询条件。

返回值

类型	描述
System.Threading.Tasks.Task<TResult><object>	查询条件的计算结果。

ExecuteCommands(List<Command>)

执行命令列表并返回执行结果。

声明

ExecuteResult ExecuteCommands(List<Command> commands)

参数

类型	名称	描述
System.Collections.Generic.List<T><Command>	commands	待执行命令列表。

返回值

类型	描述
ExecuteResult	命令执行结果。

ExecuteCommandsAsync(List<Command>)

执行命令列表并返回执行结果。

声明

Task<ExecuteResult> ExecuteCommandsAsync(List<Command> commands)

参数

类型	名称	描述
System.Collections.Generic.List<T><Command>	commands	待执行命令列表。

返回值

类型	描述
System.Threading.Tasks.Task<TResult><ExecuteResult>	命令执行结果。

ExecuteCustomCommandObjectAsync(object, Dictionary<string, object>, string)

执行自定义命令对象列表。

声明

Task<ExecuteResult> ExecuteCustomCommandObjectAsync(object command, Dictionary<string, object> initParams, string commandLogDisplayName = null)

参数

类型	名称	描述
object	command	命令。
System.Collections.Generic.Dictionary<TKey, TValue><string, object>	initParams	上下文参数值。
string	commandLogDisplayName	执行日志中显示的命令名称。

返回值

类型	描述
System.Threading.Tasks.Task<TResult><ExecuteResult>	命令执行结果。

ExecuteMcpToolAsync(string, Dictionary<string, object>)

执行mcp tool

声明

Task<IEnumerable<ExecuteMCPToolResponse>> ExecuteMcpToolAsync(string toolName, Dictionary<string, object> param)

参数

类型	名称	描述
string	toolName	mcp tool名称用双下划线分割mcp工具和具体函数，如：baiduMcp__aiSearch
System.Collections.Generic.Dictionary<TKey, TValue><string, object>	param	mcp tool参数

返回值

类型	描述
System.Threading.Tasks.Task<TResult><System.Collections.Generic.IEnumerable<T><ExecuteMCPToolResponse>>	mcp tool执行结果

ExecuteServerCommands(string, IServerCommandExecuteContext)

执行服务端命令列表并返回执行结果。

声明

ExecuteResult ExecuteServerCommands(string serverCommandName, IServerCommandExecuteContext dataContext)

参数

类型	名称	描述
string	serverCommandName	服务端命令的名称。
IServerCommandExecuteContext	dataContext	执行服务端命令的上下文。

返回值

类型	描述
ExecuteResult

ExecuteServerCommandsAsync(string, IServerCommandExecuteContext)

执行服务端命令列表并返回执行结果。

声明

Task<ExecuteResult> ExecuteServerCommandsAsync(string serverCommandName, IServerCommandExecuteContext dataContext)

参数

类型	名称	描述
string	serverCommandName	服务端命令的名称。
IServerCommandExecuteContext	dataContext	执行服务端命令的上下文。

返回值

类型	描述
System.Threading.Tasks.Task<TResult><ExecuteResult>

GetBindingDataSourceValueAsync(object)

获取数据库数据。

声明

Task<object> GetBindingDataSourceValueAsync(object bindingDataSource)

参数

类型	名称	描述
object	bindingDataSource	数据库查询对象，标注了BindingDataSourcePropertyAttribute属性的值

返回值

类型	描述
System.Threading.Tasks.Task<TResult><object>	数据库查询结果

GetCurrentUserNameAsync()

当前登陆用户名称

声明

Task<string> GetCurrentUserNameAsync()

返回值

类型	描述
System.Threading.Tasks.Task<TResult><string>

OpenAICallAsync(OpenAICallRequestParams)

调用该方法可以异步发送OpenAI请求。

声明

Task<AIResponse> OpenAICallAsync(OpenAICallRequestParams param)

参数

类型	名称	描述
OpenAICallRequestParams	param	OpenAI请求参数

返回值

类型	描述
System.Threading.Tasks.Task<TResult><AIResponse>	OpenAI请求的输出结果

OpenAICallStreamingAsync(OpenAICallRequestParams)

调用该方法可以异步发送流式输出的OpenAI请求。

声明

IAsyncEnumerable<AIResponse> OpenAICallStreamingAsync(OpenAICallRequestParams param)

参数

类型	名称	描述
OpenAICallRequestParams	param	OpenAI请求参数

返回值

类型	描述
System.Collections.Generic.IAsyncEnumerable<T><AIResponse>	OpenAI请求的流式输出结果

ReplaceKeyWord(string)

更换邮件中相关属性关键字的工具方法，返回更换过关键字后的字符串。

声明

[Obsolete("ReplaceKeyWord is deprecated, please use ReplaceKeyWordAsync instead")]
string ReplaceKeyWord(string value)

参数

类型	名称	描述
string	value	原始字符串。

返回值

类型	描述
string	返回更换过关键字后的字符串。

ReplaceKeyWordAsync(string)

更换邮件中相关属性关键字的工具方法，返回更换过关键字后的字符串。

声明

Task<string> ReplaceKeyWordAsync(string value)

参数

类型	名称	描述
string	value	原始字符串。

返回值

类型	描述
System.Threading.Tasks.Task<TResult><string>	返回更换过关键字后的字符串。

SendMail(string, List<string>, string, string)

调用该方法可以异步发送邮件。

声明

string SendMail(string fromAddress, List<string> toList, string title, string content)

参数

类型	名称	描述
string	fromAddress	发送人邮件地址（可以使用用户名）
System.Collections.Generic.List<T><string>	toList	收件人列表（可以使用用户名）
string	title	标题
string	content	邮件正文

返回值

类型	描述
string	如果有非空返回值表示邮件发送失败