itd-api / TelemetryBatch

Interface: TelemetryBatch

Defined in: resources/telemetry.ts:128

Явно управляемый накопитель событий телеметрии.

Properties

closed

readonly closed: boolean;

Defined in: resources/telemetry.ts:134

Закрыт ли накопитель.

---

pendingDwell

readonly pendingDwell: number;

Defined in: resources/telemetry.ts:130

Число ожидающих событий просмотра.

---

pendingInteractions

readonly pendingInteractions: number;

Defined in: resources/telemetry.ts:132

Число ожидающих событий взаимодействия.

Methods

close()

close(): Promise<void>;

Defined in: resources/telemetry.ts:152

Отправляет накопленные события и закрывает накопитель.

Returns

Promise<void>

---

dwell()

dwell(entry): this;

Defined in: resources/telemetry.ts:136

Добавляет одно или несколько событий просмотра.

Parameters

entry

DwellEntry | readonly DwellEntry[]

Returns

this

---

flush()

flush(options?): Promise<void>;

Defined in: resources/telemetry.ts:150

Отправляет накопленные события.

Опции позволяют заменить, например, отменённый signal при повторной попытке.

Parameters

options?

TelemetryOptions

Returns

Promise<void>

---

interaction()

interaction(entry): this;

Defined in: resources/telemetry.ts:138

Добавляет одно или несколько событий взаимодействия.

Parameters

entry

| InteractionEntry | readonly InteractionEntry[]

Returns

this

---

photoOpen()

photoOpen(input): this;

Defined in: resources/telemetry.ts:140

Добавляет событие открытия фотографии.

Parameters

input

PhotoOpenInput

Returns

this

---

startView()

startView(input): ViewTracker;

Defined in: resources/telemetry.ts:144

Начинает измерение просмотра, которое после finish() попадёт в этот накопитель.

Parameters

input

ViewTrackerInput

Returns

ViewTracker

---

videoProgress()

videoProgress(input): this;

Defined in: resources/telemetry.ts:142

Добавляет событие прогресса просмотра видео.

Parameters

input

VideoProgressInput

Returns

this