C1QuickBooksOnlineConnection Class

<xref href="C1.AdoNet.QuickBooksOnline.C1QuickBooksOnlineConnection" data-throw-if-not-resolved="false"></xref> represents a connection to a QuickBooksOnline server.

The connection can be used to query the data hosted by the server or request modifications.

Inheritance

object

C1ConnectionBase<C1QuickBooksOnlineConnection>

C1QuickBooksOnlineConnection

Implements

Namespace: C1.AdoNet.QuickBooksOnline

Assembly: C1.AdoNet.QuickBooksOnline.dll

Syntax

public sealed class C1QuickBooksOnlineConnection : C1ConnectionBase<C1QuickBooksOnlineConnection>, IComponent, IDbConnection, IDisposable, IAsyncDisposable

Public NotInheritable Class C1QuickBooksOnlineConnection
    Inherits C1ConnectionBase(Of C1QuickBooksOnlineConnection)
    Implements IComponent, IDbConnection, IDisposable, IAsyncDisposable

Constructors

Name	Description
C1QuickBooksOnlineConnection()	Creates a new C1QuickBooksOnlineConnection instance.
C1QuickBooksOnlineConnection(C1QuickBooksOnlineConnectionStringBuilder)	Initialize a new C1QuickBooksOnlineConnection instance using the specified connection string expressed in a C1QuickBooksOnlineConnectionStringBuilder.
C1QuickBooksOnlineConnection(string)	Initialize a new C1QuickBooksOnlineConnection instance using the specified connection string.

Properties

Name	Description
CompanyId	The unique identifier of a given company in QuickBooks Online.
CountryCode	The country code for the edition of QuickBooks Online being used.
DataSource	Gets the name of the database server to which to connect.
Database	Gets the name of the current database after a connection is opened, or the database name specified in the connection string before the connection is opened.
DbProviderFactory	Gets the DbProviderFactory for this connection.
MinorVersion	Set the minor version to be used when sending requests to the QuickBooks Online API.
OAuthToken	Gets the current access token and refresh token.
ServerVersion	Gets a string that represents the version of the server to which the object is connected.
UseSandbox	A boolean indicating if you are using a Sandbox account.

Methods

Name	Description
BeginDbTransaction(IsolationLevel)	Begins a transaction on the connection.
ChangeDatabase(string)	Changes the current database for an open connection.
Close()	Closes the connection to the database. This is the preferred method of closing any open connection.
CreateDbCommand()	Creates and returns a DbCommand object associated with the current connection.
Dispose(bool)	Dispose the connection.
GetColumnsSchema(string[])	Retrieve the metadata relatively to the columns.
GetForeignKeySchema(string[])	Retrieve the metadata relatively to the foreign keys.
GetIndexColumns(string[])	Retrieve the metadata relatively to the index columns.
GetIndexesSchema(string[])	Retrieve the metadata relatively to the indexes.
GetPrimaryKeySchema(string[])	Retrieve the metadata relatively to the primary keys.
GetTablesSchema(string[])	Retrieve the metadata relatively to the tables.
GetViewsSchema(string[])	Retrieve the metadata relatively to the views.
OnConnectionStringChanged()	A method that is executed everytime that the connection string used by this C1QuickBooksOnlineConnectionStringBuilder has changed.
Open()	Opens a database connection with the settings specified by the connection string.
OpenAsync(CancellationToken)	An asynchronous version of Open() open.

Events

Name	Description
OAuthTokenRefreshed	Occurs after the token refreshes.