Developer Zone

SDK Status Checks

StartStatusEnum TBClass.StartStatus ()

This method returns a StartStatusEnum value that contains the status of TBClass.Start.

Return Type:

StartStatusEnum enum values below:

* OK (2)
* Loading (1)
* StartNotCalled (0)
* ConnectionError (-2)
* AuthenticationFailure (-3)
* ServerError (-4)
* InternalError (-99)

ConnectionReturn TBClass.ConnectionCheck (String url, String productId = null)

This method allows you to test your application’s connectivity with the Revulytics 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.

This method is typically used in conjunction with TBClass.SetDefaultProxyCredentials and TBClass.SetProxy in order to confirm whether proxy authentication is required before calling TBClass.Start. 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 web filter at the gateway. The SDK will attempt to use cached credentials from Internet Explorer to log onto the proxy, however in case this method 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 (string) - The URL against which to test connectivity (your CallHome URL)

productId (string) - 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:

ConnectionReturn enum values below:

* ConnectionOK (1)
* Mismatch (-1)
* ConnectionError (-2)
* AuthenticationFailure (-3)
* ServerError (-4)
* InternalError (-99)

ConfigCheckReturn TBClass.ConfigCheck ()

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

Return Type:

ConfigCheckReturn enum values below:

* ConnectionOK (1)
* ConnectionError (-2)
* AuthenticationFailure (-3)
* ServerError (-4)
* ConfigNotCreated (-5)
* InternalError (-99)