on_connection_error Event

Fires when QuickBooks Web Connector is unable to connect to QuickBooks.

Syntax

class QBWCServerConnectionErrorEventParams(object):
  @property
  def session_ticket() -> str: ...
  @property
  def error_code() -> str: ...
  @property
  def error_message() -> str: ...
  @property
  def company_file() -> str: ...
  @company_file.setter
  def company_file(value) -> None: ...

# In class QBWCServer:
@property
def on_connection_error() -> Callable[[QBWCServerConnectionErrorEventParams], None]: ...
@on_connection_error.setter
def on_connection_error(event_hook: Callable[[QBWCServerConnectionErrorEventParams], None]) -> None: ...

Remarks

This event fires when QuickBooks Web Connector is unable to connect to QuickBooks. The event parameters provide the error details, and also allow you to specify an alternate company file to retry the connection with. If an alternate company file is not specified the session is ended. The parameters are as follows:

ErrorCode is the error code (HResult) returned by QuickBooks. This value is read-only.

ErrorMessage is the error message returned by QuickBooks. This value is read-only.

CompanyFile may be set to the full path of an alternate company file. If specified, the QuickBooks Web Connector will retry the connection to QuickBooks using this company file. Leave this parameter empty to end the session.