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

EditorTelemetry Class

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

Constructors

EditorTelemetry ()
Signature
Meta.Voice.TelemetryUtilities.EditorTelemetry.EditorTelemetry()

Properties

ConsentProvided : bool
[Set]
Sets consent as obtained or withdrawn. This controls whether Meta will collect telemetry or not
Signature
bool Meta.Voice.TelemetryUtilities.EditorTelemetry.ConsentProvided
LogLevel : TelemetryLogLevel
[Get][Set]
Signature
TelemetryLogLevel Meta.Voice.TelemetryUtilities.EditorTelemetry.LogLevel

Internal Methods

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

Inner Enums

ResultType Enum

The result of an event.

Enumeration Constants

MemberValue
Success
2
Failure
3
Cancel
4

TelemetryEventId Enum

The event IDs. These should map to GQL IDs.

Enumeration Constants

MemberValue
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

AnnotationKey Enum

The annotation keys used for the key-value annotations.

Enumeration Constants

Member
Unknown
UnrecognizedEvent
UnrecognizedAnnotationKey
EnvironmentId
SessionId
StartTimeStamp
EndTimeStamp
Error
PageId
CompatibleSignatures
IncompatibleSignatures
IsAvailable
ControlId
Value
Type
WitSdkVersion
WitApiVersion