UserTaskEvent Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A class that stores information for user task data model event. A user task is an application operation that is INVOKED BY USER directly and comes with result (e.g., Success, Failure). It is used for user behavior/intent analysis. User is aware of the operation and be able to execute. e.g. Open project and Show tool windows are user tasks; instead load VS package and Design time build are operations.
For long-time running or async user task, in order to understand what else happened during the time or track if it partially completes because of an error, use method StartUserTask(TelemetrySession, String) which tracks both start and end points.
public ref class UserTaskEvent sealed : Microsoft::VisualStudio::Telemetry::OperationEventpublic sealed class UserTaskEvent : Microsoft.VisualStudio.Telemetry.OperationEventtype UserTaskEvent = class
inherit OperationEventPublic NotInheritable Class UserTaskEvent
Inherits OperationEvent- Inheritance
Constructors
| UserTaskEvent(String, TelemetryResult, String) |
Initializes a new instance of the UserTaskEvent class. |
Properties
| Correlation |
Gets correlation of this event. It represents this event when correlated with other events. (Inherited from TelemetryEvent) |
| DataSource |
Gets data source. (Inherited from TelemetryEvent) |
| Duration |
Gets duration of the operation if the stage type is End. Return null for other stage types. (Inherited from OperationEvent) |
| EndTime |
Gets end time (in ticks) of current operation which stage type is End. Return null for other stage types. (Inherited from OperationEvent) |
| EntityName |
Gets entity name (Inherited from OperationEvent) |
| EventSchemaVersion |
Gets schema version for this event. (Inherited from TelemetryEvent) |
| EventType |
Gets event type for this event (Inherited from TelemetryEvent) |
| FeatureName |
Gets feature name (Inherited from OperationEvent) |
| HasProperties |
Gets a value indicating whether properties already created. (Inherited from TelemetryEvent) |
| IsOptOutFriendly |
Gets or sets a value indicating whether event is friendly for the optOut session. By default it is false. If it is OptOut friendly it passes through with the event specific properties only. This behaviour can be changed by manifest rules. (Inherited from TelemetryEvent) |
| Name |
Gets current event name (Inherited from TelemetryEvent) |
| ProductName |
Gets product name (Inherited from OperationEvent) |
| Properties |
Gets a dictionary of event properties. Properties are dimensions that aggregated data can be sliced by. The key is a property name that is unique, not null and not empty. The value is any object that represents a property value. Telemetry channels must use value.ToString(CultureInfo.InvariantCulture) to send the value to a server as a string. (Inherited from TelemetryEvent) |
| Result |
Gets result from this operation. (Inherited from OperationEvent) |
| ResultSummary |
Gets result summary from this operation. (Inherited from OperationEvent) |
| Severity |
Gets or sets a severity level of the event. The level is used for event consumer (e.g., ETW provider, backend reporting) to organize data easier. (Inherited from TelemetryEvent) |
| SharedPropertyBags |
Gets shared property bags (Inherited from TelemetryEvent) |
| StageType |
Gets stage type from this operation. (Inherited from OperationEvent) |
| StartEndPairId |
Gets pair id for start-end operation events. It is the same value as CorrelationId. return null for atomic operation event. (Inherited from OperationEvent) |
| StartTime |
Gets start time (in ticks) of current operation which stage type is End. Return null for other stage types. (Inherited from OperationEvent) |
Methods
| Correlate(TelemetryEventCorrelation, String) |
Correlate this event with other event via TelemetryEventCorrelation with description information. (Inherited from OperationEvent) |
| Correlate(TelemetryEventCorrelation[]) |
Correlate this event with other events via TelemetryEventCorrelation. (Inherited from TelemetryEvent) |
| CorrelateWithDescription(TelemetryEventCorrelation, String) |
Correlate this event with other event via TelemetryEventCorrelation with description information. (Inherited from TelemetryEvent) |
| GetDefaultEventProperties(Int64, Int64, String) |
Returns default properties that should be on each TelemetryEvent (Inherited from TelemetryEvent) |
| ToString() |
ToString to make debugging easier: show in debug watch window (Inherited from TelemetryEvent) |