on_client_version Event
Provides the QuickBooks Web Connector version information.
Syntax
class QBWCServerClientVersionEventParams(object): @property def client_version() -> str: ... @property def required_version() -> str: ... @required_version.setter def required_version(value) -> None: ... @property def error_message() -> str: ... @error_message.setter def error_message(value) -> None: ... @property def warning_message() -> str: ... @warning_message.setter def warning_message(value) -> None: ... # In class QBWCServer: @property def on_client_version() -> Callable[[QBWCServerClientVersionEventParams], None]: ... @on_client_version.setter def on_client_version(event_hook: Callable[[QBWCServerClientVersionEventParams], None]) -> None: ...
Remarks
This event fires with the version information for QuickBooks Web Connector.
In most cases you do not need to do anything within this event. If no action is taken the session will proceed normally. You may optionally set parameters in this event to return an error, warning, or version requirement. The parameters are as follow:
ClientVersion holds the version of QuickBooks Web Connector that is connecting to your application. For instance "2.1.0.30".
RequiredVersion specifies the required version of QuickBooks Web Connector. You may set this to a value like "2.0". This is the minimum supported version of QuickBooks Web Connector which you will allow.
ErrorMessage may be set to return an error to QuickBooks Web Connector.
WarningMessage may be set to return a warning to QuickBooks Web Connector. The user will be prompted to continue or cancel the update.