why deepstreamHub? compare us getting started faq
use cases
products
developers
company
blog contact

AnonymousRecordUninitialized

An exception that is thrown if a AnonymousRecord.discard() or AnonymousRecord.delete() is attempted before a record has been set via AnonymousRecord.setName(_:)

DeepstreamError

DeepstreamErrors are used for expected or handleable error cases, e.g. RecordHandler.snapshot(_:) being called for a non-existant record.

DeepstreamException

Deepstream runtime exception, e.g. response timeouts. These can be centrally caught using the DeepstreamClient.setRuntimeErrorHandler(_:).

Fields

Name Description
topic The Topic the event occured on
event The exception event
message The exception message, explaning the issue in english for logging purposes

DeepstreamRecordDestroyedException

Called whenever an action on a discarded or deleted record is attempted. Retrieve a new instance of the Record using RecordHandler.getRecord(_:) to continue using it.

InvalidDeepstreamConfig

Thrown if any of the options passed to DeepstreamClient are invalid, due to type or invalid enum.

RecordMergeStategyException

Thrown when a version conflict occurs, and is only exposed to the client via RecordEventsListener.onError(_:errorType:errorMessage:)

Properties

Name Type Description
newData JsonElement The new data attempted to be set from the server
remoteVersion int The version of the record on the server
oldData JsonElement The old data currently on the client
version int The version of the record on the client
error String The error message associated with merge conflict returned by a custom RecordMergeStrategy

Initializers

RecordMergeStrategyException()

RecordMergeStrategyException()

Use when you don't need any merge conflict data

RecordMergeStrategyException(...)

RecordMergeStrategyException(_ localVersion: int, oldData: JsonElement, remoteVersion: Int, remoteData: JsonElement, error: String)
argument type description
localVersion Int The local version during the merge
oldData JsonElement The local data during the merge
remoteVersion Int The remote version during the merge
remoteData JsonElement The remote data during the merge
error String An associated error message

An exception that can contain all the merge issues