Displaying data on application tiles

Implement the logic of the class. The GetModel method needs to return the data of the Live tile in one of the following formats:

1. LiveTileModel object containing:

   1. Value - the numerical value displayed on the Live tile
   2. Description - the description of the numerical value

2. Null - in cases when you want the application tile to stay static. For example, when the number of objects displayed by the tile is 0.

   C#

   Copy

   using System;
   
   using CMS.ApplicationDashboard;
   using CMS.Core;
   using CMS.Helpers;
   using CMS.OnlineMarketing;
   using CMS.SiteProvider;
   using CMS.WebAnalytics;
   
   public class ContactManagementLiveTileModelProvider : ILiveTileModelProvider
   {
       public LiveTileModel GetModel(LiveTileContext liveTileContext)
       {
           if (liveTileContext == null)
           {
               throw new ArgumentNullException("liveTileContext");
           }
   
           return CacheHelper.Cache(() =>
           {
               if (!ActivitySettingsHelper.OnlineMarketingEnabled(liveTileContext.SiteInfo.SiteName))
               {
                   return null;
               }
   
               var newContactsCount = GetNewContactsCount(liveTileContext.SiteInfo);
   
               return new LiveTileModel
               {
                   Value = newContactsCount,
                   Description = "New contacts in the last 14 days",
               };
           }, new CacheSettings(2, "ContactManagementLiveTileModelProvider", liveTileContext.SiteInfo.SiteID));
       }
   
       /// <summary>
       /// Gets total number of new contacts from the last 14 days.
       /// </summary>
       /// <param name="site">Contacts' site</param>
       /// <returns>Number of new contacts</returns>
       private static int GetNewContactsCount(SiteInfo site)
       {
           return ContactInfoProvider.GetContacts()
                                     .OnSite(site.SiteID)
                                     .CreatedAfter(DateTime.Now.AddDays(-14))
                                     .Count;
       }
   }

Register the live model provider via an assembly attribute using the module code name and UI element code name represented by the Live tile.

Module and UI element code names

Find the module code name when editing the specific module in the Modules application. For Kentico modules, you can also use the constant defined in the CMS.Core.ModuleName class. 

Find the UI element code name in Modules -> UI elements on the General tab of the UI element.

[assembly: RegisterLiveTileModelProvider("CustomModuleCodeName", "UIElement", typeof(ContactManagementLiveTileModelProvider))]

[assembly: RegisterLiveTileModelProvider(ModuleName.ABTEST, "ContactsFrameset", typeof(ContactManagementLiveTileModelProvider))]

Note that registering an existing live model provider overwrites the functionality. This way, you can change the behaviour of the default Live tiles. 

[assembly: RegisterLiveTileModelProvider(ModuleName.ONLINEMARKETING, "ContactsFrameset", typeof(ContactManagementLiveTileModelProvider))]

Save the file.