on_authenticate Event

Fired when the QuickBooks Web Connector authenticates.

Syntax

class QBWCServerAuthenticateEventParams(object):
  @property
  def user() -> str: ...
  @property
  def password() -> str: ...
  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...
  @property
  def busy() -> bool: ...
  @busy.setter
  def busy(value) -> None: ...
  @property
  def no_work() -> bool: ...
  @no_work.setter
  def no_work(value) -> None: ...
  @property
  def session_ticket() -> str: ...
  @session_ticket.setter
  def session_ticket(value) -> None: ...
  @property
  def company_file() -> str: ...
  @company_file.setter
  def company_file(value) -> None: ...
  @property
  def update_delay() -> int: ...
  @update_delay.setter
  def update_delay(value) -> None: ...
  @property
  def update_interval() -> int: ...
  @update_interval.setter
  def update_interval(value) -> None: ...

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

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