/// <summary>
/// This collection of single-contact tutorials shows how to use the API working with one Contact record.
/// TUTORIALS INCLUDED:
/// 1. Create and retrieve a Contact
/// 2. Update an existing Contact
/// 3. Register a goal (create an interaction) for an existing Contact
/// 4. Access the Reference Data Manager and also create an entry
/// 5. Retrieve a Contact with a full list of all its interactions
/// 6. Search the interactions index for interactions in a specific date range
/// 7. Take an interaction search result and expand it to get all the details
/// 8. Delete a single existing contact (the one created in the first tutorial)
/// </summary>
/// <param name="cfg">The configuration used to open connections to xConnect</param>
public static async Task SingleContactTutorials(XConnectClientConfiguration cfg)
{
//Initialize required handlers
var configuration = new Configuration();
var outputHandler = new OutputHandler();
var interactionManager = new InteractionManager()
{
Logger = outputHandler
};
var referenceDataManager = new ReferenceDataManager()
{
Logger = outputHandler
};
/**
* TUTORIAL: Create and retrieve a contact
*/
//Create a contact
var twitterId = configuration.TwitterIdentifier + Guid.NewGuid().ToString("N");
var contactCreator = new CreateContactTutorial()
{
Logger = outputHandler
};
var identifier = await contactCreator.CreateContact(cfg, twitterId);
//Retrieve a contact that was created
var contactLoader = new GetContactTutorial()
{
Logger = outputHandler
};
var contact = await contactLoader.GetContact(cfg, twitterId);
/**
* TUTORIAL: Update an existing contact
*/
//Update the personal information about a Contact
PersonalInformation updatedPersonalInformation = new PersonalInformation()
{
JobTitle = "Senior Programmer Writer"
};
var contactUpdater = new UpdateContactTutorial()
{
Logger = outputHandler
};
var updatedContact = await contactUpdater.UpdateContact(cfg, twitterId, updatedPersonalInformation);
/**
* TUTORIAL: Register a goal for the created contact
*/
//Initialize IP information which will be used for tracking events.
var ipInfo = new IpInfo("127.0.0.1")
{
BusinessName = "Home"
};
var interaction = await interactionManager.RegisterGoalInteraction(cfg, contact, configuration.OtherEventChannelId, configuration.InstantDemoGoalId, ipInfo);
/**
* TUTORIAL: Reference Data Manager
*/
var definition = await referenceDataManager.GetDefinition(configuration.GoalTypeName, configuration.InstantDemoGoalId, configuration.XConnectUrl, configuration.Thumbprint);
if (definition == null)
{
definition = await referenceDataManager.CreateDefinition(configuration.GoalTypeName, configuration.InstantDemoGoalId, configuration.InstantDemoGoalName, configuration.XConnectUrl, configuration.Thumbprint);
}
/**
* TUTORIAL: Get a contact with its list of interactions
*/
//Get a contact with the interactions
contact = await contactLoader.GetContactWithInteractions(cfg, twitterId, DateTime.MinValue, DateTime.MaxValue);
/**
* TUTORIAL: Search Interactions
*/
//Find all interactions created in a specific date range. Note that dates are required in UTC or local time
var startDate = new DateTime(configuration.SearchYear, configuration.SearchMonth, configuration.SearchStartDay).ToUniversalTime();
var endDate = startDate.AddDays(configuration.SearchDays);
var interactions = await interactionManager.SearchInteractionsByDate(cfg, startDate, endDate);
/**
* TUTORIAL: Expand a single interaction search results
*/
//Look for the first result in the search results
var interactionResult = interactions != null?interactions.LastOrDefault() : null;
//If the search result has sufficient contact and interaction ID data present, request the expanded details about the interaction
if (interactionResult != null && interactionResult.Contact != null && interactionResult.Contact.Id.HasValue && interactionResult.Id.HasValue)
{
var triggeredGoal = await interactionManager.GetInteraction(cfg, interactionResult.Contact.Id.Value, interactionResult.Id.Value);
}
/**
* TUTORIAL: Delete a single Contact from the database
*/
var contactDeleter = new DeleteContactTutorial()
{
Logger = outputHandler
};
var deletedContact = await contactDeleter.DeleteContact(cfg, twitterId);
}
private static async Task MainAsync(string[] args)
{
//Initialize required handlers
var outputHandler = new OutputHandler();
var interactionManager = new InteractionManager()
{
Logger = outputHandler
};
var contactManager = new ContactManager()
{
Logger = outputHandler
};
var referenceDataManager = new ReferenceDataManager()
{
Logger = outputHandler
};
var configuration = new Configuration();
//Initialize IP information which will be used for tracking events.
var ipInfo = new IpInfo("127.0.0.1")
{
BusinessName = "Home"
};
//Build a configuration to use to connect to xConnect
var cfg = new ConfigurationBuilder().GetClientConfiguration(configuration.XConnectUrl, configuration.XConnectUrl, configuration.XConnectUrl, configuration.Thumbprint);
//Test configuration
try
{
await cfg.InitializeAsync();
// Print xConnect validation message if configuration is valid
outputHandler.WriteValidationMessage();
}
catch (XdbModelConflictException ce)
{
outputHandler.WriteError("Error initializing configuration", ce);
return;
}
//Create a contact
var twitterId = configuration.TwitterIdentifier + Guid.NewGuid().ToString("N");
var identifier = await contactManager.CreateContact(cfg, twitterId);
//Get the contact that was created
var contact = await contactManager.GetContact(cfg, twitterId);
//Create an interaction for the contact
var interaction = await interactionManager.RegisterGoalInteraction(cfg, contact, configuration.OtherEventChannelId, configuration.InstantDemoGoalId, ipInfo);
//Ensure our goal is defined in the Reference Data database
var definition = await referenceDataManager.GetDefinition(configuration.GoalTypeName, configuration.InstantDemoGoalId, configuration.XConnectUrl, configuration.Thumbprint) ??
await referenceDataManager.CreateDefinition(configuration.GoalTypeName, configuration.InstantDemoGoalId, configuration.InstantDemoGoalName, configuration.XConnectUrl, configuration.Thumbprint);
//Get a contact with the interactions
contact = await contactManager.GetContactWithInteractions(cfg, twitterId, DateTime.MinValue, DateTime.MaxValue);
//Find all interactions created in a specific date range. Note that dates are required in UTC or local time
var startDate = new DateTime(configuration.SearchYear, configuration.SearchMonth, configuration.SearchStartDay).ToUniversalTime();
var endDate = startDate.AddDays(configuration.SearchDays);
var interactions = await interactionManager.SearchInteractionsByDate(cfg, startDate, endDate);
}
