Blog Studio Go to console

FirebaseFirestore Framework Reference

_ErrorType

typealias FirestoreErrorCode.Code._ErrorType = FirestoreErrorCode

Error codes used by Cloud Firestore.

  • OK

    The operation completed successfully. NSError objects will never have a code with this value.

    Declaration

    Swift

    static var OK: FirestoreErrorCode.Code { get }

  • The operation was cancelled (typically by the caller).

    Declaration

    Swift

    static var cancelled: FirestoreErrorCode.Code { get }

  • Unknown error or an error from a different error domain.

    Declaration

    Swift

    static var unknown: FirestoreErrorCode.Code { get }

  • Client specified an invalid argument. Note that this differs from FailedPrecondition. InvalidArgument indicates arguments that are problematic regardless of the state of the system (e.g., an invalid field name).

    Declaration

    Swift

    static var invalidArgument: FirestoreErrorCode.Code { get }

  • Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire.

    Declaration

    Swift

    static var deadlineExceeded: FirestoreErrorCode.Code { get }

  • Some requested document was not found.

    Declaration

    Swift

    static var notFound: FirestoreErrorCode.Code { get }

  • Some document that we attempted to create already exists.

    Declaration

    Swift

    static var alreadyExists: FirestoreErrorCode.Code { get }

  • The caller does not have permission to execute the specified operation.

    Declaration

    Swift

    static var permissionDenied: FirestoreErrorCode.Code { get }

  • Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.

    Declaration

    Swift

    static var resourceExhausted: FirestoreErrorCode.Code { get }

  • Operation was rejected because the system is not in a state required for the operation’s execution.

    Declaration

    Swift

    static var failedPrecondition: FirestoreErrorCode.Code { get }

  • The operation was aborted, typically due to a concurrency issue like transaction aborts, etc.

    Declaration

    Swift

    static var aborted: FirestoreErrorCode.Code { get }

  • Operation was attempted past the valid range.

    Declaration

    Swift

    static var outOfRange: FirestoreErrorCode.Code { get }

  • Operation is not implemented or not supported/enabled.

    Declaration

    Swift

    static var unimplemented: FirestoreErrorCode.Code { get }

  • Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken.

    Declaration

    Swift

    static var `internal`: FirestoreErrorCode.Code { get }

  • The service is currently unavailable. This is a most likely a transient condition and may be corrected by retrying with a backoff.

    Declaration

    Swift

    static var unavailable: FirestoreErrorCode.Code { get }

  • Unrecoverable data loss or corruption.

    Declaration

    Swift

    static var dataLoss: FirestoreErrorCode.Code { get }

  • The request does not have valid authentication credentials for the operation.

    Declaration

    Swift

    static var unauthenticated: FirestoreErrorCode.Code { get }