IProvider interface
Version Info: This topic applies to Episerver.ConnectForMarketingAutomation 4.0.0 and lower. For later versions, see Sample Connector - IMarketingConnector.
A core element, the IProvider Service property provides service for marketing automation.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
public interface IProvider
Properties
IProvider.Name property ![](/globalassets/public-property-icon.png)
Identifies the provider. Implementation returns its unique name and it matches the name used in Views/Admin folder and the name of provider-defined in MAI.config.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
string Name { get; }
- Property value. Type: String
- Remarks. The name is used to load the Admin Settings Page under Views/Admin folder.
IProvider.Services property ![](/globalassets/public-property-icon.png)
Gets the current services (Campaign, Profile, Score, ...) of this marketing automation provider. API calls to 3rd services are accessed through this service.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
IProviderServices Services { get; }
- Property value. Type: IProviderServices
IProvider.Settings property ![](/globalassets/public-property-icon.png)
Gets the current settings of this marketing automation provider.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
IProviderSettings Settings { get; }
- Property value. Type: IProviderSettings
- Remarks. Concrete provider casts this Settings into its own specific type.
Methods
IProvider.GetDashboardUrl method ![](/globalassets/public-method-icon.png)
Gets the URL to the provider's Dashboard, which is the starting point of using this provider's services.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
string GetDashboardUrl()
- Return value. Type: String
URL.
IProvider.GetSettingsControlPath method ![](/globalassets/public-method-icon.png)
Provides a user control for setting its working data (such as username, password, access token, and so on). The MAI.Core setting page automatically loads this settings control of the active provider into the AdminMode/Config/Connect of the marketing automation page.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
string GetSettingsControlPath()
- Return value. Type: String
Relative path from provider path to the web user control (for example, Settings.ascx). - Examples. Views/Admin/MyProviderSettings.ascx
IProvider.GetWebTrackingCode method ![](/globalassets/public-method-icon.png)
Gets the Web Tracking Code to inject into the ViewMode's page.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
string GetWebTrackingCode()
- Return value. Type: String
Web tracking code.
IProvider.Init method ![](/globalassets/public-method-icon.png)
Initialize the Provider with its services. Use Init to use StructureMap to provide "sp.For<IListService>().Use<ListService>()" commands.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
-
Parameters.void Init( ServiceConfigurationContext serviceConfigurationContext )
- serviceConfigurationContext. Type: EPiServer.ServiceLocation.ServiceConfigurationContext
IProvider.IsReady method ![](/globalassets/public-method-icon.png)
Indicates that this provider is ready to work.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
bool IsReady()
- Return value. Type: Boolean
Returns true if mandatory settings of this provider are filled in.
IProvider.ProcessXFormData method ![](/globalassets/public-method-icon.png)
Implement this method to handle XFormData posting, from both MVC or WebForm app. You can use this as a main point to bring XForm data to the marketing automation service.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
void ProcessXFormData( Object sender, XFormDataEventArgs e )
- Parameters.
- sender. Type: System. Object
Object - e. Type: XFormDataEventArgs
Pass form data through this. You can retrieve the data as innerHtml or Xml.
- sender. Type: System. Object
IProvider.SynchronizeMailingTemplates method ![](/globalassets/public-method-icon.png)
Verify whether a mailing template is waiting to be published, and send to provider.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
string SynchronizeMailingTemplates()
- Return value. Type: String
Message is displayed in a log entry.
Last updated: Dec 10, 2015