Method GetDatasetsToRefresh

GetDatasetsToRefresh(IDictionary<String, Object>)

Responsible for getting new datasets at real-time through polling if refresh-on-event is enabled.

Declaration
IDictionary<string, RefreshPreference> GetDatasetsToRefresh(IDictionary<string, object> userContexts)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.Object> userContexts

Dictionary of user context objects to verify which data to refresh.
Returns
Type Description
System.Collections.Generic.IDictionary<System.String, RefreshPreference>

Dictionary of datasets to refresh.
Examples

The following example calls the GetRefreshedDatasets method to get new dataset.

IDictionary<string, RefreshPreference> GetDatasetsToRefresh(IDictionary<string, object> userContexts)
{
    DateTime? lastRefreshTime;
    bool datasetHasUpdated;

    // Create a dictionary for datasets to refresh with their refresh preference 
    IDictionary<string, RefreshPreference> DatasetsToRefresh = new Dictionary<string, RefreshPreference>();

    foreach (var dataset in userContexts.Keys)
    {
         switch (dataset.ToLower())
      {
         // If dataset is products, check if dataset has been updated in data source
         // if yes, then refresh the dataset now
         case "products":
             lastRefreshTime = userContexts[dataset] as DateTime?;
             datasetHasUpdated = HasProductDatasetUpdated(dataset, lastRefreshTime);
             if (datasetHasUpdated)
                {
                   DatasetsToRefresh.Add(dataset, RefreshPreference.RefreshNow);
                }
             break;

        default:
        // Invalid dataset
      }               
    }
  // Return the dictionary containing datasets to refresh on polling with their refresh preferences
  return DatasetsToRefresh;
}