wow-api/me.ahoo.wow.api.exception/ErrorInfo/Companion

Companion

object Companion

Companion object providing constants and utility functions for working with ErrorInfo instances.

This companion object offers:

  • Standard success constants and instances

  • Factory methods for creating error instances

  • Utility functions for error checking and conversion

  • Materialization helpers for serialization

Properties

Link copied to clipboard
val OK: DefaultErrorInfo

A pre-defined instance representing a successful operation.

Link copied to clipboard
const val SUCCEEDED: String

The standard error code indicating a successful operation.

Link copied to clipboard
const val SUCCEEDED_MESSAGE: String

The standard message for successful operations.

Functions

Link copied to clipboard
fun Any?.isFailed(): Boolean

Checks if this object represents a failed operation.

Link copied to clipboard
fun ErrorInfo.materialize(): ErrorInfo

Converts this ErrorInfo to a materialized instance for serialization.

Link copied to clipboard
fun of(errorCode: String, errorMsg: String? = null, bindingErrors: List<BindingError> = emptyList()): DefaultErrorInfo

Creates a new ErrorInfo instance with the specified parameters.

Link copied to clipboard
fun ErrorInfo.toDefault(): DefaultErrorInfo

Converts this ErrorInfo to a DefaultErrorInfo instance.

Generated by Dokka
© 2025 Copyright