MarkupProvided
Event used to provide markup text for document-style reports.
To create instances of this class you may use the factory method. For example, given a report function named report, you could fire a MarkupProvided event like this:
report(MarkupProvided(ordinal, text, Some(NameInfo(suiteName, suiteId, Some(thisSuite.getClass.getName), Some(testName)))))
A MarkupProvided event may be fired from anywhere. In this respect MarkupProvided is different from the other events, for which it is defined whether they are fired in the context of a suite or test. If fired in the context of a test, the MarkupProvided event should include a NameInfo in which testName is defined. If fired in the context of a suite, but not a test, the MarkupProvided event should include a NameInfo in which testName is not defined. If fired within the context of neither a suite nor a test, the nameInfo of the MarkupProvided event (an Option[NameInfo]) should be None.
Value parameters
- formatter
-
an optional
Formatterthat provides extra information that can be used by reporters in determining how to present this event to the user - location
-
An optional
Locationthat provides information indicating where in the source code an event originated. - nameInfo
-
an optional
NameInfothat if defined, provides names for the suite and optionally the test in the context of which the information was provided - ordinal
-
an
Ordinalthat can be used to place this event in order in the context of other events reported during the same run - payload
-
an optional object that can be used to pass custom information to the reporter about the
MarkupProvidedevent - text
-
a snippet of markup text (in Markdown format)
- threadName
-
a name for the
Threadabout whose activity this event was reported - timeStamp
-
a
Longindicating the time this event was reported, expressed in terms of the number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT
Attributes
- Graph
-
- Supertypes
-
trait RecordableEventclass Eventtrait Serializabletrait Producttrait Equalstrait Ordered[Event]trait Comparable[Event]class Objecttrait Matchableclass Any