ProviderBase class
Version Info: This topic applies to Episerver.ConnectForMarketingAutomation 4.0.0 and lower. For later versions, see Sample Connector - IMarketingConnector.
- Inheritance hierarchy.
System.Object EPiServer.MarketingAutomationIntegration.Core.ProviderBase DemoConnector.Services.Provider
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
public abstract class ProviderBase : IProvider
Constructor ![](/globalassets/public-method-icon.png)
Initializes a new instance of the ProviderBase class.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
protected ProviderBase()
Properties
ProviderBase.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.
public abstract string Name { get; }
- Property value. Type: String
- Implements. IProvider.Name
- Remarks. The name is used to load the Admin Settings Page under Views/Admin folder.
ProviderBase.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.
public IProviderServices Services { get; }
- Property value. Type: IProviderServices
- Implements. IProvider.Services
ProviderBase.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.
public abstract IProviderSettings Settings { get; }
- Property value. Type: IProviderSettings
- Implements. IProvider.Settings
- Remarks. Concrete provider casts this Settings into its own specific type.
Methods
ProviderBase.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.
public abstract string GetDashboardUrl()
- Return value. Type: String
Url. - Implements. IProvider.GetDashboardUrl()
ProviderBase.GetMarketingAutomationDataFromXForm method ![](/globalassets/public-method-icon.png)
Gets the submit parameter string.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
protected virtual string GetMarketingAutomationDataFromXForm( XFormData xFormData )
- Parameters.
- xFormData. Type: XFormData
The xform data.
- xFormData. Type: XFormData
- Return value. Type: String
ProviderBase.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.
public virtual string GetSettingsControlPath()
- Return value. Type: String
Relative path from provider path to the web user control (for example, Settings.ascx). - Implements. IProvider.GetSettingsControlPath()
- Examples. Views/Admin/MyProviderSettings.ascx
ProviderBase.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.
public virtual string GetWebTrackingCode()
- Return value. Type: String
Return an empty string. - Implements. IProvider.GetWebTrackingCode()
ProviderBase.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.
public abstract void Init( ServiceConfigurationContext serviceConfigurationContext )
- Parameters.
- serviceConfigurationContext. Type: EPiServer.ServiceLocation.ServiceConfigurationContext
- Implements. IProvider.Init(ServiceConfigurationContext)
ProviderBase.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.
public abstract bool IsReady()
- Return value. Type: Boolean
Returns true if mandatory settings of this provider are filled in. - Implements. IProvider.IsReady()
ProviderBase.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.
public abstract 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
- Implements. IProvider.ProcessXFormData(Object, XFormDataEventArgs)
ProviderBase.SaveSettings method ![](/globalassets/public-method-icon.png)
Saves the settings for the current marketing automation provider to the Dynamic Data Store.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
public virtual IProviderSettings SaveSettings( IProviderSettings settings )
- Parameters.
- settings. Type: EPiServer.MarketingAutomationIntegration.Core.IProviderSettings
The settings.
- settings. Type: EPiServer.MarketingAutomationIntegration.Core.IProviderSettings
- Return value. Type: IProviderSettings
ProviderBase.SynchronizeMailingTemplates method ![](/globalassets/public-method-icon.png)
Verify whether a mailing template is waiting to be published, and send to the provider.
- Namespace. EPiServer.MarketingAutomationIntegration.Core
- Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
- C# syntax.
public virtual string SynchronizeMailingTemplates()
- Return value. Type: String
Message is displayed as a log entry. - Implements. IProvider.SynchronizeMailingTemplates()
Last updated: Dec 10, 2015