Understand function parameters
- Last UpdatedApr 07, 2025
- 2 minute read
Function parameters are used when creating Function expressions for Actions.
The following parameters can be passed in the function expression.
|
Parameter |
Description |
|---|---|
|
context |
A value that determines what caused the function to execute. Use this object to avoid retriggering the Action item and causing a loop. |
|
executionTime |
The time that the function is executed (current time shown in UTC time). |
|
time |
The time at which the function is being executed . If the function is executed manually, it is the value of the ManualExecutionTimeStamp property. If the function executes because of new data in the dependency sample streams, it is the time stamp of samples in the new data. If the function executes because of an event it is DateTime.MinValue. The time parameter refers to the UTC time of the sample that is currently being processed in the historical context and could be a time in the past. This applies only when the EnableManualExecution property is set to True, or the EnableExecutionOnDependencies property is set to True and the DependencyExecutionMode property is set to ExecuteForEachSample. |
|
eventItem |
The item that raised the event that caused the function to execute. This is null if the function was not executed by an event. The eventItem parameter applies only when the EnableExecutionOnSubscriptions property is set to True. It is a reference to the item that raised the event to which you have subscribed. |
|
eventArgs |
An item that contains information about the event that caused the function to execute. This is null if the function was not executed by an event. The eventArgs parameter also applies only when the EnableExecutionOnSubscriptions property is set to True. The exact type of this parameter depends on the event being raised. For example, it could be an instance of RecordChangedEventArgs. |