LoginsApiError

public enum LoginsApiError
extension LoginsApiError: Equatable, Hashable
extension LoginsApiError: Foundation.LocalizedError

These are the errors returned by our public API.

  • The login data supplied is invalid. The reason will indicate what’s wrong with it.

    Declaration

    Swift

    case InvalidRecord(reason: String
)

  • Asking to do something with a guid which doesn’t exist.

    Declaration

    Swift

    case NoSuchRecord(reason: String
)

  • The encryption key supplied of the correct format, but not the correct key.

    Declaration

    Swift

    case IncorrectKey

  • An operation was interrupted at the request of the consuming app.

    Declaration

    Swift

    case Interrupted(reason: String
)

  • Sync reported that authentication failed and the user should re-enter their FxA password.

    Declaration

    Swift

    case SyncAuthInvalid(reason: String
)

  • something internal went wrong which doesn’t have a public error value because the consuming app can not reasonably take any action to resolve it. The underlying error will have been logged and reported. (ideally would just be Unexpected, but that would be a breaking change)

    Declaration

    Swift

    case UnexpectedLoginsApiError(reason: String
)

  • Declaration

    Swift

    public var errorDescription: String? { get }