editor › Globals › AnalyticsTrackerKyub

Class: AnalyticsTrackerKyub

Hierarchy

• AnalyticsTrackerKyub

Index

Constructors

• constructor

Properties

• apiRoot
• consistencyLock
• debouncedScreenshotFunction
• debouncedStepUpload
• editor
• lastLocalScreenshotEnabledStepIdx
• lastStoredScreenshotEnabledStepIdx
• lastUploadedBatchPromise
• modelProjectId
• muted
• sessionPath
• sessionPromise
• stepBatch
• stepPath

Methods

• _addStepToBatch
• _constructStepJSON
• _getUserName
• _makeScreenshot
• _onSessionPromiseRejection
• _onStepPromiseRejection
• _patchModelProjectIDtoSession
• _patchScreenshotIDtoStep
• _postSession
• _postStepBatch
• _releaseConsistencyLock
• _startSession
• _takeAndUploadScreenshot
• _takeConsistencyLock
• _uploadScreenshot
• isMuted
• mute
• reportModuleAction
• reportNotification
• reportToolInteraction
• setEditor
• setModelProjectID
• unmute

Constructors

constructor

+ new AnalyticsTrackerKyub(): AnalyticsTrackerKyub

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:75

Returns: AnalyticsTrackerKyub

Properties

Private apiRoot

• apiRoot: string = Config.get("general.apiRoot", "/")

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:65

---

Private consistencyLock

• consistencyLock: AsyncLock = new AsyncLock()

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:71

---

Private Readonly debouncedScreenshotFunction

• debouncedScreenshotFunction: any = null

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:72

---

Private Readonly debouncedStepUpload

• debouncedStepUpload: any = null

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:73

---

Private editor

• editor: Editor

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:63

---

Private lastLocalScreenshotEnabledStepIdx

• lastLocalScreenshotEnabledStepIdx: number = -1

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:68

---

Private lastStoredScreenshotEnabledStepIdx

• lastStoredScreenshotEnabledStepIdx: number = -1

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:70

---

Private lastUploadedBatchPromise

• lastUploadedBatchPromise: Promise‹IStep[]› | null = null

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:69

---

Private modelProjectId

• modelProjectId: string = ""

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:75

---

Private muted

• muted: boolean

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:58

---

Private Readonly sessionPath

• sessionPath: string

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:60

---

Private Readonly sessionPromise

• sessionPromise: Promise‹ISession | void›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:62

---

Private stepBatch

• stepBatch: IStepJSON[] = []

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:67

---

Private Readonly stepPath

• stepPath: string

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:59

Methods

Private _addStepToBatch

▸ _addStepToBatch(action: InteractionType, description: string, parameters?: Record‹string, any›): Promise‹void›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:153

Parameters:

Name	Type	Description
action	InteractionType	describes the interaction with the tool, like use or select
description	string	describes the name of the tool used, like kyub.core.movement.move
parameters?	Record‹string, any›	-

Returns: Promise‹void›

---

Private _constructStepJSON

▸ _constructStepJSON(action: string, description: string, parameters?: Record‹string, any›): Promise‹IStepJSON›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:129

Parameters:

Name	Type
action	string
description	string
parameters?	Record‹string, any›

Returns: Promise‹IStepJSON›

---

Private _getUserName

▸ _getUserName(): string

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:291

Returns: string

---

Private _makeScreenshot

▸ _makeScreenshot(): Promise‹Blob›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:262

Returns: Promise‹Blob›

---

Private _onSessionPromiseRejection

▸ _onSessionPromiseRejection(): void

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:307

Returns: void

---

Private _onStepPromiseRejection

▸ _onStepPromiseRejection(): void

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:313

Returns: void

---

Private _patchModelProjectIDtoSession

▸ _patchModelProjectIDtoSession(): Promise‹unknown›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:252

Returns: Promise‹unknown›

---

Private _patchScreenshotIDtoStep

▸ _patchScreenshotIDtoStep(stepId: string, screenshotId: string): Promise‹unknown›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:246

Parameters:

Name	Type
stepId	string
screenshotId	string

Returns: Promise‹unknown›

---

Private _postSession

▸ _postSession(uri: string, body: object): Promise‹any›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:240

Parameters:

Name	Type
uri	string
body	object

Returns: Promise‹any›

---

Private _postStepBatch

▸ _postStepBatch(): Promise‹void›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:181

Returns: Promise‹void›

---

Private _releaseConsistencyLock

▸ _releaseConsistencyLock(): void

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:177

Returns: void

---

Private _startSession

▸ _startSession(): Promise‹ISession›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:300

Returns: Promise‹ISession›

---

Private _takeAndUploadScreenshot

▸ _takeAndUploadScreenshot(): Promise‹void›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:204

Returns: Promise‹void›

---

Private _takeConsistencyLock

▸ _takeConsistencyLock(): Promise‹void›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:172

Returns: Promise‹void›

---

Private _uploadScreenshot

▸ _uploadScreenshot(fileBlob: Blob): Promise‹string›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:273

Parameters:

Name	Type
fileBlob	Blob

Returns: Promise‹string›

the id of the uploaded screenshot

---

isMuted

▸ isMuted(): boolean

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:106

Returns: boolean

---

mute

▸ mute(): void

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:98

Returns: void

---

reportModuleAction

▸ reportModuleAction(moduleName: string, action: string, parameters: Record‹string, any›): Promise‹any›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:115

Parameters:

Name	Type
moduleName	string
action	string
parameters	Record‹string, any›

Returns: Promise‹any›

---

reportNotification

▸ reportNotification(notificationMessage: string, notificationType: string): Promise‹any›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:122

Parameters:

Name	Type
notificationMessage	string
notificationType	string

Returns: Promise‹any›

---

reportToolInteraction

▸ reportToolInteraction(toolName: string, interactionType: InteractionType, parameters?: Record‹string, any›): Promise‹any›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:110

Parameters:

Name	Type
toolName	string
interactionType	InteractionType
parameters?	Record‹string, any›

Returns: Promise‹any›

---

setEditor

▸ setEditor(editor: Editor): void

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:89

Parameters:

Name	Type
editor	Editor

Returns: void

---

setModelProjectID

▸ setModelProjectID(modelProjectId: string): Promise‹unknown›

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:93

Parameters:

Name	Type
modelProjectId	string

Returns: Promise‹unknown›

---

unmute

▸ unmute(): void

Defined in src/util/AnalyticsTrackerKyub/AnalyticsTrackerKyub.ts:102

Returns: void