| Name | Description | |
|---|---|---|
 | SalesforceConnectionStringBuilder Constructor | Overloaded. Initializes a new instance of the SalesforceConnectionStringBuilder class. |
SalesforceConnectionStringBuilder Class Members
In This Topic
The following tables list the members exposed by SalesforceConnectionStringBuilder.
Public Constructors
Public Properties
| Name | Description | |
|---|---|---|
 | Authentication | Determines the authentication method to use when connecting to Salesforce. |
| BatchSize | Gets or sets the number of records returned by a service at once. The default value is 500; the minimum is 200, and the maximum is 2,000. |
| CacheAll | Determines whether to cache data from all the Salesforce tables. |
| ClientId | Gets or sets the Consumer Key from the connected app definition. |
| ClientSecret | Gets or sets the Consumer Secret from the connected app definition. |
| ConnectionLifetime | Gets or sets time span in seconds for connection to live. |
| ConnectionString | Gets or sets the connection string associated with the System.Data.Common.DbConnectionStringBuilder. (Inherited from System.Data.Common.DbConnectionStringBuilder) |
| ConnectionTimeout | Gets or sets the time to wait while trying to establish a connection before terminating the attempt and generating an error. |
| Count | Gets the current number of keys that are contained within the System.Data.Common.DbConnectionStringBuilder.ConnectionString property. (Inherited from System.Data.Common.DbConnectionStringBuilder) |
| DataCache | Gets or sets the path to the data cache database file. If not set, the file is located in the user Application Data directory by default and is named by the Salesforce.com or Database.com account name. |
| DefaultCommandTimeout | Gets or sets the time in seconds to wait while trying to execute a command before terminating the attempt and generating an error. |
| DefaultRefreshInterval | Gets or sets the default refresh interval in seconds for refreshing data in cache. The default value is 3600 (one hour) |
| DeferredLogin | Determines whether to delay establishing an actual connection to Salesforce until some data that is not present in the local cache is queried or data is modified. |
| Host | Gets or sets the Salesforce.com or Database.com login URL |
| IncludeDeleted | Determines whether to include the deleted records (from Salesforce recycled bin) to SELECT query results. |
| InitializationCommand | Specifies a data source-specific command that should be executed immediately after establishing the connection. (Inherited from Devart.Common.DbConnectionStringBuilder) |
| IsFixedSize | Overridden. Returns true. |
| IsReadOnly | Gets a value that indicates whether the System.Data.Common.DbConnectionStringBuilder is read-only. (Inherited from System.Data.Common.DbConnectionStringBuilder) |
| Item | Overridden. Returns the value of given key. |
| Keys | Overridden. Collection of keys in the SalesforceConnectionStringBuilder. |
| MaxPoolSize | The maximum number of connections allowed in the pool. |
| MetadataCache | Gets or sets the path to the metadata cache database file. If not set, the file is located in the user Application Data directory by default and is named by the Salesforce.com or Database.com account name. |
| MinPoolSize | The minimum number of connections allowed in the pool. |
| OrganizationId | Gets or sets a string, representing a unique identifier for the Salesforce organization to which the account you connect to belongs. |
| Password | Gets or sets the user's password to connect. |
| PersistSecurityInfo | Gets or sets a value indicating whether password is stored in connection string after connection is opened. |
| Pooling | Gets or sets pooling mode. |
| PreserveNames | |
| ProxyHost | Gets or sets the host name or IP address of the proxy server to which to connect. |
| ProxyPassword | Gets or sets the password for the proxy server account. |
| ProxyPort | Gets or sets the port number of the proxy server. |
| ProxyUser | Gets or sets the proxy server account name. |
| Readonly | Gets or sets a value indicating whether the connection is read-only (allows only SELECT statements). |
| RefreshMetadata | Gets or sets a value determining whether to refresh the Salesforce.com or Database.com metadata each time when connecting. |
| RefreshToken | Gets or sets the Salesforce OAuth 2.0 refresh token to use with RefreshToken authentication. |
| RunOnceCommand | Specifies a data source-specific command that should be executed immediately after first establishing the connection. Unlike InitializationCommand, this command is not executed when a connection is taken from the pool. (Inherited from Devart.Common.DbConnectionStringBuilder) |
| SecurityToken | Gets or sets the automatically generated key that is used for logging in to Salesforce from an untrusted network. |
| SessionId | Gets or sets Salesforce session ID for the session ID authorization. |
| SObjects | |
| SystemObjects | Determines whether to provide access to Salesforce system columns such as CreationDate, IsDeleted, etc. |
| TriggerAutoResponseEmail | Determines whether to trigger auto-response rules or not. |
| TriggerOtherEmail | Determines whether to trigger email outside the organization or not. |
| TriggerUserEmail | Determines whether to trigger email that is sent to users in the organization or not. |
| UpdateMru | Determines whether to update the list of most recently used items or not. |
| UpgradeCache | Determines whether to upgrade the local cache database or to throw an exception in case when dotConnect for Salesforce version that uses a newer cache structure or newer version of Salesforce API discovers an old incompatible cache for the connection that is opening. Default value is true. |
| UseAssignmentRules | Determines whether to use assignment rules when inserting or updating data. |
| UserId | Gets or sets the name of the user to connect. |
| UtcDates | Indicates whether all the datetime values retrieved from Salesforce are returned as UTC values or converted to local time, and whether date values, specified on the application side (for example, in SQL statements) are considered UTC or local. |
| Values | Overridden. Collection of values in the SalesforceConnectionStringBuilder. |
Public Methods
| Name | Description | |
|---|---|---|
 | Add | Adds an entry with the specified key and value into the System.Data.Common.DbConnectionStringBuilder. (Inherited from System.Data.Common.DbConnectionStringBuilder) |
| Clear | Overridden. Sets all SalesforceConnectionStringBuilder properties to default values. |
| ContainsKey | Overridden. Indicates whether specified key is set in the SalesforceConnectionStringBuilder object. |
| EquivalentTo | Overloaded. Overridden. Returns a value indicating whether this SalesforceConnectionStringBuilder has same parameters as given DbConnectionStringBuilder. |
| Remove | Overridden. Sets value of the specified key to default. |
| ShouldSerialize | Overridden. Determines whether the key will be serialized if required. |
| ToString | Returns the connection string associated with this System.Data.Common.DbConnectionStringBuilder. (Inherited from System.Data.Common.DbConnectionStringBuilder) |
| TryGetValue | Overridden. Attempts to get a key value. |
See Also