registerExtension() - at.js 1.x

Provides a standard way to register a specific extension.

NOTE
This function is available for at.js versions 1.x only. This function was deprecated with the release of at.js 2.x. This function returns default content if used with at.js 2.x.

The options parameter is mandatory and has the following structure:

Key
Type
Required
Description
name
String
Yes
Extension name.
modules
Array[String]
Yes
An array of strings representing requested module names.
register
Function
Yes
A function used to initialize and build the extension. This function receives arguments based on modules array.

Notes:

  • If one of the parameters is not provided, an exception is thrown.
  • If the modules array is empty, an exception is thrown.

For more information and examples of how to use registerExtension, see the Adobe Experience Cloud Target atjs Extensions page on GitHub.

Settings Module Methods

Key
Type
Description
clientCode
String
Client code
serverDomain
String
Edge server domain
globalMboxName
String
Target global mbox name
globalMboxAutoCreate
Boolean
Indicates if auto-create is enabled or not
timeout
Number
Request timeout

Logger Module Methods

Key
Type
Description
log
Function
Logs the variable list of arguments to the browser console, if it exists. It is activated only when mboxDebug=true is passed to the URL.
error
Function
Logs the variable list of arguments to the browser console. It is activated only when there are serious errors, such as network timeout, HTML node not found, etc.
recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3