Try our conversational search powered by Generative AI!

IProfileService interface

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

 Define methods related to a profile.

Methods

IProfileService.AddProfileToList method 

Adds the profile to the profile list.

  • NamespaceEPiServer.MarketingAutomationIntegration.Services
  • Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
  • C# syntax.
    bool AddProfileToList(
      int listId,
      long profileId
    )
  • Parameters.
  • Return value. TypeBoolean
    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.

  • NamespaceEPiServer.MarketingAutomationIntegration.Services
  • Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
  • C# syntax.
    string CreateProfile(
      Profile newProfile
    )
  • Parameters.
    • newProfileType: Profile
      The new profile data.
  • Return valueTypeString
    The profile's Id string (or null if not found).

IProfileService.GetCurrentProfile method 

Get the current profile through sources.

  • NamespaceEPiServer.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.

  • NamespaceEPiServer.MarketingAutomationIntegration.Services
  • Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
  • C# syntax.
    Profile GetCurrentProfileFromSource(
      int databaseId
    )
  • Parameters.
    • databaseId. TypeSystem. 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.

  • NamespaceEPiServer.MarketingAutomationIntegration.Services
  • Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
  • C# syntax.
    Profile GetProfile(
      int databaseId,
      long profileId
    )
  • Parameters.
  • Return value. Type: Profile
    A profile (or null if not found).

IProfileService.OptInProfile method 

Opt-in a profile.

  • NamespaceEPiServer.MarketingAutomationIntegration.Services
  • Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
  • C# syntax.
    bool OptInProfile(
      int databaseId,
      long profileId
    )
  • Parameters.
  • Return value. TypeBoolean
    True if opt-in is successful (otherwise false).

IProfileService.OptOutProfile method 

Opt-out a profile.

  • NamespaceEPiServer.MarketingAutomationIntegration.Services
  • Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
  • C# syntax.
    bool OptOutProfile(
      int databaseId,
      long profileId
    )
  • Parameters.
  • Return value. TypeBoolean
    True if opt-out is successful (otherwise false).

IProfileService.RemoveProfile method 

Remove profile from the input database.

  • NamespaceEPiServer.MarketingAutomationIntegration.Services
  • Assembly. EPiServer.MarketingAutomationIntegration (in EPiServer.MarketingAutomationIntegration.dll) Version: 2.2.0.9000
  • C# syntax.
    bool RemoveProfile(
      int databaseId,
      long profileId
    )
  • Parameters.
  • Return value. TypeBoolean
    True if removal is successful (otherwise false).

IProfileService.UpdateProfile method 

Update a profile with input fields that need an update.

  • NamespaceEPiServer.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.
  • Return value. TypeBoolean
    True if update is successful (otherwise false).

Last updated: Dec 10, 2015