Class OINODbApiResult

messages

statusCode

statusMessage

success

addDebug

• addDebug(message: string, operation: string): OINOResult

  Add debug message. Returns self reference for chaining.

  Parameters

  • message: string

    HTTP status message
  • operation: string

    operation where debug occured

  Returns OINOResult

addInfo

• addInfo(message: string, operation: string): OINOResult

  Add info message. Returns self reference for chaining.

  Parameters

  • message: string

    HTTP status message
  • operation: string

    operation where info occured

  Returns OINOResult

addWarning

• addWarning(message: string, operation: string): OINOResult

  Add warning message. Returns self reference for chaining.

  Parameters

  • message: string

    HTTP status message
  • operation: string

    operation where warning occured

  Returns OINOResult

copy

• copy(result: OINOResult): void

  Copy values from different result.

  Parameters

  • result: OINOResult

    source value

  Returns void

copyMessagesToHeaders

• copyMessagesToHeaders(
      headers: Headers,
      copyErrors?: boolean,
      copyWarnings?: boolean,
      copyInfos?: boolean,
      copyDebug?: boolean,
  ): void

  Copy given messages to HTTP headers.

  Parameters

  • headers: Headers

    HTTP headers
  • OptionalcopyErrors: boolean

    wether error messages should be copied (default true)
  • OptionalcopyWarnings: boolean

    wether warning messages should be copied (default false)
  • OptionalcopyInfos: boolean

    wether info messages should be copied (default false)
  • OptionalcopyDebug: boolean

    wether debug messages should be copied (default false)

  Returns void

getStatusResponse

• getStatusResponse(headers?: Record<string, string>): Response

  Get a Response object from the result values.

  Parameters

  • Optionalheaders: Record<string, string>

    HTTP headers (overrides existing values)

  Returns Response

printLog

• printLog(): string

  Print result for logging.

  Returns string

setError

• setError(
      statusCode: number,
      statusMessage: string,
      operation: string,
  ): OINOResult

  Set HTTP error status using given code and message. Returns self reference for chaining.

  Parameters

  • statusCode: number

    HTTP status code
  • statusMessage: string

    HTTP status message
  • operation: string

    operation where error occured

  Returns OINOResult

setOk

• setOk(): void

  Set HTTP OK status (does not reset messages).

  Returns void