final case class ErrorCodeDocItem(errorCodeClassName: String, category: String, hierarchicalGrouping: ErrorClass, conveyance: Option[String], code: String, deprecation: Option[DeprecatedItem], explanation: Option[Explanation], resolution: Option[Resolution]) extends Product with Serializable
Contains error presentation data to be used for documentation rendering on the website.
- errorCodeClassName
The error class name (see com.daml.error.ErrorCode).
- category
The error code category (see com.daml.error.ErrorCategory).
- hierarchicalGrouping
The hierarchical code grouping (see com.daml.error.ErrorClass and com.daml.error.ErrorGroup).
- conveyance
Provides a statement about the form this error will be returned to the user.
- code
The error identifier.
- explanation
The detailed error explanation.
- resolution
The suggested error resolution.
- Alphabetic
- By Inheritance
- ErrorCodeDocItem
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ErrorCodeDocItem(errorCodeClassName: String, category: String, hierarchicalGrouping: ErrorClass, conveyance: Option[String], code: String, deprecation: Option[DeprecatedItem], explanation: Option[Explanation], resolution: Option[Resolution])
- errorCodeClassName
The error class name (see com.daml.error.ErrorCode).
- category
The error code category (see com.daml.error.ErrorCategory).
- hierarchicalGrouping
The hierarchical code grouping (see com.daml.error.ErrorClass and com.daml.error.ErrorGroup).
- conveyance
Provides a statement about the form this error will be returned to the user.
- code
The error identifier.
- explanation
The detailed error explanation.
- resolution
The suggested error resolution.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val category: String
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val code: String
- val conveyance: Option[String]
- val deprecation: Option[DeprecatedItem]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val errorCodeClassName: String
- val explanation: Option[Explanation]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val hierarchicalGrouping: ErrorClass
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val resolution: Option[Resolution]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])