Error Documentation - Android

BlazeSDK provides structured and consistent error information through the BlazeResult.Error type. Errors can be delivered globally via the SDK delegate, locally via method completion handlers, or via source delegates for widgets, entryPoints, etc., depending on the context.

Error Structure

The BlazeResult.Error data class represents the public-facing error structure returned by the Blaze SDK.

data class Error(
    val statusCode: Int,
    val domain: ErrorDomain,
    val reason: ErrorReason,
    val message: String,
    val metadata: Map<String, String>,
    val cause: Throwable?
)

statusCode Optional HTTP or custom status code.
domain The domain or category of the error.
reason The specific reason for the error.
message Human-readable error message.
metadata Additional metadata related to the error.
cause The underlying exception that caused the error, if any.

Error Delivery Mechanisms

1. BlazeSDKDelegate

Errors marked as 'Thrown to Global Delegate' in the table below are automatically forwarded to your BlazeSDKDelegate implementation via the onErrorThrown callback.

// Example of handling error via BlazeSDKDelegate
private fun createBlazeSDKGlobalDelegate(): BlazeSDKDelegate {
    return object : BlazeSDKDelegate {
        override fun onEventTriggered(eventData: BlazeEventData) {
            onGlobalEventTriggered(eventData)
        }
        
        override fun onErrorThrown(error: BlazeResult.Error) {
            onGlobalErrorThrown(error)
        }
    }
}

private fun onGlobalErrorThrown(error: BlazeResult.Error) {
    // Handle specific error domains and reasons
    when (error.domain) {
        ErrorDomain.INITIALIZATION -> {
            handleInitializationError(error)
        }
        ErrorDomain.WIDGET -> {
            handleWidgetError(error)
        }
        else -> {
            // Handle other domains
        }
    }
}

2. Completion Handlers

Some errors are returned only through completion handlers for specific API calls (e.g., initialization, setting user ID, universal link processing). Therefore, in these cases, you should handle errors exclusively in the callback, as this is the only way to properly catch and respond to them.

// Error should be handled via completion callback
BlazeSDK.init(
  	apiKey =  "your-api-key",
  	completionBlock = {
      	Log.d("Application", "BlazeSDK.init success completionBlock..")
    },
  	errorBlock = { error ->
      	Log.e("Application", "BlazeSDK.init: errorBlock: Init Error = $error")
	      when (error.reason) {
            ErrorReason.INVALID_API_KEY ->  {
                Log.e("Application", "BlazeSDK.init: errorBlock: Invalid API Key")
            }
            ErrorReason.SDK_ALREADY_INITIALIZED -> {
                Log.e("Application", "BlazeSDK.init: errorBlock: SDK Already Initialized")
            }
            else -> {} // Handle other error reasons as needed
        }

    },
)

3. Source Delegates

Component-specific errors are delivered via source delegate onDataLoadComplete handlers for widgets, containers, and entry points:

BlazeWidgetDelegate → Widget load errors via onDataLoadComplete handler
BlazePlayerInContainerDelegate → Container load errors via onDataLoadComplete handler
BlazePlayerInInlineDelegate → Inline player load errors via onDataLoadComplete handler
BlazePlayerEntryPointDelegate → Entry point load errors via onDataLoadComplete handler

val widgetDelegate: BlazeWidgetDelegate = object : BlazeWidgetDelegate {

    override fun onDataLoadStarted(playerType: BlazePlayerType, sourceId: String?) {
			// handle onDataLoadStarted
    }

    override fun onDataLoadComplete(
        playerType: BlazePlayerType,
        sourceId: String?,
        itemsCount: Int,
        result: BlazeResult<Unit>
    ) {
        when (result) {
            is BlazeResult.Success -> {
                // Handle successful load
            }
            is BlazeResult.Error -> {
                handleWidgetError(result)
            }
        }
    }
}

Notes

All errors marked with ✅ Yes are forwarded to the global delegate.

Error Codes

Initialization Errors (1100–1199)

Code	Domain	Reason	Thrown to Global Delegate
1100	INITIALIZATION	INVALID_API_KEY	❌ No
1101	INITIALIZATION	NETWORK_FAILURE	❌ No
1102	INITIALIZATION	SDK_ALREADY_INITIALIZED	❌ No
1103	INITIALIZATION	APPLICATION_NOT_INITIALIZED	❌ No
1104	INITIALIZATION	INVALID_GEO_RESTRICTION_CODE	❌ No
1105	INITIALIZATION	NO_INTERNET_CONNECTION	❌ No
1106	INITIALIZATION	INVALID_APP_CONFIG	❌ No
1107	INITIALIZATION	INITIALIZATION_TIME_OUT	❌ No

Content Preparation Errors (1200–1299)

Code	Domain	Reason	Thrown to Global Delegate
1200	CONTENT_PREPARATION	ILLEGAL_PREPARE_ON_DATA_SOURCE_TYPE	❌ No

Widget Errors (1300–1399)

Code	Domain	Reason	Thrown to Global Delegate
1300	WIDGET	NO_AVAILABLE_CONTENT_FOR_DATA_SOURCE	❌ No
1301	WIDGET	INVALID_DATA_SOURCE_TYPE_PROVIDED	❌ No
1302	WIDGET	FAILED_FETCHING_CONTENT	❌ No

Entry Point Errors (1400–1499)

Code	Domain	Reason	Thrown to Global Delegate
1400	ENTRY_POINT	NO_AVAILABLE_CONTENT_FOR_DATA_SOURCE	❌ No
1401	ENTRY_POINT	INVALID_DATA_SOURCE_TYPE_PROVIDED	❌ No
1402	ENTRY_POINT	FAILED_FETCHING_CONTENT	❌ No
1403	ENTRY_POINT	FAILED_PLAYING_STORY	❌ No
1404	ENTRY_POINT	FAILED_PLAYING_MOMENT	❌ No
1405	ENTRY_POINT	FAILED_PLAYING_VIDEO	❌ No

Player Errors (1500–1599)

Code	Domain	Reason	Thrown to Global Delegate
1505	PLAYER	NO_INTERNET_CONNECTION	✅ Yes
1506	PLAYER	EXPIRED_ASSET	✅ Yes
1507	PLAYER	FAILED_TO_LOAD_IMAGE_ASSET	✅ Yes
1508	PLAYER	FAILED_TO_LOAD_VIDEO_ASSET	✅ Yes

User Management Errors (1600–1699)

Code	Domain	Reason	Thrown to Global Delegate
1609	USER_MANAGEMENT	FAILED_TO_SET_EXTERNAL_USER_ID	❌ No

Universal Link Errors (1700–1799)

Code	Domain	Reason	Thrown to Global Delegate
1700	UNIVERSAL_LINK	INVALID_LINK	❌ No
1701	UNIVERSAL_LINK	INVALID_DOMAIN	❌ No
1702	UNIVERSAL_LINK	FAILED_HANDLING_UNIVERSAL_LINK	❌ No

Push Notification Errors (1800–1899)

Code	Domain	Reason	Thrown to Global Delegate
1800	PUSH	INVALID_NOTIFICATION_EXTRAS_SCHEME	❌ No
1801	PUSH	INVALID_NOTIFICATION_BODY_SCHEME	❌ No

Container Errors (1900–1999)

Code	Domain	Reason	Thrown to Global Delegate
1900	CONTAINER	FAILED_PLAYING_CONTENT_CONTAINER	❌ No
1901	CONTAINER	INVALID_DATA_SOURCE_TYPE_PROVIDED	❌ No
1902	CONTAINER	LIFECYCLE_OWNER_NOT_PROVIDED	❌ No
1903	CONTAINER	VIEW_MODEL_STORE_OWNER_NOT_PROVIDED	❌ No
1904	CONTAINER	CONTENT_PREPARATION_FAILED	❌ No
1905	CONTAINER	ILLEGAL_PREPARE_ON_DATA_SOURCE_TYPE	❌ No
1906	CONTAINER	FAILED_ADDING_PLACEHOLDER_CONTAINER	❌ No

Sharing Errors (2100–2199)

Code	Domain	Reason	Thrown to Global Delegate
2100	SHARING	FAILED_LAUNCHING_SHARE_INTENT	✅ Yes
2101	SHARING	FAILED_CREATING_LINK	✅ Yes

Container Tabs Errors (2200-2299)

Code	Domain	Reason	Thrown to Global Delegate
2200	CONTAINER_TABS	DUPLICATE_CONTAINER_ID	✅ Yes

Updated 11 days ago

Did this page help you?