Interface IEngineApi
Namespace: Casewhere.Runtime.Interfaces
Assembly: Casewhere.Runtime.dll
public interface IEngineApi
Extension Methods
ObjectExtension.ConvertToBsonValue(object), EnumExtensions.DeepClone<IEngineApi>(IEngineApi)
Methods
GetDocument(Guid)
[Obsolete]
byte[] GetDocument(Guid id)
Parameters
id Guid
Returns
byte[]
GetDocument(DocumentInfo)
byte[] GetDocument(DocumentInfo documentInfo)
Parameters
documentInfo DocumentInfo
Returns
byte[]
GetDocumentMetadata(Guid)
DynamicDataObject GetDocumentMetadata(Guid id)
Parameters
id Guid
Returns
DynamicDataObject
GetSystemDocument(string)
byte[] GetSystemDocument(string documentName)
Parameters
documentName string
Returns
byte[]
PluginExecute(string, string, Dictionary<string, string>)
[C] Invoke a plugin based on the plugin name and return no value.
object PluginExecute(string pluginName, string method, Dictionary<string, string> parameters)
Parameters
pluginName string
The plugin name
method string
The method will be invoked
parameters Dictionary<string, string>
The parameters of the method
Returns
Exceptions
When is not found in the database OR when or is invalid (empty or null)
PluginException
When there is an exception during invoking plugin.
PluginQueryPagedList(string, string, Dictionary<string, string>)
[C] Invoke a plugin based on the plugin name and return the array of values.
PagedList PluginQueryPagedList(string pluginName, string method, Dictionary<string, string> parameters)
Parameters
pluginName string
The plugin name
method string
The method will be invoked to get data
parameters Dictionary<string, string>
The parameters of the method
Returns
PagedList
Exceptions
When is not found in the database OR when or is invalid (empty or null)
PluginException
When there is an exception during invoking plugin.
SaveDocument(string, byte[])
[Obsolete]
DocumentMetadata SaveDocument(string fileName, byte[] content)
Parameters
fileName string
content byte[]
Returns
DocumentMetadata
SaveDocumentData(string, byte[])
DocumentInfo SaveDocumentData(string fileName, byte[] data)
Parameters
fileName string
data byte[]
Returns
DocumentInfo