Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApiResult<TResponse>

Type Parameters

  • TResponse

Hierarchy

  • ApiResult

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Optional error

error?: ResponseStatus

Optional response

response?: TResponse

Accessors

completed

  • get completed(): boolean

  • Returns boolean

errorCode

  • get errorCode(): string

  • Returns string

errorMessage

  • get errorMessage(): string

  • Returns string

errorSummary

  • get errorSummary(): string

  • Returns string

errors

failed

  • get failed(): boolean

  • Returns boolean

succeeded

  • get succeeded(): boolean

  • Returns boolean

Methods

addFieldError

  • addFieldError(fieldName: string, message: string, errorCode?: string): void

  • Parameters

    • fieldName: string
    • message: string
    • Optional errorCode: string

    Returns void

fieldError

fieldErrorMessage

  • fieldErrorMessage(fieldName: string): string

hasFieldError

  • hasFieldError(fieldName: string): boolean

showSummary

  • showSummary(exceptFields?: string[]): boolean

  • Parameters

    • Optional exceptFields: string[]

    Returns boolean

summaryMessage

  • summaryMessage(exceptFields?: string[]): string

  • Parameters

    • Optional exceptFields: string[]

    Returns string

Generated using TypeDoc