Activity Sdk

Properties

definitionHelper

definitionHelper: ActivityDefinitionHelper

---

pageViewFiredForUrlCache

pageViewFiredForUrlCache: string[] = []

---

sdk

sdk: ConvergeSdk

Methods

activityFirePreconditionCheck()

activityFirePreconditionCheck(activityName, activity, props?, metadata?): Promise<boolean>

Parameters

• activityName: TrackingActivityNames

• activity: any

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<boolean>

---

generateRandomActivityIdentifier()

generateRandomActivityIdentifier(activityName, activity, _props?): Promise<string>

Parameters

• activityName: TrackingActivityNames

• activity: any

• _props?: IActivityCommonProps

Returns

Promise<string>

---

onAfterActivitySanitise()

onAfterActivitySanitise(activityName, activity, props?, metadata?): Promise<object>

Parameters

• activityName: TrackingActivityNames

• activity: any

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<object>

activity

activity: any

metadata?

optional metadata: IActivityMetadataProps

props

props: IActivityCommonProps

---

onBeforeActivityTrack()

onBeforeActivityTrack(activityName, activity, props?, metadata?): Promise<object>

Parameters

• activityName: TrackingActivityNames

• activity: any

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<object>

activity

activity: any

metadata?

optional metadata: IActivityMetadataProps

props

props: IActivityCommonProps

---

queueCollectionOfAutomaticActivities()

queueCollectionOfAutomaticActivities(): void

Returns

void

---

retrieveActivityIdentifier()

retrieveActivityIdentifier(activityName, activity, props?, metadata?): Promise<string>

Parameters

• activityName: TrackingActivityNames

• activity: any

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<string>