config

ADBMobile. config

Members

(static, constant) PRIVACY_STATUS_OPT_IN :string

Type:
  • string

(static, constant) PRIVACY_STATUS_OPT_OUT :string

Type:
  • string

Methods

(static) setUserIdentifier(userIdentifier)

Sets user identifier.

Parameters:
Name Type Description
userIdentifier string

User Identifier

(static) getUserIdentifier() → {string}

Gets user identifier.

Returns:

User Identifier

Type
string

(static) getAllIdentifiersAsync(callback)

Returns all user IDs known and stored by the SDK

Parameters:
Name Type Description
callback ADBMobile.config~identitiesCallback

Identities Callback

(static) setPrivacyStatus(privacy)

Sets privacy status.

Parameters:
Name Type Description
privacy string

Valid values are ADBMobile.config.PRIVACY_STATUS_OPT_OUT or ADBMobile.config.PRIVACY_STATUS_OPT_IN

(static) getPrivacyStatus() → {string}

Gets privacy status.

Returns:

Returned value is either ADBMobile.config.PRIVACY_STATUS_OPT_OUT or ADBMobile.config.PRIVACY_STATUS_OPT_IN

Type
string

(static) setLoggerCallback(callback)

Raises callback with log messages.

Parameters:
Name Type Description
callback ADBMobile.config~loggerCallback

Logger Callback

(static) setDebugLogging(enable)

Enable/Disable debug logging.

Parameters:
Name Type Description
enable bool

Enable/Disable debug logging

(static) getDebugLogging() → {bool}

Check if debug logging is enabled/disabled.

Returns:

Returns in debug logging is enabled/disabled

Type
bool

(static) update(config)

Updates Media configuration read from ADBMobileConfig when initializing the SDK.
Note:- This method should only be called before starting a new tracking session, i.e., Before trackSessionStart() API.

        ADBMobile.config.update({
            "mediaHeartbeat":{
                "channel":"newchannel"
            }
        })
Parameters:
Name Type Description
config object

New config object

Type Definitions

identitiesCallback(identitiesJsonString)

This callback returns back the all IDs known and stored by the SDK

Parameters:
Name Type Description
identitiesJsonString string

Valid JSON string containing
identities known by the SDK, or an empty JSON string if none exist

loggerCallback(msg)

Logger Callback.

Parameters:
Name Type Description
msg string

Log Message