Satellite API Types Method Arguments API Issues Wiki
This repository contains unofficial Adobe DTM Satellite Library documentation. The Satellite Library is used for Adobe DTM. It manages and tracks data for Adobe DTM and Adobe Analytics. If you have insight, please contribute!
This is an initial copy/paste of the global object.
The "Types" Glossary is used to clearly define types for each method or property of the Satellite API.
- array:
[array]- examples:
[1, 2, 3]
- examples:
- bool:
boolean- examples:
true,false
- examples:
- Æ’:
function,- examples:
function() {},() => {}
- examples:
- num:
number,- examples:
1,2,6
- examples:
- obj:
{object}, - examples:
{ name: 'Randy', id: '1bd45' }
The Method Argument Glossary is used to clearly define arguments used witin Satellite Methods.
- a: array
- type:
[array] - examples:
[1, 2, 3]
- type:
- e: event
- type: todo
- examples: todo
- i: iterator
- type: todo
- examples: todo
- n: todo
- type: todo
- examples: todo
- t:
text,- type:
"is a string" - examples: "string", "this is a string"
- type:
- initialized:
bool - uuid:
num - dataCache:
{obj} - $data:
Æ’ (t,e,n) - BaseTool:
Æ’ (t) - Logger:
{obj}- outputEnabled:
bool - messages:
[array] - keepLimit:
num - flushed:
bool - LEVELS:
[array]
- outputEnabled:
- QueryParams:
{obj} - URI:
Æ’ () - URL:
Æ’ () - addEventHandler:
Æ’ (t,e,n) - any:
Æ’ (t,e,n) - appVersion:
"string" - availableEventEmitters:
[array] - availableTools:
{obj} - backgroundTasks:
Æ’ () - basePath:
- bind:
Æ’ (t,e) - bindEvent:
Æ’ (t,e) - bindEventOnce:
Æ’ (t,e) - browserInfo:
{obj}- browser:
"string" - os:
"string" - deviceType:
"Desktop"
- browser:
- buildDate:
"string" - checkAsyncInclude:
Æ’ () - cleanText:
Æ’ (t) - configurationSettings:
{obj}- pageLoadRules:
[array] - rules:
[array] - directCallRules:
[array] - settings:
{obj} - data:
{obj}
- pageLoadRules:
- contains:
Æ’ (t,e) - containsElement:
Æ’ (t,e) - cssQuery:
Æ’ (e,n) - data:
{obj}- URI:
"string" - browser:
{obj} - cartItems:
[array] - revenue:
"string" - host:
{obj}
- URI:
- dataCache:
{obj} - dataElementSafe:
Æ’ (t,e) - dataElements:
obj- _campaign:
{obj}, - _campaignContent:
{obj} - _campaignMedium:
{obj} - _campaignSource:
{obj}
- _campaign:
- detectBrowserInfo:
Æ’ () - directCallRules:
[array] - domReady:
Æ’ (t) - dynamicRules:
[array] - each:
Æ’ (t,e,n) - ecommerce:
{obj}- addItem:
Æ’, - addTrans:
Æ’, - trackTrans:
Æ’
- addItem:
- encodeObjectToURI:
Æ’ (t) - ensureCSSSelector:
Æ’ () - equalsIgnoreCase:
Æ’ (t,e) - errors:
[array] - escapeForHtml:
Æ’ (t) - escapeHtmlParams:
Æ’ (t) - eventEmitterBackgroundTasks:
Æ’ () - eventEmitters:
[array] - every:
Æ’ (t,e,n) - evtHandlers:
{obj} - aftertoolinit:
[array] - execute:
Æ’ (t,e,n,i) - extend:
Æ’ (t,e) - filter:
Æ’ (t,e,n) - filterRules:
Æ’ () - find:
Æ’ (t,e,n) - fireEvent:
Æ’ (t,e) - fireOnceEvents:
[array] - firePageLoadEvent:
Æ’ (t) - fireRule:
Æ’ (t,e,n) - flushPendingCalls:
Æ’ (t) - getCaseSensitivityQueryParamsMap:
Æ’ (t) - getDataElement:
Æ’ (t,e,n) - getElementProperty:
Æ’ (t,e) - getObjectProperty:
Æ’ (t,e,n) - getQueryParam:
Æ’ (t) - getQueryParamCaseInsensitive:
Æ’ (t) - getToolsByType:
Æ’ (t) - getUniqueRuleEvents:
Æ’ () - getUserAgent:
Æ’ () - getVar:
Æ’ (n,a,r) - getVars:
Æ’ (t,e,n) - getVisitorId:
Æ’ () - handleEvent:
Æ’ (t) - handleOverrides:
Æ’ () - hasAttr:
Æ’(t,e) - hasMultipleDomains:
Æ’ () - **hasSelector:
bool - indexOf:
Æ’ (t,e) - inherit:
Æ’ (t,e) - init:
Æ’ (e) - initEventEmitters:
Æ’ () - initTools:
Æ’ (t) - initialized:
bool - isArray:
Æ’ isArray() - isHttps:
Æ’ () - isLinkTag:
Æ’ (t) - isLinked:
Æ’ (t) - **isLinkerLink:
Æ’ (t) - isNaN:
Æ’ (t) - isNumber:
Æ’ (t) - isObject:
Æ’ (t) - isOutboundLink:
Æ’ (t) - isRegex:
Æ’ (t) - isRightClick:
Æ’ (t) - isRuleActive:
Æ’ (t,e) - isString:
Æ’ (t) - isSubdomainOf:
Æ’ (t,e) - isVMLPoisoned:
Æ’ (t) - keys:
Æ’ (t) - loadEventBefore:
Æ’ (t,e) - loadPrivacyManager:
Æ’ () - loadScript:
Æ’ (t,n) - loadScriptOnce:
Æ’ (t,e) - loadScriptSync:
Æ’ (t) - loadStoredSettings:
Æ’ () - loadedScriptRegistry:
{obj} - logError:
Æ’ (t) - map:
Æ’ (t,e,n) - matchesCss:
Æ’ (n,i) - notify:
Æ’ () - onEvent:
Æ’ (t) - pageBottom:
Æ’ () - pageLoadPhases:
[array] - pageLoadRules:
[array] - parseQueryParams:
Æ’ (t) - poll:
Æ’ (t,e,n) - prepareLoadPrivacyManager:
Æ’ () - preprocessArguments:
Æ’ (t,e,n,i,a) - preventDefault:
Æ’ (t) - privacyManagerParams:
Æ’ () - propertiesMatch:
Æ’ (t,e) - publishDate:
"string" - pushAsyncScript:
Æ’ (t) - pushBlockingScript:
Æ’ (t) - readCookie:
Æ’ (t) - readStoredSetting:
Æ’ (e) - realGetDataElement:
Æ’ (e) - registerEvents:
Æ’ (t,e) - registerEventsForTags:
Æ’ (t,n) - registerNewElementsForDynamicRules:
Æ’ () - removeCookie:
Æ’ (t) - removeEventHandler:
Æ’ (t,e,n) - replace: Æ’ (t,e,n,i)
- ruleInScope:
Æ’ (t,n) - ruleMatches:
Æ’ (t,e,n,i) - rules:
[array] - scriptOnLoad:
Æ’ (t,e,n) - searchVariables:
Æ’ (t,e,n) - setCookie:
Æ’ (t,n,i) - setDebug:
Æ’ (e) - setFormListeners:
Æ’ () - setListeners:
Æ’ () - setLocation:
Æ’ (e) - setVar:
Æ’ () - setVideoListeners:
Æ’ () - settings:
{obj}- trackInternalLinks:
bool - libraryName:
"string" - isStaging:
bool - allowGATTcalls:
bool - downloadExtensions:
regex
- trackInternalLinks:
- specialProperties
{obj}- text:
Æ’ - cleanText:
Æ’
- text:
- stagingLibraryOverride:
Æ’ () - stopPropagation:
Æ’ (t) - stringify:
Æ’ (t,e) - text:
Æ’ (t) - textMatch:
Æ’ (t,e) - throttle:
Æ’ (t,e) - toArray:
Æ’ (e) - tools:
{obj} **track:**Æ’ (t)`- trim:
Æ’ (t) - unbindEvent:
Æ’ (t,e) - updateQueryParams:
Æ’ () - uuid:
num - values:
Æ’ (t) - visibility:
{obj}- isHidden:
Æ’, - isVisible:
Æ’, - getHiddenProperty:
Æ’, - getVisibilityEvent:
Æ’
- isHidden:
- whenEvent:
Æ’ (t,e) - proto:
{obj}