ClientVersion Event

Provides the QuickBooks Web Connector version information.

Syntax

• C#
• VB.NET

public event OnClientVersionHandler OnClientVersion;

public delegate void OnClientVersionHandler(object sender, QbwcserverClientVersionEventArgs e);

public class QbwcserverClientVersionEventArgs : EventArgs {
  public string ClientVersion { get; }
  public string RequiredVersion { get; set; }
  public string ErrorMessage { get; set; }
  public string WarningMessage { get; set; }
}

Public Event OnClientVersion As OnClientVersionHandler

Public Delegate Sub OnClientVersionHandler(sender As Object, e As QbwcserverClientVersionEventArgs)

Public Class QbwcserverClientVersionEventArgs Inherits EventArgs
  Public ReadOnly Property ClientVersion As String
  Public Property RequiredVersion As String
  Public Property ErrorMessage As String
  Public Property WarningMessage As String
End Class

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.