Class NetworkUsageReporter

Client-side network accounting. Inert until enable is called — the BIM.works app does that only when the server reports client reporting is switched on.

Index

Constructors

Methods

addBytes disable enable flush isEnabled record

Constructors

constructor

new NetworkUsageReporter(settings?: NetworkUsageSettings): NetworkUsageReporter
Parameters
- Optionalsettings: NetworkUsageSettings
Returns NetworkUsageReporter
- Defined in jsclient.d.ts:39

Methods

addBytes

addBytes(
    point: string,
    direction: "SENT" | "RECEIVED",
    bytes: number,
    detail?: string,
): void
Parameters
- point: string
- direction: "SENT" | "RECEIVED"
- bytes: number
- Optionaldetail: string
Returns void
- Defined in jsclient.d.ts:44

disable

disable(): void
Returns void
- Defined in jsclient.d.ts:41

enable

enable(client: Client): void
Parameters
- client: Client
Returns void
- Defined in jsclient.d.ts:40

flush

flush(isUnload?: boolean): Promise<void>
Parameters
- OptionalisUnload: boolean
Returns Promise<void>
- Defined in jsclient.d.ts:45

isEnabled

isEnabled(): boolean
Returns boolean
- Defined in jsclient.d.ts:42

record

record(
    point: string,
    direction: "SENT" | "RECEIVED",
    bytes: number,
    durationMs: number,
    detail?: string,
): void
Parameters
- point: string
- direction: "SENT" | "RECEIVED"
- bytes: number
- durationMs: number
- Optionaldetail: string
Returns void
- Defined in jsclient.d.ts:43