SCSChatErrorCode

enum 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.

See

-[SCSChatSessionDelegate session:didError:fatal:]

See

-[SCSChatSessionDelegate session:didEndWithReason:]

General Errors (1000-series)

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

    Any other un-grouped errors will be added to the 1000 series error group.

    Declaration

    Objective-C

    SCSChatGenericError = 1000

    Swift

    case genericError = 1000

  • The object provided to the is invalid.

    Declaration

    Objective-C

    SCSChatInvalidConfiguration = 1001

    Swift

    case invalidConfiguration = 1001

  • Another session is already in progress

    Declaration

    Objective-C

    SCSChatExistingSessionError = 1002

    Swift

    case existingSessionError = 1002

Connection Errors (2000-series)

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

    All communication related errors will be found in the 2000 series error group.

    Declaration

    Objective-C

    SCSChatCommunicationError = 2000

    Swift

    case communicationError = 2000

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

    Declaration

    Objective-C

    SCSChatNoAgentsAvailableError = 2001

    Swift

    case noAgentsAvailableError = 2001

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

    Declaration

    Objective-C

    SCSChatSessionCreationError = 2002

    Swift

    case sessionCreationError = 2002

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

    Declaration

    Objective-C

    SCSChatSessionEventError = 2003

    Swift

    case sessionEventError = 2003

File Transfer Errors (3000-series)

  • Returned when an attempted file transfer fails.

    Declaration

    Objective-C

    SCSChatFileTransferError = 3000

    Swift

    case fileTransferError = 3000