Sternum iOS SDK
sternum_ios_sdk_settings_t Struct Reference

Data Fields

const char * sternum_url
 Your Sternum dedicated transmission URL.
 
uint64_t access_token
 Device definition id for traces transmitted from the importing application.
 
const char * firmware_version
 String identifying client's application firmware version.
 
bool is_production
 If the application is in production/development phase. The SDK will report this status to the cloud during initialization for diagnostic purposes.
 
size_t max_cache_size_bytes
 The maximum amount of bytes to store on disk when caching traces. Cache is automatically emptied when internet connection is available. More...
 
bool relay_override_device_id
 if a remote device that originated the relayed traces cannot have a random a device ID, set to true and the application's device ID will be used for the relayed traces.
 
sternum_transmission_callbacks_t transmission_callbacks
 Optional callback functions that the SDK can invoke during transmission operation. More...
 

Field Documentation

◆ max_cache_size_bytes

size_t sternum_ios_sdk_settings_t::max_cache_size_bytes

The maximum amount of bytes to store on disk when caching traces. Cache is automatically emptied when internet connection is available.

Note
The recommended minimum cache size is 65KB to ensure that the biggest protocol payloads can be processed.

◆ transmission_callbacks

sternum_transmission_callbacks_t sternum_ios_sdk_settings_t::transmission_callbacks

Optional callback functions that the SDK can invoke during transmission operation.

Note
This structure allows users to define custom behavior for specific SDK events. If a callback is set to NULL, the SDK will safely proceed without invoking it.
See also
sternum_transmission_callbacks_t for more details on available callbacks.