Class: StreamErrorStay organized with collectionsSave and categorize content based on your preferences.
Page Summary
StreamError is a class used to specify stream error data.
The ErrorCode enumeration lists different types of errors reported by the SDK, such as unknown errors, invalid requests, initialization failures, timeouts, and authorization failures.
The StreamError class has properties forcode(of type ErrorCode) andmessage(a string) to describe the error.
StreamError
class
public
A class for specifying stream error data.
Enumeration
ErrorCode
constant
static
number
List of error types reported by the SDK.
Value
UNKNOWN_ERROR
An unexpected error occurred and the cause is not known.
INVALID_STREAM_REQUEST
The provided stream request was invalid.
STREAM_INITIALIZATION_FAILED
The requested stream failed to initialize
STREAM_INITIALIZATION_TIMEOUT
The stream request timed out.
STREAM_AUTHORIZATION_FAILED
The authorization for the stream request failed.
Properties
code
constant
public
non-null ErrorCode
message
constant
public
string
ErrorCode
constant
static
number
List of error types reported by the SDK.
Value
UNKNOWN_ERROR
An unexpected error occurred and the cause is not known.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[],["The `StreamError` class handles stream error data, utilizing an `ErrorCode` enumeration. `ErrorCode` lists specific error types: `UNKNOWN_ERROR`, `INVALID_STREAM_REQUEST`, `STREAM_INITIALIZATION_FAILED`, `STREAM_INITIALIZATION_TIMEOUT`, and `STREAM_AUTHORIZATION_FAILED`. Each error type is associated with a specific cause, ranging from unknown issues to invalid requests, initialization problems, timeouts, and authorization failures. The `StreamError` class includes `code` and `message` properties.\n"]]