TelemetryService

Index

Properties

• SERVER_URL

Accessors

• decodedUserId
• effectiveTelemetryMode
• isConsentRequired
• Instance

Methods

• addFileCloseEntry
• addFileOpenEntry
• addSpectralProfileEntry
• addTelemetryEntry
• checkAndGenerateId
• clearTelemetry
• dispose
• flushTelemetry
• getDb
• optIn
• optOut

Properties

publicstaticreadonlySERVER_URL

SERVER_URL: https://telemetry.cartavis.org = "https://telemetry.cartavis.org"

Accessors

decodedUserId

• get decodedUserId(): string

• Returns string

effectiveTelemetryMode

• get effectiveTelemetryMode(): TelemetryMode

• Returns TelemetryMode

isConsentRequired

• get isConsentRequired(): boolean

• Returns boolean

publicstaticInstance

• get Instance(): TelemetryService

• Returns TelemetryService

Methods

addFileCloseEntry

• addFileCloseEntry(id: number): Promise<void>

• Parameters

  • id: number

  Returns Promise<void>

addFileOpenEntry

• addFileOpenEntry(id: number, type: FileType, width: number, height: number, depth: number, stokes: number, isGenerated: boolean): Promise<void>

• Parameters

  • id: number

  • type: FileType

  • width: number

  • height: number

  • depth: number

  • stokes: number

  • isGenerated: boolean

  Returns Promise<void>

addSpectralProfileEntry

• addSpectralProfileEntry(profileLength: number, regionType: RegionType, regionId: number, width: number, height: number, depth: number): void

• Parameters

  • profileLength: number

  • regionType: RegionType

  • regionId: number

  • width: number

  • height: number

  • depth: number

  Returns void

addTelemetryEntry

• addTelemetryEntry(action: TelemetryAction, details?: object, id?: string): Promise<void>

• Parameters

  • action: TelemetryAction

  • optionaldetails: object

  • optionalid: string

  Returns Promise<void>

checkAndGenerateId

• checkAndGenerateId(shouldFlush?: boolean, shouldForceNewId?: boolean): Generator<any, boolean, unknown>

• Parameters

  • shouldFlush: boolean = false

  • shouldForceNewId: boolean = false

  Returns Generator<any, boolean, unknown>

clearTelemetry

• clearTelemetry(): Promise<void>

• Returns Promise<void>

publicdispose

• dispose(): void

• Returns void

flushTelemetry

• flushTelemetry(shouldIncludeEndSession?: boolean): Promise<void>

• Parameters

  • shouldIncludeEndSession: boolean = false

  Returns Promise<void>

getDb

• getDb(): Promise<IDBPDatabase<TelemetryDb>>

• Returns Promise<IDBPDatabase<TelemetryDb>>

optIn

• optIn(mode: TelemetryMode): Promise<void>

• Parameters

  • mode: TelemetryMode

  Returns Promise<void>

optOut

• optOut(): Promise<void>

• Returns Promise<void>