Developer Zone

SDK Status Checks

appStartStatus()

This returns an integer value which contains the status of appStart().

Return type:One of the values below:
* START_OK (2)
* START_LOADING (1)
* START_NOT_CALLED (0)
* START_CONNECTION_ERROR (-2)
* START_AUTH_FAILURE (-3)
* START_SERVER_ERROR (-4)
* START_RESPONSE_ERROR (-5)
* START_GENERIC_ERROR (-6)
connectionCheck(url[, productID = None])

This function allows you to test your application’s connectivity with the Trackerbird server and to confirm that your callhome URL is active and operational (for debugging purposes when using a custom callhome URL). You do NOT need to call this function before other API calls since this would cause unnecessary traffic on your clients’ machines. Instead, you should check the return types by each API call since every API call which requires server communication does its own connection status check and returns any connection errors as part of it’s return type.

This function is typically used in conjunction with setDefaultProxyCredentials() and setProxy() in order to confirm whether proxy authentication is required before calling appStart(). It is also used to test whether an Internet connection is available for the application or whether the Internet connection is down or possibly blocked by some firewall or webfilter at the gateway. The SDK will attempt to use cached credentials from IE to log onto the proxy, however in case this function reports an authentication failure, it means your application cannot make use of cached credentials so you will need to ask the user to enter credentials.

Parameters:
  • url (str) – The URL against which to test connectivity (usually your callhome URL)
  • productID (str) – This optional parameter accepts the product ID of your product. If provided, it will be used to confirm that you are using the correct URL for this specific product ID, and if not, it will return CONNECTION_CHECK_MISMATCH (-1)

rtype: One of the return status codes below.

* OK (1)
* CONNECTION_CHECK_MISMATCH (-1)
* CONN_ERROR (-2)
* AUTH_FAILURE (-3)
* SERVER_ERROR (-4)
configCheck()

This function is similar to connectionCheck() with the difference that instead of providing a URL and productID as parameters, it uses the configuration data provided via the Trackerbird data files and when calling createConfig(). This function can be used to test connectivity to the Trackerbird server and can also be used to test proxy configuration.

Return type:One of the return status constants below.
* OK (1)
* CONN_ERROR (-2)
* AUTH_FAILURE (-3)
* SERVER_ERROR (-4)
* CONFIG_NOT_CREATED (-5)
getPrivacyMode()

This function takes no parameters and will return the current privacy level for the Trackerbird SDK. For more information about Privacy Mode please check out setPrivacyMode().

rtype: One of the return status codes below.

* PRIVACYMODE_OFF (0)
* PRIVACYMODE_LOW (1)
* PRIVACYMODE_HIGH (2)
* CONFIG_NOT_CREATED (-5)