I Converge Plugin

Extends

  • ITrackingSdkOptional

Type parameters

• TConfiguration = object

Properties

analyticsLibPlugin?

optional analyticsLibPlugin: Record<string, unknown>

config?

optional config: TConfiguration

enabled?

optional enabled: boolean

isProxyPlugin?

optional isProxyPlugin: boolean

methods?

optional methods: object

Index signature

[n: string]: (...args) => any

name

name: string

privacyConfig?

optional privacyConfig: IConvergePluginPrivacyConfig

sdk

sdk: ConvergeSdk

type

type: string

version

version: string

Methods

activity()?

optional activity(name, props?, metadata?): Promise<void>

Parameters

• name: TrackingActivityNames

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.activity

addCrossDomainTracking()?

optional addCrossDomainTracking(url): string

Parameters

• url: string

Returns

string

addPaymentMethod()?

optional addPaymentMethod(order?, props?, metadata?): Promise<void>

Parameters

• order?: CommerceActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.addPaymentMethod

addToCart()?

optional addToCart(product?, props?, metadata?): Promise<void>

Parameters

• product?: CommerceActivityTrackingEventProductMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.addToCart

addToWishlist()?

optional addToWishlist(product?, props?, metadata?): Promise<void>

Parameters

• product?: CommerceActivityTrackingEventProductMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.addToWishlist

applyPromotionalCode()?

optional applyPromotionalCode(info?, props?, metadata?): Promise<void>

Parameters

• info?: PromotionalActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.applyPromotionalCode

beforeInit()?

optional beforeInit(): Promise<void>

Returns

Promise<void>

changeProductAttribute()?

optional changeProductAttribute(info?, props?, metadata?): Promise<void>

Parameters

• info?: ChangeProductAttributeActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.changeProductAttribute

collectIdentifiers()?

optional collectIdentifiers(): Promise<undefined | PersonIdentifiers>

Returns

Promise<undefined | PersonIdentifiers>

contactMessage()?

optional contactMessage(info?, props?, metadata?): Promise<void>

Parameters

• info?: LeadActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.contactMessage

custom()?

optional custom(name, props?, metadata?): Promise<void>

Parameters

• name: string

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.custom

filterItemsByAttribute()?

optional filterItemsByAttribute(filters?, props?, metadata?): Promise<void>

Parameters

• filters?: FilterItemsByAttributeActivityTrackingEventMetadata[]

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.filterItemsByAttribute

init()?

optional init(params): Promise<void>

Parameters

• params: any

Returns

Promise<void>

initComplete()?

optional initComplete(params): Promise<void>

Parameters

• params: any

Returns

Promise<void>

initiateCheckout()?

optional initiateCheckout(order?, props?, metadata?): Promise<void>

Parameters

• order?: CommerceActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.initiateCheckout

isLoaded()?

optional isLoaded(): boolean

Returns

boolean

keywordSearch()?

optional keywordSearch(info?, props?, metadata?): Promise<void>

Parameters

• info?: SearchActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.keywordSearch

lead()?

optional lead(info?, props?, metadata?): Promise<void>

Parameters

• info?: LeadActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.lead

newsletterSignup()?

optional newsletterSignup(info?, props?, metadata?): Promise<void>

Parameters

• info?: SignUpActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.newsletterSignup

onProfileChanged()?

optional onProfileChanged(profile): Promise<void>

Parameters

• profile: PersonIdentifiers

Returns

Promise<void>

onReady()?

optional onReady(): Promise<void>

Returns

Promise<void>

onViewContextSet()?

optional onViewContextSet(context): Promise<void>

Parameters

• context: ExperienceTrackingViewContext

Returns

Promise<void>

order()?

optional order(order?, props?, metadata?): Promise<void>

Parameters

• order?: CommerceActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.order

removeFromCart()?

optional removeFromCart(product?, props?, metadata?): Promise<void>

Parameters

• product?: CommerceActivityTrackingEventProductMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.removeFromCart

schedule()?

optional schedule(info?, props?, metadata?): Promise<void>

Parameters

• info?: LeadActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.schedule

startTrial()?

optional startTrial(info?, props?, metadata?): Promise<void>

Parameters

• info?: LeadActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.startTrial

subscriptionItemPurchase()?

optional subscriptionItemPurchase(order?, props?, metadata?): Promise<void>

Parameters

• order?: CommerceActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.subscriptionItemPurchase

userLogin()?

optional userLogin(info?, props?, metadata?): Promise<void>

Parameters

• info?: UserAccountActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.userLogin

userLoginSignup()?

optional userLoginSignup(info?, props?, metadata?): Promise<void>

Parameters

• info?: SignUpActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.userLoginSignup

viewContentItem()?

optional viewContentItem(info?, props?, metadata?): Promise<void>

Parameters

• info?: ContentItemActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.viewContentItem

viewPage()?

optional viewPage(props?, metadata?): Promise<void>

Parameters

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.viewPage

viewProduct()?

optional viewProduct(product?, props?, metadata?): Promise<void>

Parameters

• product?: CommerceActivityTrackingEventProductMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Inherited from

ITrackingSdkOptional.viewProduct