SyncErrorCode enum

Error code enumeration, indicating the type of SyncError.

Inheritance

Constructors

SyncErrorCode(int code)
const

Values

runtimeError → const SyncErrorCode

Unrecognized error code. It usually indicates incompatibility between the App Services server and client SDK versions.

const SyncErrorCode(realm_errno.RLM_ERR_RUNTIME)
badPartitionValue → const SyncErrorCode

The partition value specified by the user is not valid - i.e. its the wrong type or is encoded incorrectly.

const SyncErrorCode(realm_errno.RLM_ERR_BAD_SYNC_PARTITION_VALUE)
protocolInvariantFailed → const SyncErrorCode

A fundamental invariant in the communication between the client and the server was not upheld. This typically indicates a bug in the synchronization layer and should be reported at https://github.com/realm/realm-core/issues.

const SyncErrorCode(realm_errno.RLM_ERR_SYNC_PROTOCOL_INVARIANT_FAILED)
badChangeset → const SyncErrorCode

The changeset is invalid.

const SyncErrorCode(realm_errno.RLM_ERR_BAD_CHANGESET)
invalidSubscriptionQuery → const SyncErrorCode

The client attempted to create a subscription for a query is invalid/malformed.

const SyncErrorCode(realm_errno.RLM_ERR_INVALID_SUBSCRIPTION_QUERY)
clientReset → const SyncErrorCode

A client reset has occurred. This error code will only be reported via a ClientResetError and only in the case manual client reset handling is required - either via ManualRecoveryHandler or when onManualReset is invoked on one of the automatic client reset handlers.

const SyncErrorCode(realm_errno.RLM_ERR_SYNC_CLIENT_RESET_REQUIRED)
invalidSchemaChange → const SyncErrorCode

The client attempted to upload an invalid schema change - either an additive schema change when developer mode is or a destructive schema change.

const SyncErrorCode(realm_errno.RLM_ERR_SYNC_INVALID_SCHEMA_CHANGE)
permissionDenied → const SyncErrorCode

Permission to Realm has been denied.

const SyncErrorCode(realm_errno.RLM_ERR_SYNC_PERMISSION_DENIED)
serverPermissionsChanged → const SyncErrorCode

The server permissions for this file have changed since the last time it was used.

const SyncErrorCode(realm_errno.RLM_ERR_SYNC_SERVER_PERMISSIONS_CHANGED)
userMismatch → const SyncErrorCode

The user for this session doesn't match the user who originally created the file. This can happen if you explicitly specify the Realm file path in the configuration and you open the Realm first with user A, then with user B without changing the on-disk path.

const SyncErrorCode(realm_errno.RLM_ERR_SYNC_USER_MISMATCH)
writeNotAllowed → const SyncErrorCode

Client attempted a write that is disallowed by permissions, or modifies an object outside the current query - this will result in a CompensatingWriteError.

const SyncErrorCode(realm_errno.RLM_ERR_SYNC_WRITE_NOT_ALLOWED)
autoClientResetFailed → const SyncErrorCode

Automatic client reset has failed. This will only be reported via ClientResetError when an automatic client reset handler was used but it failed to perform the client reset operation - typically due to a breaking schema change in the server schema or due to an exception occurring in the before or after client reset callbacks.

const SyncErrorCode(realm_errno.RLM_ERR_AUTO_CLIENT_RESET_FAILED)
wrongSyncType → const SyncErrorCode

The wrong sync type was used to connect to the server. This means that you're trying to connect to an app configured to use partition sync.

const SyncErrorCode(realm_errno.RLM_ERR_WRONG_SYNC_TYPE)
compensatingWrite → const SyncErrorCode

Client attempted a write that is disallowed by permissions, or modifies an object outside the current query, and the server undid the modification.

const SyncErrorCode(realm_errno.RLM_ERR_SYNC_COMPENSATING_WRITE)

Properties

code int
final
hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

fromInt(int code) SyncErrorCode

Constants

values → const List<SyncErrorCode>
A constant List of the values in this enum, in order of their declaration.