TelemetryService

Index

Properties

• ServerUrl

Accessors

• consentRequired
• decodedUserId
• effectiveTelemetryMode
• Instance

Methods

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

Properties

publicstaticreadonlyServerUrl

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

Accessors

consentRequired

• get consentRequired(): boolean

• Returns boolean

decodedUserId

• get decodedUserId(): string

• Returns string

effectiveTelemetryMode

• get effectiveTelemetryMode(): TelemetryMode

• Returns TelemetryMode

staticInstance

• 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, generated: boolean): Promise<void>

• Parameters

  • id: number

  • type: FileType

  • width: number

  • height: number

  • depth: number

  • stokes: number

  • generated: 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(flush?: boolean, forceNewId?: boolean): Generator<Promise<void> | Promise<AxiosResponse<any, any>> | Generator<Promise<any>, any, unknown>, boolean, unknown>

• Parameters

  • flush: boolean = false

  • forceNewId: boolean = false

  Returns Generator<Promise<void> | Promise<AxiosResponse<any, any>> | Generator<Promise<any>, any, unknown>, boolean, unknown>

clearTelemetry

• clearTelemetry(): Promise<void>

• Returns Promise<void>

flushTelemetry

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

• Parameters

  • includeEndSession: 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>