Diagnostics Class
Static API for reporting diagnostic warnings and errors for display in visual tools
The User...
messages indicate the user (programmer) has done something wrong and needs
to modify their code. These will most likely be displayed prominantly to the user. This should be seen
from the point of view of a typical UX/JS user, not somebody writing Uno code.
The Internal...
messages are for situations that can't be directly attributed to a user error. They
are an indication of a fuselibs error, or a Uno programmer error.
The Unknown...
messages are for errors coming from the native platform or in places
where the cause of the error really isn't known, but probably isn't a user or internal programming
error.
The object
of the error messages should be the object which is generating the error; the Node
which it would most likely be associated with in the UX tree. This is typically this
in instance
contexts.
Location
- Namespace
- Fuse
- Package
- Fuse.Common 2.9.1
Interface of Diagnostics
DiagnosticDismissed : DiagnosticHandler (Diagnostic) ux
DiagnosticReported : DiagnosticHandler (Diagnostic) ux
InternalError(string, object, string, int, string) uno
An error that is most likely not a direct result of the user (programmer) doing something incorrectly but is an internal fuselibs error.
PerformanceWarning(string, string, int, string) uno
Report(Diagnostic) uno
ReportTemporal(Diagnostic) : IDisposable uno
ReportTemporalUserWarning(string, object) : IDisposable uno
ReportTemporalWarning(Diagnostic) : IDisposable uno
Reports a temporary diagnostic condition that should not be printed to debug_log.
The condition is valid until .Dispose()
is called on the returned object.
UnknownException(string, Exception, object, string, int, string) uno
Used when an expected exception is caught and otherwise ignored (processing continues). Internal implies the immediate cause is not known and it cannot be attributed to a user error.
Unsupported(string, object, string, int, string) uno
UserError(string, object, string, int, string, Exception) uno
An error that has most likely been caused by a high-level programming mistake, such as a property mismatch, unsupported enum, or other UX setup error.
UserRootError(string, object, object, string, int, string) uno
A node was rooted in a place where it should not have been. This is a common enough scenario to warrant custom handling for consistency.
UserSuccess(string, object, string, int, string) uno
In some situations it's possible to detect that the user has resolved an error. This function can report such things.