Class HistorianDocProvider
java.lang.Object
com.inductiveautomation.ignition.common.script.hints.PropertiesFileDocProvider
com.inductiveautomation.historian.common.scripting.HistorianDocProvider
- All Implemented Interfaces:
ScriptFunctionDocProvider
Hides parameters a scripting function accepts but does not document:
browse's
snapshotTime, and includeBounds on queryRawPoints and
queryAggregatedPoints.-
Field Summary
Fields inherited from class PropertiesFileDocProvider
IGNORED_EXCEPTIONSFields inherited from interface ScriptFunctionDocProvider
NO_DOC_PROVIDER -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncom.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.MethodgetMethodDescriptor(String path, Method method) Methods inherited from class PropertiesFileDocProvider
b10n, buildParameter, getAnnotations, getBundlePrefix, getDeprecation, getExceptionDescription, getExceptions, getFieldDescription, getFieldDescriptor, getFieldType, getFieldValue, getIgnoredExceptions, getMethodDescription, getParameters, getReturnDocs, getReturnType, parametersFromKeywordArgs, parametersFromScriptArgs, shouldBeIgnored
-
Constructor Details
-
HistorianDocProvider
public HistorianDocProvider()
-
-
Method Details
-
getMethodDescriptor
public com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Method getMethodDescriptor(String path, Method method) - Specified by:
getMethodDescriptorin interfaceScriptFunctionDocProvider- Overrides:
getMethodDescriptorin classPropertiesFileDocProvider- Parameters:
path- The path this function is being added at, as given to theScriptManager.method- TheMethodbeing added as a scripting function.- Returns:
- A descriptor for the method.
- See Also:
-