Connecting from Code
The CData ADO.NET Provider for Highrise implements a standard DbConnection object in HighriseConnection. You can also use the HighriseConnectionStringBuilder to programmatically build, parse, and rebuild connection strings.
Creating Connection Objects
See Establishing a Connection for guides to defining the connection string and authenticating. Below is a typical invocation to create HighriseConnection objects.
C#
using (HighriseConnection connection =
new HighriseConnection("InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;"))
{
connection.Open();
}
VB.NET
Using connection As New HighriseConnection("InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;")
connection.Open
End Using
Using HighriseConnectionStringBuilder
The following code example shows how to use an ADO.NET connection string builder to parse a connection string.
C#
HighriseConnectionStringBuilder builder =
new HighriseConnectionStringBuilder("InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;");
//Pass the connection string builder an existing connection string, and you can get and set any of the elements as strongly typed properties.
builder.ConnectionString = "InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;";
//Now that the connection string has been parsed,
// you can work with individual items:
builder.MyString = "new property";
builder.MyBoolean = true;
// You can refer to connection keys using strings,
// as well.
builder["Logfile"] = "test.log";
builder["Verbosity"] = 5;
VB.NET
Dim builder As HighriseConnectionStringBuilder = New HighriseConnectionStringBuilder("InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;")
'Pass the connection string builder an existing connection string, and you can get and set any of the elements using strongly typed properties.
builder.ConnectionString = InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;"
'Now that the connection string has been parsed,
' you can work with individual items:
builder.MyString = "new property"
builder.MyBoolean = True
' You can refer to connection keys using strings,
' as well.
builder("Logfile") = "test.log"
builder("Verbosity") = 5