Class ProfileController

Inheritance
object
ProfileController
Inherited Members
Namespace: DotNetNuke.Entities.Profile
Assembly: DotNetNuke.dll
Syntax
public class ProfileController

Constructors

ProfileController()

Declaration
public ProfileController()

Methods

AddDefaultDefinitions(ListController, IEventLogger, IHostSettings, IPortalController, IApplicationStatusInfo, IPortalGroupController, int)

Declaration
public static void AddDefaultDefinitions(ListController listController, IEventLogger eventLogger, IHostSettings hostSettings, IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, int portalId)
Parameters
Type Name Description
ListController listController
IEventLogger eventLogger
IHostSettings hostSettings
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
int portalId

AddDefaultDefinitions(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with ListController. Scheduled for removal in v12.0.0.")]
public static void AddDefaultDefinitions(int portalId)
Parameters
Type Name Description
int portalId

AddPropertyDefinition(IEventLogger, IPortalController, IApplicationStatusInfo, IPortalGroupController, ProfilePropertyDefinition)

Declaration
public static int AddPropertyDefinition(IEventLogger eventLogger, IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, ProfilePropertyDefinition definition)
Parameters
Type Name Description
IEventLogger eventLogger
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
ProfilePropertyDefinition definition
Returns
Type Description
int

AddPropertyDefinition(ProfilePropertyDefinition)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.2. Use overload taking IEventLogger. Scheduled for removal in v12.0.0.")]
public static int AddPropertyDefinition(ProfilePropertyDefinition definition)
Parameters
Type Name Description
ProfilePropertyDefinition definition
Returns
Type Description
int

ClearAllUsersInfoProfileCacheByPortal(int)

Declaration
public static void ClearAllUsersInfoProfileCacheByPortal(int portalId)
Parameters
Type Name Description
int portalId

ClearProfileDefinitionCache(IPortalController, IApplicationStatusInfo, IPortalGroupController, int)

Declaration
public static void ClearProfileDefinitionCache(IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, int portalId)
Parameters
Type Name Description
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
int portalId

ClearProfileDefinitionCache(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with IPortalController. Scheduled for removal in v12.0.0.")]
public static void ClearProfileDefinitionCache(int portalId)
Parameters
Type Name Description
int portalId

DeletePropertyDefinition(IEventLogger, IPortalController, IApplicationStatusInfo, IPortalGroupController, ProfilePropertyDefinition)

Declaration
public static void DeletePropertyDefinition(IEventLogger eventLogger, IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, ProfilePropertyDefinition definition)
Parameters
Type Name Description
IEventLogger eventLogger
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
ProfilePropertyDefinition definition

DeletePropertyDefinition(IEventLogger, ProfilePropertyDefinition)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with IPortalController. Scheduled for removal in v12.0.0.")]
public static void DeletePropertyDefinition(IEventLogger eventLogger, ProfilePropertyDefinition definition)
Parameters
Type Name Description
IEventLogger eventLogger
ProfilePropertyDefinition definition

DeletePropertyDefinition(ProfilePropertyDefinition)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.2. Use overload taking IEventLogger. Scheduled for removal in v12.0.0.")]
public static void DeletePropertyDefinition(ProfilePropertyDefinition definition)
Parameters
Type Name Description
ProfilePropertyDefinition definition

GetPropertyDefinition(IHostSettings, IPortalController, IApplicationStatusInfo, IPortalGroupController, int, int)

Declaration
public static ProfilePropertyDefinition GetPropertyDefinition(IHostSettings hostSettings, IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, int definitionId, int portalId)
Parameters
Type Name Description
IHostSettings hostSettings
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
int definitionId
int portalId
Returns
Type Description
ProfilePropertyDefinition

GetPropertyDefinition(IHostSettings, int, int)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with IPortalController. Scheduled for removal in v12.0.0.")]
public static ProfilePropertyDefinition GetPropertyDefinition(IHostSettings hostSettings, int definitionId, int portalId)
Parameters
Type Name Description
IHostSettings hostSettings
int definitionId
int portalId
Returns
Type Description
ProfilePropertyDefinition

GetPropertyDefinition(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. Please use GetPropertyDefinition(int definitionId, int portalId) instead. Scheduled for removal in v11.0.0.")]
public static ProfilePropertyDefinition GetPropertyDefinition(int definitionId)
Parameters
Type Name Description
int definitionId
Returns
Type Description
ProfilePropertyDefinition

GetPropertyDefinition(int, int)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.0.2. Use overload taking IHostSettings. Scheduled for removal in v12.0.0.")]
public static ProfilePropertyDefinition GetPropertyDefinition(int definitionId, int portalId)
Parameters
Type Name Description
int definitionId
int portalId
Returns
Type Description
ProfilePropertyDefinition

GetPropertyDefinitionByName(IHostSettings, IPortalController, IApplicationStatusInfo, IPortalGroupController, int, string)

Declaration
public static ProfilePropertyDefinition GetPropertyDefinitionByName(IHostSettings hostSettings, IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, int portalId, string name)
Parameters
Type Name Description
IHostSettings hostSettings
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
int portalId
string name
Returns
Type Description
ProfilePropertyDefinition

GetPropertyDefinitionByName(IHostSettings, int, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with IPortalController. Scheduled for removal in v12.0.0.")]
public static ProfilePropertyDefinition GetPropertyDefinitionByName(IHostSettings hostSettings, int portalId, string name)
Parameters
Type Name Description
IHostSettings hostSettings
int portalId
string name
Returns
Type Description
ProfilePropertyDefinition

GetPropertyDefinitionByName(int, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.0.2. Use overload taking IHostSettings. Scheduled for removal in v12.0.0.")]
public static ProfilePropertyDefinition GetPropertyDefinitionByName(int portalId, string name)
Parameters
Type Name Description
int portalId
string name
Returns
Type Description
ProfilePropertyDefinition

GetPropertyDefinitionsByCategory(IHostSettings, IPortalController, IApplicationStatusInfo, IPortalGroupController, int, string)

Declaration
public static ProfilePropertyDefinitionCollection GetPropertyDefinitionsByCategory(IHostSettings hostSettings, IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, int portalId, string category)
Parameters
Type Name Description
IHostSettings hostSettings
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
int portalId
string category
Returns
Type Description
ProfilePropertyDefinitionCollection

GetPropertyDefinitionsByCategory(IHostSettings, int, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with IPortalController. Scheduled for removal in v12.0.0.")]
public static ProfilePropertyDefinitionCollection GetPropertyDefinitionsByCategory(IHostSettings hostSettings, int portalId, string category)
Parameters
Type Name Description
IHostSettings hostSettings
int portalId
string category
Returns
Type Description
ProfilePropertyDefinitionCollection

GetPropertyDefinitionsByCategory(int, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.0.2. Use overload taking IHostSettings. Scheduled for removal in v12.0.0.")]
public static ProfilePropertyDefinitionCollection GetPropertyDefinitionsByCategory(int portalId, string category)
Parameters
Type Name Description
int portalId
string category
Returns
Type Description
ProfilePropertyDefinitionCollection

GetPropertyDefinitionsByPortal(IHostSettings, IPortalController, IApplicationStatusInfo, IPortalGroupController, int)

Declaration
public static ProfilePropertyDefinitionCollection GetPropertyDefinitionsByPortal(IHostSettings hostSettings, IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, int portalId)
Parameters
Type Name Description
IHostSettings hostSettings
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
int portalId
Returns
Type Description
ProfilePropertyDefinitionCollection

GetPropertyDefinitionsByPortal(IHostSettings, IPortalController, IApplicationStatusInfo, IPortalGroupController, int, bool)

Declaration
public static ProfilePropertyDefinitionCollection GetPropertyDefinitionsByPortal(IHostSettings hostSettings, IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, int portalId, bool clone)
Parameters
Type Name Description
IHostSettings hostSettings
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
int portalId
bool clone
Returns
Type Description
ProfilePropertyDefinitionCollection

GetPropertyDefinitionsByPortal(IHostSettings, IPortalController, IApplicationStatusInfo, IPortalGroupController, int, bool, bool)

Declaration
public static ProfilePropertyDefinitionCollection GetPropertyDefinitionsByPortal(IHostSettings hostSettings, IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, int portalId, bool clone, bool includeDeleted)
Parameters
Type Name Description
IHostSettings hostSettings
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
int portalId
bool clone
bool includeDeleted
Returns
Type Description
ProfilePropertyDefinitionCollection

GetPropertyDefinitionsByPortal(IHostSettings, int, bool, bool)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with IPortalController. Scheduled for removal in v12.0.0.")]
public static ProfilePropertyDefinitionCollection GetPropertyDefinitionsByPortal(IHostSettings hostSettings, int portalId, bool clone, bool includeDeleted)
Parameters
Type Name Description
IHostSettings hostSettings
int portalId
bool clone
bool includeDeleted
Returns
Type Description
ProfilePropertyDefinitionCollection

GetPropertyDefinitionsByPortal(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with IHostSettings. Scheduled for removal in v12.0.0.")]
public static ProfilePropertyDefinitionCollection GetPropertyDefinitionsByPortal(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
ProfilePropertyDefinitionCollection

GetPropertyDefinitionsByPortal(int, bool)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with IHostSettings. Scheduled for removal in v12.0.0.")]
public static ProfilePropertyDefinitionCollection GetPropertyDefinitionsByPortal(int portalId, bool clone)
Parameters
Type Name Description
int portalId
bool clone
Returns
Type Description
ProfilePropertyDefinitionCollection

GetPropertyDefinitionsByPortal(int, bool, bool)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.0.2. Use overload taking IHostSettings. Scheduled for removal in v12.0.0.")]
public static ProfilePropertyDefinitionCollection GetPropertyDefinitionsByPortal(int portalId, bool clone, bool includeDeleted)
Parameters
Type Name Description
int portalId
bool clone
bool includeDeleted
Returns
Type Description
ProfilePropertyDefinitionCollection

GetUserProfile(IPortalController, IApplicationStatusInfo, IPortalGroupController, ref UserInfo)

Declaration
public static void GetUserProfile(IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, ref UserInfo user)
Parameters
Type Name Description
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
UserInfo user

GetUserProfile(ref UserInfo)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with IPortalController. Scheduled for removal in v12.0.0.")]
public static void GetUserProfile(ref UserInfo user)
Parameters
Type Name Description
UserInfo user

SearchProfilePropertyValues(ListController, IHostSettings, IPortalController, IApplicationStatusInfo, IPortalGroupController, int, string, string)

Declaration
public static List<string> SearchProfilePropertyValues(ListController listController, IHostSettings hostSettings, IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, int portalId, string propertyName, string searchString)
Parameters
Type Name Description
ListController listController
IHostSettings hostSettings
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
int portalId
string propertyName
string searchString
Returns
Type Description
List<string>

SearchProfilePropertyValues(int, string, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with ListController. Scheduled for removal in v12.0.0.")]
public static List<string> SearchProfilePropertyValues(int portalId, string propertyName, string searchString)
Parameters
Type Name Description
int portalId
string propertyName
string searchString
Returns
Type Description
List<string>

UpdatePropertyDefinition(IEventLogger, IPortalController, IApplicationStatusInfo, IPortalGroupController, ProfilePropertyDefinition)

Declaration
public static void UpdatePropertyDefinition(IEventLogger eventLogger, IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, ProfilePropertyDefinition definition)
Parameters
Type Name Description
IEventLogger eventLogger
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
ProfilePropertyDefinition definition

UpdatePropertyDefinition(IEventLogger, ProfilePropertyDefinition)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with IPortalController. Scheduled for removal in v12.0.0.")]
public static void UpdatePropertyDefinition(IEventLogger eventLogger, ProfilePropertyDefinition definition)
Parameters
Type Name Description
IEventLogger eventLogger
ProfilePropertyDefinition definition

UpdatePropertyDefinition(ProfilePropertyDefinition)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.2. Use overload taking IEventLogger. Scheduled for removal in v12.0.0.")]
public static void UpdatePropertyDefinition(ProfilePropertyDefinition definition)
Parameters
Type Name Description
ProfilePropertyDefinition definition

UpdateUserProfile(IPortalController, IApplicationStatusInfo, IPortalGroupController, IEventLogger, UserInfo, ProfilePropertyDefinitionCollection)

Declaration
public static UserInfo UpdateUserProfile(IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, IEventLogger eventLogger, UserInfo user, ProfilePropertyDefinitionCollection profileProperties)
Parameters
Type Name Description
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
IEventLogger eventLogger
UserInfo user
ProfilePropertyDefinitionCollection profileProperties
Returns
Type Description
UserInfo

UpdateUserProfile(IPortalController, IApplicationStatusInfo, IPortalGroupController, UserInfo)

Declaration
public static void UpdateUserProfile(IPortalController portalController, IApplicationStatusInfo appStatus, IPortalGroupController portalGroupController, UserInfo user)
Parameters
Type Name Description
IPortalController portalController
IApplicationStatusInfo appStatus
IPortalGroupController portalGroupController
UserInfo user

UpdateUserProfile(UserInfo)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with IPortalController. Scheduled for removal in v12.0.0.")]
public static void UpdateUserProfile(UserInfo user)
Parameters
Type Name Description
UserInfo user

UpdateUserProfile(UserInfo, ProfilePropertyDefinitionCollection)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with IPortalController. Scheduled for removal in v12.0.0.")]
public static UserInfo UpdateUserProfile(UserInfo user, ProfilePropertyDefinitionCollection profileProperties)
Parameters
Type Name Description
UserInfo user
ProfilePropertyDefinitionCollection profileProperties
Returns
Type Description
UserInfo

ValidateProfile(ListController, int, UserProfile)

Declaration
public static bool ValidateProfile(ListController listController, int portalId, UserProfile profile)
Parameters
Type Name Description
ListController listController
int portalId
UserProfile profile
Returns
Type Description
bool

ValidateProfile(int, UserProfile)

Declaration
[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with ListController. Scheduled for removal in v12.0.0.")]
public static bool ValidateProfile(int portalId, UserProfile objProfile)
Parameters
Type Name Description
int portalId
UserProfile objProfile
Returns
Type Description
bool

Extension Methods