@swrve/smarttv-sdk/dist/types/Events/EventFactory.d.ts

Swrve marketing engagement platform SDK for SmartTV OTT devices

import { ICampaignDownloadData, IQATriggerReport, IQACampaignTriggerEvent } from "./EventTypeInterfaces";
import ICampaignsDownloadedEvent from "../WebApi/Events/QA/ICampaignsDownloadedEvent";
import ICampaignTriggeredEvent from "../WebApi/Events/QA/ICampaignTriggeredEvent";
import IQAPurchaseEvent from "../WebApi/Events/QA/IQAPurchaseEvent";
import IQASessionStartEvent from "../WebApi/Events/QA/IQASessionStartEvent";
import ISessionStartEvent from "../WebApi/Events/ISessionStartEvent";
import INamedEvent from "../WebApi/Events/INamedEvent";
import IDictionary from "../utils/IDictionary";
import IUserUpdateEvent from "../WebApi/Events/IUserUpdateEvent";
import IDeviceUpdateEvent from "../WebApi/Events/IDeviceUpdateEvent";
import IQADeviceUpdateEvent from "../WebApi/Events/QA/IQADeviceUpdateEvent";
import IReadonlyDictionary from "../utils/IReadonlyDictionary";
import IPurchaseEvent from "../WebApi/Events/IPurchaseEvent";
import IIAPEvent from "../WebApi/Events/IIAPEvent";
import IReward from "../WebApi/Events/IReward";
import ICurrencyGivenEvent from "../WebApi/Events/ICurrencyGivenEvent";
import IQANamedEvent from "../WebApi/Events/QA/IQANamedEvent";
import IQAUserUpdateEvent from "../WebApi/Events/QA/IQAUserUpdateEvent";
import IQAIAPEvent from "../WebApi/Events/QA/IQAIAPEvent";
import IQACurrencyGivenEvent from "../WebApi/Events/QA/IQACurrencyGivenEvent";
import IButtonClickedEvent from "../WebApi/Events/IButtonClickedEvent";
import IQAButtonClickedEvent from "../WebApi/Events/QA/IQAButtonClickedEvent";
import IGenericCampaignEvent from "../WebApi/Events/IGenericCampaignEvent";
import IQAGenericCampaignEvent from "../WebApi/Events/QA/IQAGenericCampaignEvent";
export declare class EventFactory {
    /************************ Named Event ***********************************************************/
    getNamedEvent(name: string, payload: IDictionary<string | number>, seqnum: number, time: number): INamedEvent;
    getWrappedNamedEvent(event: INamedEvent): IQANamedEvent;
    /************************ Generic Campaign Event ***********************************************************/
    getGenericCampaignEvent(seqnum: number, campaignType: string, actionType: string, id: string, contextId: string, payload: IDictionary<string>): IGenericCampaignEvent;
    getWrappedGenericCampaignEvent(event: IGenericCampaignEvent): IQAGenericCampaignEvent;
    /************************ User Update with Date Event ***********************************************************/
    getUserUpdateWithDate(keyName: string, date: Date, seqnum: number, time: number): IUserUpdateEvent;
    getWrappedUserUpdateWithDate(event: IUserUpdateEvent): IQAUserUpdateEvent;
    /************************ User Update Event ***********************************************************/
    getUserUpdate(attributes: IReadonlyDictionary<string | number | boolean>, seqnum: number, time: number): IUserUpdateEvent;
    getWrappedUserUpdate(event: IUserUpdateEvent): IQAUserUpdateEvent;
    /************************ Device Update Event ***********************************************************/
    getDeviceUpdate(attributes: IReadonlyDictionary<string | number>, seqnum: number, time: number): IDeviceUpdateEvent;
    getWrappedDeviceUpdate(event: IDeviceUpdateEvent): IQADeviceUpdateEvent;
    /************************ Purchase Event ***********************************************************/
    getPurchaseEvent(keyName: string, currency: string, cost: number, quantity: number, seqnum: number, time: number): IPurchaseEvent;
    getWrappedPurchaseEvent(event: IPurchaseEvent): IQAPurchaseEvent;
    /************************ InAppPurchaseEventWithoutReceipt ***********************************************************/
    getInAppPurchaseEventWithoutReceipt(quantity: number, productId: string, productPrice: number, currency: string, seqnum: number, time: number, rewards?: IReadonlyDictionary<IReward>): IIAPEvent;
    getWrappedInAppPurchaseEventWithoutReceipt(event: IIAPEvent): IQAIAPEvent;
    /************************ Session Start Event ***********************************************************/
    getStartSessionEvent(seqnum: number, time: number): ISessionStartEvent;
    getWrappedSessionStart(event: ISessionStartEvent): IQASessionStartEvent;
    /************************ Currency Given Event ***********************************************************/
    getCurrencyGivenEvent(given_currency: string, given_amount: number, seqnum: number, time: number): ICurrencyGivenEvent;
    getWrappedCurrencyGivenEvent(event: ICurrencyGivenEvent): IQACurrencyGivenEvent;
    /************************ First Install Event ***********************************************************/
    getFirstInstallEvent(installDate: number, seqnum: number): INamedEvent;
    getWrappedFirstInstallEvent(event: INamedEvent): IQANamedEvent;
    /************************ Message Events ***********************************************************/
    getButtonClickEvent(seqnum: number, messageId: number, name: string, embedded: string, platform: string, buttonId: number, pageId: string, pageName: string): IButtonClickedEvent;
    getQAButtonClickEvent(campaign_id: number, variant_id: number, button_name: string, action_type: string, action_value: string, seqnum: number): IQAButtonClickedEvent;
    getImpressionEvent(messageId: number, seqnum: number, payload?: IDictionary<string | number>): INamedEvent;
    getPageViewEvent(seqnum: number, id: string, contextId: string, payload: IDictionary<string>): IGenericCampaignEvent;
    getNavigationEvent(seqnum: number, id: string, contextId: string, payload: IDictionary<string>): IGenericCampaignEvent;
    getDismissEvent(seqnum: number, id: string, contextId: string, payload: IDictionary<string>): IGenericCampaignEvent;
    /************************ QA Only Events ***********************************************************/
    getCampaignsDownloadedEvent(seqnum: number, campaignList: ReadonlyArray<ICampaignDownloadData>): ICampaignsDownloadedEvent;
    getCampaignTriggeredEvent(event_name: string, event_payload: object, reason: string, displayed: string, campaigns?: IQACampaignTriggerEvent[]): IQATriggerReport;
    getWrappedCampaignTriggeredEvent(seqnum: number, event: IQATriggerReport): ICampaignTriggeredEvent;
}