QuickBooks Integrator 2020 .NET Edition

Questions / Feedback?

Authenticate Event

Fired when the QuickBooks Web Connector authenticates.

Syntax

public event OnAuthenticateHandler OnAuthenticate;

public delegate void OnAuthenticateHandler(object sender, QbwcserverAuthenticateEventArgs e);

public class QbwcserverAuthenticateEventArgs : EventArgs {
  public string User { get; }
  public string Password { get; }
  public bool Accept { get; set; }
  public bool Busy { get; set; }
  public bool NoWork { get; set; }
  public string SessionTicket { get; set; }
  public string CompanyFile { get; set; }
  public int UpdateDelay { get; set; }
  public int UpdateInterval { get; set; }
}
Public Event OnAuthenticate As OnAuthenticateHandler

Public Delegate Sub OnAuthenticateHandler(sender As Object, e As QbwcserverAuthenticateEventArgs)

Public Class QbwcserverAuthenticateEventArgs Inherits EventArgs
  Public ReadOnly Property User As String
  Public ReadOnly Property Password As String
  Public Property Accept As Boolean
  Public Property Busy As Boolean
  Public Property NoWork As Boolean
  Public Property SessionTicket As String
  Public Property CompanyFile As String
  Public Property UpdateDelay As Integer
  Public Property UpdateInterval As Integer
End Class

Remarks

This event fires when the QuickBooks Web Connector attempts authentication.

You may use this event to accept the connection, reject the connection, postpone the update, or skip the update. The parameters are as follows:

User is the username that is presented by QuickBooks Web Connector.

Password is the password that is presented for the user.

Accept determines whether the connection request is accepted. The values of User and Password should be verified within this event to determine if the user credentials are valid. The default value is True.

Busy may be set to True to inform QuickBooks Web Connector that the application is busy and to try again later. The default is False. When set to True it is not necessary to set Accept to False.

NoWork may be set to True to inform QuickBoooks Web Connector that there is no work to process and to stop the update. When set to True it is not necessary to set Accept to False.

SessionTicket is a string value which identifies the session and will be available within other events. The component populates this with a GUID but you may choose to set your own value.

CompanyFile should be set to the full path to the company file on the system running QuickBooks which you want to work with. Leave this set to empty string to indicate that the currently opened company file should be used.

UpdateDelay allows you to postpone the update for the specified number of seconds. When set to True it is not necessary to set Accept to False.

UpdateInterval may be set to specify the interval in seconds at which the QuickBooks Web Connector will begin an update. If the user has enabled the "Auto-Run" option on QuickBooks Web Connector this will update the "Every_Min" field. Note that the user may choose to change the value. If the user has not enabled "Auto-Run" this is not applicable, but will not cause an error.

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 .NET Edition - Version 20.0 [Build 7941]