SCSChatErrorCode Constants Reference

SCSChatErrorCode

Live Agent Chat ErrorCode definitions.

Errors fall into one of several groups (or series) of errors.

If there is an error thrown by a library dependency it will be included as metadata in the userInfo of the error which is returned to the application code.

Definition

typedef NS_ENUM(NSInteger, SCSChatErrorCode ) {
   SCSChatGenericError = 1000,
   SCSChatInvalidConfiguration = 1001,
   SCSChatExistingSessionError = 1002,
   SCSChatCommunicationError = 2000,
   SCSChatNoAgentsAvailableError = 2001,
   SCSChatSessionCreationError = 2002,
   SCSChatSessionEventError = 2003,
};

Constants

SCSChatGenericError

Unclassified error. This results from an unknown or unexpected error state.

Declared In SCSChatErrorCode.h.

SCSChatInvalidConfiguration

The SCSChatConfiguration object provided to the SCSChat is invalid.

Declared In SCSChatErrorCode.h.

SCSChatExistingSessionError

Another session is already in progress

Declared In SCSChatErrorCode.h.

SCSChatCommunicationError

Standard communication error. This can be returned from operations dependent on communication between Live Agent or any other remote system.

Declared In SCSChatErrorCode.h.

SCSChatNoAgentsAvailableError

Returned when attempting to start a session when no agents are available to accept the request.

Declared In SCSChatErrorCode.h.

SCSChatSessionCreationError

Returned when attempting to start a session and a network error occurs.

Declared In SCSChatErrorCode.h.

SCSChatSessionEventError

Returned when attempting to perform an action in an established session and a network error occurs.

Declared In SCSChatErrorCode.h.

See Also

  • [SCSChatDelegate chat:didError:]

  • [SCSChatDelegate chat:didEndWithReason:error:]

Declared In

SCSChatErrorCode.h