Sample: Use Dynamics 365 for Outlook methods

Article
08/11/2022
2 minutes to read

This sample shows how to use the methods available in the Microsoft.Crm.Outlook.Sdk.dll assembly. You can download the sample from here.

Note

This sample applies to both Dynamics 365 Customer Engagement (on-premises) and Dataverse.

How to run this sample

To obtain a local copy of all samples and build them, do the following:

Download or clone the Samples repo so that you have a local copy.
(Optional) Edit the cds/App.config file to define a connection string specifying the instance/organization you want to connect to.
Open the sample solution in Visual Studio and press F5 to run the sample. After you specify a connection string in cds/App.config, any sample you run will use that connection information.

If you do not specify a connection string in cds/App.config file, a dialog will open each time you run the sample and you will need to enter information about which instance/org you want to connect to and which credentials you want to use. This dialog will cache previous connections so that you can choose a previously used connection.

What this sample does

The Microsoft.Crm.Outlook.sdk assembly is used in a scenario where it contains types that provide programmatic interaction with Microsoft Dynamics 365 for Outlook and Microsoft Dynamics 365 for Microsoft Office Outlook with Offline Access.

How this sample works

In order to simulate the scenario described above, the sample will do the following:

Setup

Checks for the current version of the org.

Demonstrate

The CrmOutlookService method sets up the service.
The CrmOutlookService.IsCrmClientOffline method checks if the client is offline.
The CrmOutlookService.GoOnline() method takes the client to online. This method will automatically sync up with database, there is no need to call the Sync() method.

Clean up

Display an option to delete the sample data that is created in Setup. The deletion is optional in case you want to examine the entities and data created by the sample. You can manually delete the records to achieve the same result.