IProfileService interface

Version Info: This topic applies to Episerver.ConnectForMarketingAutomation 4.0.0 and lower. For later versions, see Sample Connector - IMarketingConnector. 

 Define methods related to a profile.

• Namespace. EPiServer.MarketingAutomationIntegration.Services
• Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
• C# syntax.
  

  public interface IProfileService

Methods

IProfileService.AddProfileToList method 

Adds the profile to the profile list.

• Namespace. EPiServer.MarketingAutomationIntegration.Services
• Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
• C# syntax.
  

  bool AddProfileToList(
    int listId,
    long profileId
  )

• Parameters.
  • listId. Type: System. Int32
    The list identifier.
  • profileId. Type: System. Int64
    The profile identifier.
• Return value. Type: Boolean
  Result of whether the profile was added to the list.

IProfileService.CreateProfile method 

Create a new profile and add it to a database that the profile expects.

• Namespace. EPiServer.MarketingAutomationIntegration.Services
• Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
• C# syntax.
  

  string CreateProfile(
    Profile newProfile
  )

• Parameters.
  • newProfile. Type: Profile
    The new profile data.
• Return value. Type: String
  The profile's Id string (or null if not found).

IProfileService.GetCurrentProfile method 

Get the current profile through sources.

• Namespace. EPiServer.MarketingAutomationIntegration.Services
• Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
• C# syntax.
  

  Profile GetCurrentProfile()

• Return value. Type: Profile
  The current profile.

IProfileService.GetCurrentProfileFromSource method 

Gets a current profile by the source identification.

• Namespace. EPiServer.MarketingAutomationIntegration.Services
• Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
• C# syntax.
  

  Profile GetCurrentProfileFromSource(
    int databaseId
  )

• Parameters.
  • databaseId. Type: System. Int32
    The source identification to get profile.
• Return value. Type: Profile
  The current profile from the source.

IProfileService.GetProfile method 

Gets a profile by Id.

• Namespace. EPiServer.MarketingAutomationIntegration.Services
• Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
• C# syntax.
  

  Profile GetProfile(
    int databaseId,
    long profileId
  )

• Parameters.
  • databaseId. Type: System. Int32
    The database Id.
  • profileId. Type: System. Int64
    The profile identifier.
• Return value. Type: Profile
  A profile (or null if not found).

IProfileService.OptInProfile method 

Opt-in a profile.

• Namespace. EPiServer.MarketingAutomationIntegration.Services
• Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
• C# syntax.
  

  bool OptInProfile(
    int databaseId,
    long profileId
  )

• Parameters.
  • databaseId. Type: System. Int32
    The database identifier.
  • profileId. Type: System. Int64
    The profile identifier.
• Return value. Type: Boolean
  True if opt-in is successful (otherwise false).

IProfileService.OptOutProfile method 

Opt-out a profile.

• Namespace. EPiServer.MarketingAutomationIntegration.Services
• Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
• C# syntax.
  

  bool OptOutProfile(
    int databaseId,
    long profileId
  )

• Parameters.
  • databaseId. Type: System. Int32
    The database identifier.
  • profileId. Type: System. Int64
    The profile identifier.
• Return value. Type: Boolean
  True if opt-out is successful (otherwise false).

IProfileService.RemoveProfile method 

Remove profile from the input database.

• Namespace. EPiServer.MarketingAutomationIntegration.Services
• Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
• C# syntax.
  

  bool RemoveProfile(
    int databaseId,
    long profileId
  )

• Parameters.
  • databaseId. Type: System. Int32
    The database identifier.
  • profileId. Type: System. Int64
    The profile identifier.
• Return value. Type: Boolean
  True if removal is successful (otherwise false).

IProfileService.UpdateProfile method 

Update a profile with input fields that need an update.

• Namespace. EPiServer.MarketingAutomationIntegration.Services
• Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
• C# syntax.
  

  bool UpdateProfile(
    int databaseId,
    long profileId,
    Dictionary<string, Object> fieldsToUpdate,
    bool addMissingColumns
  )

• Parameters.
  • databaseId. Type: System. Int32
    The database identifier.
  • profileId. Type: System. Int64
    The profile identifier.
  • fieldsToUpdate. Type: System.Collections.Generic. Dictionary< String, Object>
    Dictionary of fields that need an update.
  • addMissingColumns. Type: System. Boolean
    If set to true, synchronize the columns with the database.
• Return value. Type: Boolean
  True if update is successful (otherwise false).

Last updated: Dec 10, 2015