API reference
API reference
Select your platform
No SDKs available
No versions available

Telemetry Class

This class provides facilities to share telemetry from Unity Editor with Meta.

Overview

Properties

static TelemetryLogLevel
static bool
Sets consent as obtained or withdrawn. This controls whether Meta will collect telemetry or not

Object Data

static int
StartEvent
( TelemetryEventId eventId )
Logs an event as started.
static void
LogInstantEvent
( TelemetryEventId eventId,
Dictionary< AnnotationKey, string > annotations )
Logs an instantaneous event that happens at one point in time (as opposed to one with a start and end).
static void
AnnotateEvent
( int instanceKey,
AnnotationKey key,
string value )
Annotates an event that has started but did not end yet.
static void
AnnotateCurrentSession
( AnnotationKey key,
string value )
Annotates the current session event.
static void
EndEvent
( int instanceKey,
ResultType result )
Logs an event as ended.
static void
EndEventWithFailure
( int instanceKey,
string error )
Logs an event as ended.

Details

Member Enumerations

enum Meta::Voice::TelemetryUtilities::Telemetry.ResultType
The result of an event.
Enumerator
Success
= 2
Failure
= 3
Cancel
= 4
enum Meta::Voice::TelemetryUtilities::Telemetry.TelemetryEventId
The event IDs. These should map to GQL IDs.
Enumerator
Unknown
= 92612351
Session
= 92611421
SupplyToken
= 92608491
CheckAutoTrain
= 92612591
AutoTrain
= 92617773
ToggleCheckbox
= 1063854409
SyncEntities
= 92609990
ClickButton
= 92615194
AssignIntentMatcherInInspector
= 92616101
SelectOption
= 92604542
GenerateManifest
= 92615944
LoadManifest
= 92613324
NavigateToCodeFromInspector
= 92614941
OpenUi
= 92610372
enum Meta::Voice::TelemetryUtilities::Telemetry.AnnotationKey
The annotation keys used for the key-value annotations.
Enumerator
Unknown
UnrecognizedEvent
UnrecognizedAnnotationKey
EnvironmentId
SessionId
StartTimeStamp
EndTimeStamp
Error
PageId
CompatibleSignatures
IncompatibleSignatures
IsAvailable
ControlId
Value
Type
WitSdkVersion
WitApiVersion

Properties

TelemetryLogLevel Meta.Voice.TelemetryUtilities.Telemetry.LogLevel
No description available.
bool Meta.Voice.TelemetryUtilities.Telemetry.ConsentProvided
Sets consent as obtained or withdrawn. This controls whether Meta will collect telemetry or not

Object Data

static int Meta.Voice.TelemetryUtilities.Telemetry.StartEvent
( TelemetryEventId eventId )
Logs an event as started.
Parameters
eventId
The ID of the event that just started.
Returns
Instance key identifying this specific occurrence of the event.
static void Meta.Voice.TelemetryUtilities.Telemetry.LogInstantEvent
( TelemetryEventId eventId,
Dictionary< AnnotationKey, string > annotations )
Logs an instantaneous event that happens at one point in time (as opposed to one with a start and end).
Parameters
eventId
The ID of the event.
annotations
Optional annotations to add to the event.
Returns
Instance key identifying this specific occurrence of the event.
static void Meta.Voice.TelemetryUtilities.Telemetry.AnnotateEvent
( int instanceKey,
AnnotationKey key,
string value )
Annotates an event that has started but did not end yet.
Parameters
instanceKey
The instance key of the event. Must match the one used starting the event.
key
The annotation key.
value
The annotation value.
static void Meta.Voice.TelemetryUtilities.Telemetry.AnnotateCurrentSession
( AnnotationKey key,
string value )
Annotates the current session event.
Parameters
instanceKey
The instance key of the event. Must match the one used starting the event.
key
The annotation key.
value
The annotation value.
static void Meta.Voice.TelemetryUtilities.Telemetry.EndEvent
( int instanceKey,
ResultType result )
Logs an event as ended.
Parameters
instanceKey
The instance key of the event. Must match the one used starting the event.
result
The result of the event.
Returns
Instance key.
static void Meta.Voice.TelemetryUtilities.Telemetry.EndEventWithFailure
( int instanceKey,
string error )
Logs an event as ended.
Parameters
instanceKey
The instance key of the event. Must match the one used starting the event.
error
The error.
Returns
Instance key.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon