Skip to main content
Version: v1

DriverErrorType Enum

Driver Error types Lists types that are likely to be used by all drivers

Signature

export declare enum DriverErrorType

Flags

Flag Description
authorizationError Access denied - user does not have enough privileges to open a file, or continue to operate on a file
deltaStreamConnectionForbidden The document is read-only and delta stream connection is forbidden.
fetchFailure A generic fetch failure that indicates we were not able to get a response from the server. This may be due to the client being offline (though, if we are able to detect offline state it will be logged as an offlineError instead). Other possibilities could be DNS errors, malformed fetch request, CSP violation, etc.
fileNotFoundOrAccessDeniedError File not found, or file deleted during session
fileOverwrittenInStorage This error occurs when the file is modified externally (not through Fluid protocol) in storage. It will occur in cases where client has some state or cache that is based on old content (identity) of a file, and storage / driver / loader detects such mismatch. When it's hit, client needs to forget all the knowlege about this file and start over.
genericError A fatal error with no specific interpretation covered by other DriverErrorType values
genericNetworkError Some non-categorized (below) networking error Include errors like fatal server error (usually 500).
incorrectServerResponse Unexpected response from server. Either JSON is malformed, or some required properties are missing
locationRedirection The location of file/container can change on server. So if the file location moves and we try to access the old location, then this error is thrown to let the client know about the new location info.
offlineError We can not reach server due to computer being offline.
throttlingError Throttling error from server. Server is busy and is asking not to reconnect for some time
unsupportedClientProtocolVersion
writeError User does not have write permissions to a file, but is changing content of a file. That might be indication of some data store error - data stores should not generate ops in readonly mode.

authorizationError

Access denied - user does not have enough privileges to open a file, or continue to operate on a file

Signature

authorizationError = "authorizationError"

deltaStreamConnectionForbidden

The document is read-only and delta stream connection is forbidden.

Signature

deltaStreamConnectionForbidden = "deltaStreamConnectionForbidden"

fetchFailure

A generic fetch failure that indicates we were not able to get a response from the server. This may be due to the client being offline (though, if we are able to detect offline state it will be logged as an offlineError instead). Other possibilities could be DNS errors, malformed fetch request, CSP violation, etc.

Signature

fetchFailure = "fetchFailure"

fileNotFoundOrAccessDeniedError

File not found, or file deleted during session

Signature

fileNotFoundOrAccessDeniedError = "fileNotFoundOrAccessDeniedError"

fileOverwrittenInStorage

This error occurs when the file is modified externally (not through Fluid protocol) in storage. It will occur in cases where client has some state or cache that is based on old content (identity) of a file, and storage / driver / loader detects such mismatch. When it's hit, client needs to forget all the knowlege about this file and start over.

Signature

fileOverwrittenInStorage = "fileOverwrittenInStorage"

genericError

A fatal error with no specific interpretation covered by other DriverErrorType values

Signature

genericError = "genericError"

genericNetworkError

Some non-categorized (below) networking error Include errors like fatal server error (usually 500).

Signature

genericNetworkError = "genericNetworkError"

incorrectServerResponse

Unexpected response from server. Either JSON is malformed, or some required properties are missing

Signature

incorrectServerResponse = "incorrectServerResponse"

locationRedirection

The location of file/container can change on server. So if the file location moves and we try to access the old location, then this error is thrown to let the client know about the new location info.

Signature

locationRedirection = "locationRedirection"

offlineError

We can not reach server due to computer being offline.

Signature

offlineError = "offlineError"

throttlingError

Throttling error from server. Server is busy and is asking not to reconnect for some time

Signature

throttlingError = "throttlingError"

unsupportedClientProtocolVersion

Signature

unsupportedClientProtocolVersion = "unsupportedClientProtocolVersion"

writeError

User does not have write permissions to a file, but is changing content of a file. That might be indication of some data store error - data stores should not generate ops in readonly mode.

Signature

writeError = "writeError"