A .NET Standard and .NET Core Salesforce REST API integration library

Library Targets

CHANGELOG

Projects in this solution:

NuGet Packages

Designed to minimize dependencies:

Basic Usage Example

///Initialize the authentication clientAuthenticationClientauth=newAuthenticationClient();//Pass in the login informationawaitauth.UsernamePasswordAsync("your-client-id","your-client-secret","your-username","your-password","token-endpoint-url");//the AuthenticationClient object will then contain the instance URL and access token to be used in each of the API callsForceClientclient=newForceClient(auth.AccessInfo.InstanceUrl,auth.ApiVersion,auth.AccessInfo.AccessToken);//Retrieve an object by IdSfAccountacct=awaitclient.GetObjectById<SfAccount>(SfAccount.SObjectTypeName,"001i000002C8QTI");//Modify the record and updateacct.Description="Updated Description";awaitclient.UpdateRecord<SfAccount>(SfAccount.SObjectTypeName,acct.Id,acct);//Delete the recordawaitclient.DeleteRecord(SfAccount.SObjectTypeName,acct.Id);//Get the results of a SOQL queryList<SfCase>cases=awaitclient.Query<SfCase>("SELECT Id,CaseNumber,Account.Name,Contact.Name FROM Case");

Nested Query Results

SELECT Id,CaseNumber,Account.Name,Contact.Name FROM Case

List<SfCase>cases=awaitclient.Query<SfCase>("SELECT Id,CaseNumber,Account.Name,Contact.Name FROM Case");SfCasefirstCase=cases[0];stringcaseNumber=firstCase.CaseNumber;stringcaseAccountName=firstCase.Account.Name;stringcaseContactName=firstCase.Contact.Name;

// *NOT* fully supported"SELECT Id,CaseNumber, (Select Contact.Name from Account) FROM Case"

Asynchronous Batch Processing

// First create the async enumerable. At this point, no query has been executed.// batchSize can be omitted to use the default (usually 2000), or given a custom value between 200 and 2000.IAsyncEnumerable<SfContact>contactsEnumerable=client.QueryAsync<SfContact>("SELECT Id, Name FROM Contact ",batchSize:200);// Get the enumerator, in a using block for proper disposalawaitusing(IAsyncEnumerator<SfContact>contactsEnumerator=contactsEnumerable.GetAsyncEnumerator()){// MoveNext() will execute the query and get the first batch of results.// Once the inital result batch has been exhausted, the remaining batches, if any, will be retrieved.while(awaitcontactsEnumerator.MoveNextAsync()){SfContactcontact=contactsEnumerator.Current;// process your results}}