core/product-experience/gainsight.service.ts
A service to manage the Gainsight integration. It allows to load the tag and
Properties |
|
Methods |
Accessors |
constructor(appState: AppStateService, options: OptionsService, cookieBannerService: CookieBannerService, userPreferencesService: UserPreferencesService)
|
|||||||||||||||
|
Parameters :
|
| Async canEditProductExperienceSettings |
canEditProductExperienceSettings()
|
|
Returns :
Promise<boolean>
|
| Async getGainsightKey |
getGainsightKey()
|
|
Returns :
{}
|
| identify | ||||||||||||||||||
identify(user, tenant, instanceId, versionUI?, versionBE?)
|
||||||||||||||||||
|
Identifies the user/account at Gainsight.
Parameters :
Returns :
void
|
| Async isGainsightDisabledInUserPreferences |
isGainsightDisabledInUserPreferences()
|
|
Returns :
{}
|
| Async loadTag | ||||||||||||
loadTag(currentTenant, identify)
|
||||||||||||
|
Load the script tag and calls the identify function to start the tracking.
Parameters :
Returns :
any
|
| setFunctionalCookie | ||||||
setFunctionalCookie(value: boolean)
|
||||||
|
Parameters :
Returns :
void
|
| shouldLoadGainsightTag | ||||||||
shouldLoadGainsightTag(customProperties: ICustomProperties)
|
||||||||
|
Checks if the Gainsight's tag should be loaded. The decision to load Gainsight will depend on custom properties and functional cookies.
Parameters :
Returns :
boolean
|
| triggerEvent |
triggerEvent(eventName: string, props?: object)
|
|
Returns :
void
|
| tagFunction$ |
tagFunction$:
|
Default value : new BehaviorSubject(null)
|
|
A subject that emits the tag function as soon as a new tag is set. |
| Readonly USER_PREFERENCES_KEY |
USER_PREFERENCES_KEY:
|
Type : string
|
Default value : 'gainsightEnabled'
|
| tagFunction |
gettagFunction()
|
|
Returns the tag global function which can be used to identify user or add special events. |