UNPKG

1.45 kBTypeScriptView Raw
1import { EventRunner, PageItem, PageInfo } from "../../event/core/event-runner";
2import { CartEvent } from "../types/base/cart-event";
3/**
4 * Specific runner used by YourID store.
5 *
6 * @class YourIDRunner
7 * @implements {Runner}
8 */
9export declare class YourIDRunner extends EventRunner {
10 /**
11 * Process DataLayer item.
12 *
13 * @protected
14 * @param {*} item Current item.
15 * @memberof YourIDRunner
16 */
17 protected processItem(item: PageItem): void;
18 /**
19 * Get current page info based on DataLayer.
20 *
21 * @protected
22 * @param {PageItem} item Current item.
23 * @return {PageInfo} Current page info.
24 * @memberof YourIDRunner
25 */
26 protected getPageInfo(item: PageItem): PageInfo;
27 /**
28 * Send order event, based on a order item.
29 *
30 * @protected
31 * @param {*} orderItem Order item from the DataLayer.
32 * @memberof YourIDRunner
33 */
34 protected sendOrderEvent(orderItem: PageItem): void;
35 /**
36 * Send cart event, based on a cart item.
37 *
38 * @protected
39 * @param {*} cartItem Cart item from the DataLayer.
40 * @memberof YourIDRunner
41 */
42 protected sendCartEvent(cartItem: PageItem): void;
43 /**
44 * Create a generic cart event.
45 *
46 * @protected
47 * @param {string} event Current event name.
48 * @return {CartEvent} Relevant cart event.
49 * @memberof YourIDRunner
50 */
51 protected createCartEvent(): CartEvent;
52}