C# Class Zombie.ConnectionMgr

The ConnectionMgr class is used to configure the application identity and as a source of SDK connections, which require the application identity
Show file Open project: pkpjpm/Zombie Class Usage Examples

Public Methods

Method Description
GetConnection ( ) : SDKConnection

Creates an SDK connection using the current default connection configuration

GetConnection ( ConnectionConfig config ) : SDKConnection

Creates and SDK connection using the specified connection configuration

GetTestConnection ( Interop.QBFC12 sessionMgr ) : SDKConnection
InitDesktop ( string applicationName ) : void

A simple method to initialize an application that will connect to the current QuickBooks desktop edition file.

SetApplicationIdentity ( ApplicationIdentity id ) : void
ShutDown ( ) : void

Closes all connections and ends the session. If you wrap all of your connections with the using statement, you won't need this. But if you're getting creative with connection management, this method should clean things up if it is called during application shutdown.

Private Methods

Method Description
ConnectionClosed ( SDKConnection cn ) : void

Method Details

GetConnection() public static method

Creates an SDK connection using the current default connection configuration
public static GetConnection ( ) : SDKConnection
return SDKConnection

GetConnection() public static method

Creates and SDK connection using the specified connection configuration
public static GetConnection ( ConnectionConfig config ) : SDKConnection
config ConnectionConfig The connection configuration to use
return SDKConnection

GetTestConnection() public static method

public static GetTestConnection ( Interop.QBFC12 sessionMgr ) : SDKConnection
sessionMgr Interop.QBFC12
return SDKConnection

InitDesktop() public static method

A simple method to initialize an application that will connect to the current QuickBooks desktop edition file.
public static InitDesktop ( string applicationName ) : void
applicationName string The name that identifies the application to QuickBooks
return void

SetApplicationIdentity() public static method

public static SetApplicationIdentity ( ApplicationIdentity id ) : void
id System.ApplicationIdentity
return void

ShutDown() public static method

Closes all connections and ends the session. If you wrap all of your connections with the using statement, you won't need this. But if you're getting creative with connection management, this method should clean things up if it is called during application shutdown.
public static ShutDown ( ) : void
return void