Modules

ChannelErrorEvent

The ERROR event sent to channel event subscribers when an operation fails: subscribeToBannersEvents, subscribeToContentCardsEvents and subscribeToFeatureFlagsEvents all send it with the same fields.

Hierarchy

  • ChannelErrorEvent

Index

Properties

Properties

Optional rateLimitedUntil

rateLimitedUntil: Date

Only present when reason is RATE_LIMITED: the earliest time another attempt may succeed.

reason

reason: { CLIENT_ERROR: "CLIENT_ERROR"; FEATURE_DISABLED: "FEATURE_DISABLED"; INVALID_SERVER_DATA: "INVALID_SERVER_DATA"; RATE_LIMITED: "RATE_LIMITED"; SDK_DISABLED: "SDK_DISABLED"; SERVER_ERROR: "SERVER_ERROR" }[keyof typeof ChannelErrorReason]

Why the operation failed. One of the ChannelErrorReason values.

retryState

retryState: { DO_NOT_RETRY: "DO_NOT_RETRY"; INTEGRATOR_MAY_RETRY: "INTEGRATOR_MAY_RETRY"; SDK_WILL_RETRY: "SDK_WILL_RETRY" }[keyof typeof RetryState]

Whether the SDK will retry, and what you should do. One of the RetryState values.

type

type: typeof ERROR