Skip to main content

utiq

Utiq

Integration​

In your index.ts import confiant and register the module.

import { Utiq } from '@highfivve/module-utiq';
moli.registerModule(new Utiq({
  assetUrl: 'https://utiq.example.com/utiqLoader.js'
}));

Resources​

Interfaces​

UtiqAPI​

The Utiq API object.

NOTE: Only the methods we require in this module are listed here. Checks the docs if you need more and add them accordingly.

See​

https://docs.utiq.com/docs/api-methods

Methods​

addEventListener()​

addEventListener<T>(event, listener): void

Type Parameters​

• T extends keyof UtiqEventMap

Parameters​

• event: T

• listener: UtiqEventListener<T>

Returns​

void

See​

https://docs.utiq.com/docs/event-listeners

getIdGraphEntry()​

getIdGraphEntry(entryName): string

Parameters​

• entryName: string

Name of the entry that should be extracted from the ID graph. Accepted values are: mtid, atid, attrid, category, ttl, domain

Returns​

string

See​

https://docs.utiq.com/docs/api-methods#APIMethods-getIdGraphEntry

removeEventListener()​

removeEventListener<T>(event, listener): void

Type Parameters​

• T extends keyof UtiqEventMap

Parameters​

• event: T

• listener: UtiqEventListener<T>

Returns​

void

See​

https://docs.utiq.com/docs/event-listeners

showConsentManager()​

showConsentManager(): void

Displays the Utiq Consent Manager overlay popup. This method operates with the default Utiq consent management setup. Find more details on the []Utiq dedicated consent popup page](https://docs.utiq.com/docs/1b-consent-experience-utiq-separate-pop-up-model-u).

Returns​

void

See​

https://docs.utiq.com/docs/api-methods#APIMethods-showConsentManager

Type Aliases​

UtiqWindow​

UtiqWindow: object

Type declaration​

Utiq?​

optional Utiq: object

Utiq.API?​

optional API: UtiqAPI

public API methods. Only available after the Utiq script is loaded.

Utiq.config?​

optional config: modules.utiq.UtiqConfigOptions

The Utiq loader script can be configured using the Utiq.config object. Will be set from the config options provided in the module configuration.

Utiq.queue​

queue: Pick<UtiqCommand[], "push">

_enqAdpParam?​

optional _enqAdpParam: Record<string, string>

Emetriq adapter parameter object for UTIQ integration

Functions​

createUtiq()​

createUtiq(): IModule

Returns​

IModule