Inherits from NSObject
Conforms to PicoBindable
Declared in Trading_ErrorType.h
Trading_ErrorType.m

Overview

These are request errors (as opposed to system errors) that occur due to problems
with business-level data (e.g., an invalid combination of arguments) that
the application passed in.

@ingroup EBayAPIInterface

Tasks

  •   shortMessage

    A brief description of the condition that raised the error.

         property
  •   longMessage

    A more detailed description of the condition that raised the error.

         property
  •   errorCode

    A unique code that identifies the particular error condition that occurred.
    Your application can use error codes as identifiers
    in your customized error-handling algorithms. See the “Errors by Number” document.

         property
  •   userDisplayHint

    Indicates whether the error message text is intended to be displayed to an end user
    or intended only to be parsed by the application. If true or not present (the default),
    the message text is intended for the end user. If false, the message text is intended for
    the application, and the application should translate the error into a more appropriate message.
    Only applicable to Item Specifics errors and warnings returned from listing requests.

         property
  •   severityCode

    Indicates whether the error is a severe error (causing the request to fail)
    or an informational error (a warning) that should be communicated to the user.

         property
  •   errorParameters

    This optional element carries a list of context-specific
    error variables that indicate details about the error condition.
    These are useful when multiple instances of ErrorType are returned.

         property
  •   errorClassification

    API errors are divided between two classes: system errors and request errors.

         property
  •   any

    (public property)

         property

Properties

any

(public property)

@property (nonatomic, retain) NSMutableArray *any

Discussion

(public property)

entry type : PicoAnyElement, wrapper for primitive anyelement

Declared In

Trading_ErrorType.h

errorClassification

API errors are divided between two classes: system errors and request errors.

@property (nonatomic, retain) NSString *errorClassification

Discussion

API errors are divided between two classes: system errors and request errors.

type: string constant in Trading_ErrorClassificationCodeType.h

Declared In

Trading_ErrorType.h

errorCode

A unique code that identifies the particular error condition that occurred.
Your application can use error codes as identifiers
in your customized error-handling algorithms. See the “Errors by Number” document.

@property (nonatomic, retain) NSString *errorCode

Discussion

A unique code that identifies the particular error condition that occurred.
Your application can use error codes as identifiers
in your customized error-handling algorithms. See the “Errors by Number” document.

type : NSString, wrapper for primitive string

Declared In

Trading_ErrorType.h

errorParameters

This optional element carries a list of context-specific
error variables that indicate details about the error condition.
These are useful when multiple instances of ErrorType are returned.

@property (nonatomic, retain) NSMutableArray *errorParameters

Discussion

This optional element carries a list of context-specific
error variables that indicate details about the error condition.
These are useful when multiple instances of ErrorType are returned.

entry type : class Trading_ErrorParameterType

Declared In

Trading_ErrorType.h

longMessage

A more detailed description of the condition that raised the error.

@property (nonatomic, retain) NSString *longMessage

Discussion

A more detailed description of the condition that raised the error.

type : NSString, wrapper for primitive string

Declared In

Trading_ErrorType.h

severityCode

Indicates whether the error is a severe error (causing the request to fail)
or an informational error (a warning) that should be communicated to the user.

@property (nonatomic, retain) NSString *severityCode

Discussion

Indicates whether the error is a severe error (causing the request to fail)
or an informational error (a warning) that should be communicated to the user.

type: string constant in Trading_SeverityCodeType.h

Declared In

Trading_ErrorType.h

shortMessage

A brief description of the condition that raised the error.

@property (nonatomic, retain) NSString *shortMessage

Discussion

A brief description of the condition that raised the error.

type : NSString, wrapper for primitive string

Declared In

Trading_ErrorType.h

userDisplayHint

Indicates whether the error message text is intended to be displayed to an end user
or intended only to be parsed by the application. If true or not present (the default),
the message text is intended for the end user. If false, the message text is intended for
the application, and the application should translate the error into a more appropriate message.
Only applicable to Item Specifics errors and warnings returned from listing requests.

@property (nonatomic, retain) NSNumber *userDisplayHint

Discussion

Indicates whether the error message text is intended to be displayed to an end user
or intended only to be parsed by the application. If true or not present (the default),
the message text is intended for the end user. If false, the message text is intended for
the application, and the application should translate the error into a more appropriate message.
Only applicable to Item Specifics errors and warnings returned from listing requests.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_ErrorType.h