Storyteller SDK Documentation/com.storyteller.domain.entities/StorytellerError

StorytellerError

sealed class StorytellerError : Exception

Represents a base class for all errors that can occur within the Storyteller SDK. Each specific error type provides more context about the issue encountered.

Parameters

msg

A descriptive message for the error.

cause

The underlying Exception that caused this error, if any.

Inheritors

VideoInitializationError

NetworkError

SettingsError

LocalSettingsNotFoundError

GenericError

OperationNotOnMainThreadError

CollectionDoesNotHaveClipWithIdError

ListDoesNotHaveStoryWithIdError

SheetIdError

Types

CollectionDoesNotHaveClipWithIdError

data class CollectionDoesNotHaveClipWithIdError(val cause: Exception? = null) : StorytellerError

Indicates that a specified Clip ID was not found within a given collection.

ContentNotFoundError

object ContentNotFoundError : StorytellerError

Indicates that content (e.g., Stories, Clips) could not be loaded for the current user. This may also suggest an issue with the API key configuration or content availability.

GenericError

data class GenericError(val cause: Exception? = null) : StorytellerError

Represents an unclassified or generic error that occurred within the Storyteller SDK.

InitializationError

data class InitializationError(val cause: Exception? = null) : StorytellerError

Indicates an error during the general initialization process of the Storyteller SDK.

InvalidAPIKeyError

data class InvalidAPIKeyError(val cause: Exception? = null) : StorytellerError

Indicates that the API key provided during initialization is invalid or incorrect.

InvalidDeepLinkError

data class InvalidDeepLinkError(val link: String?) : StorytellerError

Indicates that a provided deep link string is invalid or could not be processed.

InvalidUserError

object InvalidUserError : StorytellerError

Indicates that the user ID provided or derived is not valid. This may also suggest an issue with the API key configuration.

JSONParseError

data class JSONParseError(val cause: Exception? = null) : StorytellerError

Indicates a problem parsing JSON data, typically when processing settings or API responses.

ListDoesNotHaveStoryWithIdError

data class ListDoesNotHaveStoryWithIdError(val cause: Exception? = null) : StorytellerError

Indicates that a specified Story ID was not found within a given list or category context.

LocalSettingsNotFoundError

data class LocalSettingsNotFoundError(val cause: Exception? = null) : StorytellerError

Indicates that SDK settings could not be loaded because no local (cached) settings were found, and fetching from the network might have also failed or was not attempted.

NetworkError

data class NetworkError(val cause: Exception? = null) : StorytellerError

A general network error occurred while trying to fetch data.

NetworkTimeoutError

data class NetworkTimeoutError(val cause: Exception? = null) : StorytellerError

Indicates a network timeout occurred, often during initialization or data fetching. This can happen if the device has no network access or the connection is too slow.

OperationNotOnMainThreadError

data class OperationNotOnMainThreadError(val cause: Exception? = null) : StorytellerError

Indicates that an operation requiring the main thread was attempted on a background thread.

SettingsError

data class SettingsError(val cause: Exception? = null) : StorytellerError

Indicates an error while trying to load SDK settings, either from the network or local cache.

SheetIdError

data class SheetIdError(val cause: Exception? = null) : StorytellerError

Indicates that the provided ID for a Storyteller Sheet is invalid (e.g., blank).

VideoInitializationError

data class VideoInitializationError(val cause: Exception) : StorytellerError

Indicates an error during the initialization of the video player (ExoPlayer). This can occur if there are too many media codecs in use by other applications.