Developer Zone

SDK Status Checks¶

(TBCRESULT) startStatus

This method returns an integer constant that contains the status of startWithSync.

Return Type:

Integer constant. Possible values below:

* TBC_START_OK               (  2)
* TBC_START_LOADING          (  1)
* TBC_START_NOT_CALLED       (  0)
* TBC_START_CONNECTION_ERROR ( -2)
* TBC_START_AUTH_FAILURE     ( -3)
* TBC_START_SERVER_ERROR     ( -4)
* TBC_INTERNAL_ERROR         (-99)

(TBCRESULT) checkConnectionToURL: (NSString*)url withProductID: (NSString*)productID

This method allows you to test your application’s connectivity with the Usage Intelligence 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 method 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 that requires server communication does its own connection status check and returns any connection errors as part of its return type.

Parameters:

url (NSString*) - The URL against which to test connectivity (usually your CallHome URL)

productID (NSString*) - 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 Mismatch (-1)

Return Type:

Integer constant. Possible values below:

* TBC_OK                 (  1)
* TBC_CONNCHECK_MISMATCH ( -1)
* TBC_CONN_ERROR         ( -2)
* TBC_AUTH_FAILURE       ( -3)
* TBC_SERVER_ERROR       ( -4)
* TBC_INTERNAL_ERROR     (-99)

(TBCRESULT) checkConfig

This method is similar to checkConnectionToURL with the difference that instead of providing a URL and productID as parameters, it uses the configuration data provided via the Usage Intelligence data files and when calling createConfigWithURL. This method can be used to test connectivity to the Usage Intelligence server and can also be used to test proxy configuration.

Return Type:

Integer constant. Possible values below:

* TBC_OK                 (  1)
* TBC_CONNCHECK_MISMATCH ( -1)
* TBC_CONN_ERROR         ( -2)
* TBC_AUTH_FAILURE       ( -3)
* TBC_SERVER_ERROR       ( -4)
* TBC_CONFIG_NOT_CREATED ( -5)
* TBC_INTERNAL_ERROR     (-99)