Class: Utils

Members

isBeaconMethodAvailable

Check if beacon method is supported and available

isLocalStorageAvailable

Check if local storage is both supported and available

privacy

Privacy object

Methods

_crypto(){string}

Tracker/utils.js, line 717

Generate GUID with alphanumeric characters (v4 format) with Crypto or Math random.

_mathRand(){number}

Tracker/utils.js, line 740

Generate a random number of n digits with Crypto or Math random.

_num(len){string}

Tracker/utils.js, line 759

Generate GUID with numeric characters.

Name	Type	Description
len	number	Length of the generated GUID

addCallbackEvent(func)

Tracker/utils.js, line 936

Add callback event

Name	Type	Description
func	function	function to execute

addEvent(eventName, detailName, detailID, func)

Tracker/utils.js, line 992

Add custom event

Name	Type	Description
eventName	string	event name
detailName	string	detail name
detailID	number	detail uuid
func	function	function to execute

addEvtListener(obj, event, callback)

Tracker/utils.js, line 834

Add an event listener to an object.

Name	Type	Description
obj	Object	DOM Element on which you want to add the event listener
event	string	Event you need to listen
callback	function	When event is triggered, it takes one parameter which is the event object

addOptOutEvent(eventID, func)

Tracker/utils.js, line 1655

Add OPT-OUT event

Name	Type	Description
eventID	number	uuid
func	function	function to associate

arrayIndexOf(arr, elemToSearch){number}

Tracker/utils.js, line 646

Search an element in an array. Use Array.indexOf if possible.

Name	Type	Description
arr	Array
elemToSearch	*

cloneSimpleObject(inst, delUndefined){Object}

Tracker/utils.js, line 304

Copy an object which doesnt' contain functions/objects.

Name	Type	Description
inst	Object	Item that you want to clone
delUndefined	boolean	If true, undefined properties are not cloned

Returns:

of the instance

completeFstLevelObj(target, source, overload){object}

Tracker/utils.js, line 481

Complete the first level of an object with another.

Name	Type	Description
target	object
source	object
overload	boolean	If true, properties of the target will be overloaded by source ones if they exist

consentReceived(active)

Tracker/utils.js, line 1731

Specify whether consent has been obtained preventing or allowing data to be stored in cookies or local storage

Name	Type	Description
active	boolean	false to prevent data to be stored, true to allow data to be stored

dispatchCallbackEvent(name)

Tracker/utils.js, line 908

Dispatch event for callbacks

Name	Type	Description
name	string	Callback's name

dispatchEvent(eventName, detailName)

Tracker/utils.js, line 1028

Dispatch custom event

Name	Type	Description
eventName	string	event name
detailName	string	detail name

getObjectKeys(object){Array}

Tracker/utils.js, line 509

Get all keys from object.

Name	Type	Description
object	object

hashcode(str){number}

Tracker/utils.js, line 870

Make a unique number with a given string.

Name	Type	Description
str

isEmptyObject(tagObject){boolean}

Tracker/utils.js, line 335

Check if object is empty.

Name	Type	Description
tagObject	Object

isObject(contextualObject){boolean}

Tracker/utils.js, line 353

Check if parameter is an object.

Name	Type	Description
contextualObject	*

isOptedOut()

Tracker/utils.js, line 1715

Get OPTOUT activation status

isPrerender(callback){boolean}

Tracker/utils.js, line 799

Check if we are in Chrome or IE prerendering case.

Name	Type	Description
callback	function

isPreview(){boolean}

Tracker/utils.js, line 787

Check if we are in Safari previewing case.

isTabOpeningAction(event){boolean}

Tracker/utils.js, line 1753

Check if a key allowing a tab opening is pressed during a click

Name	Type	Description
event	Object	event object

jsonParse(str){Object}

Tracker/utils.js, line 604

Parse a string. Use JSON.parse if possible.

Name	Type	Description
str	String	JSON string that you want to parse to Javascript object

jsonSerialize(obj){Object|String}

Tracker/utils.js, line 583

Serialize any element. Use JSON.stringify if possible.

Name	Type	Description
obj	Object	Javascript object that you want to serialize to JSON

Returns:

JSON

loadScript(scriptObj, callback)

Tracker/utils.js, line 266

Load a script.

Name	Type	Description
scriptObj	object	Object containing script properties (url)
callback	function	Function to call on success or on error

objectToLowercase(tagObject){Object}

Tracker/utils.js, line 528

Change the keys of object to lowercase

Name	Type	Description
tagObject	Object	Object from tag

removeCallbackEvent(func)

Tracker/utils.js, line 949

Remove callback event

Name	Type	Description
func	function	function to remove

removeEvent(eventName, func)

Tracker/utils.js, line 1014

Remove custom event

Name	Type	Description
eventName	string	event name
func	function	function to execute

removeEvtListener(obj, event, callback)

Tracker/utils.js, line 852

Remove an event listener from an object.

Name	Type	Description
obj	Object	DOM Element on which you want to add the event listener
event	string	Event you need to listen
callback	function

removeOptOutEvent(func)

Tracker/utils.js, line 1668

Remove OPT-OUT event

Name	Type	Description
func	function	function to remove

setLocation(contextObj)

Tracker/utils.js, line 890

Force document location.

Name	Type	Description
contextObj	Object	Redirection's url and target (properties location & target)

splitProtocolAndKey(key, toLower){Object}

Tracker/utils.js, line 551

Process event key.

Name	Type	Description
key	String	Event key to split
toLower	boolean	Put the key to the property in lower case

trim(str){String}

Tracker/utils.js, line 625

Trim a string. Use String.prototype.trim if possible.

Name	Type	Description
str	String	string to trim

userOptedIn()

Tracker/utils.js, line 1704

Deactivate OPT-OUT mode

userOptedOut()

Tracker/utils.js, line 1693

Activate OPT-OUT mode adding OPT-OUT value in hit and storage for idclient parameter

uuid(){function}

Tracker/utils.js, line 697

Generate UUID.