Class DataProvider

Inheritance
object
DataProvider
SqlDataProvider
Inherited Members
Namespace: DotNetNuke.Data
Assembly: DotNetNuke.dll
Syntax
public abstract class DataProvider

Constructors

DataProvider()

Declaration
protected DataProvider()

Properties

ConnectionString

Declaration
public virtual string ConnectionString { get; }
Property Value
Type Description
string

DatabaseOwner

Declaration
public virtual string DatabaseOwner { get; }
Property Value
Type Description
string

DefaultProviderName

Declaration
public string DefaultProviderName { get; }
Property Value
Type Description
string

IsConnectionValid

Declaration
public abstract bool IsConnectionValid { get; }
Property Value
Type Description
bool

ObjectQualifier

Declaration
public virtual string ObjectQualifier { get; }
Property Value
Type Description
string

ProviderName

Declaration
public virtual string ProviderName { get; }
Property Value
Type Description
string

ProviderPath

Declaration
public virtual string ProviderPath { get; }
Property Value
Type Description
string

Settings

Declaration
public abstract Dictionary<string, string> Settings { get; }
Property Value
Type Description
Dictionary<string, string>

UpgradeConnectionString

Declaration
public virtual string UpgradeConnectionString { get; }
Property Value
Type Description
string

Methods

AddAuthentication(int, string, bool, string, string, string, int)

Declaration
public virtual int AddAuthentication(int packageID, string authenticationType, bool isEnabled, string settingsControlSrc, string loginControlSrc, string logoffControlSrc, int createdByUserID)
Parameters
Type Name Description
int packageID
string authenticationType
bool isEnabled
string settingsControlSrc
string loginControlSrc
string logoffControlSrc
int createdByUserID
Returns
Type Description
int

AddContentWorkflow(int, string, string, bool, bool, bool, bool)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use IWorkflowEngine. Scheduled for removal in v10.0.0.")]
public virtual int AddContentWorkflow(int portalId, string workflowName, string description, bool isDeleted, bool startAfterCreating, bool startAfterEditing, bool dispositionEnabled)
Parameters
Type Name Description
int portalId
string workflowName
string description
bool isDeleted
bool startAfterCreating
bool startAfterEditing
bool dispositionEnabled
Returns
Type Description
int

AddContentWorkflowLog(string, string, int, int, int)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use instead IWorkflowLogger.AddWorkflowLog. Scheduled for removal in v10.0.0.")]
public virtual int AddContentWorkflowLog(string action, string comment, int user, int workflowId, int contentItemId)
Parameters
Type Name Description
string action
string comment
int user
int workflowId
int contentItemId
Returns
Type Description
int

AddContentWorkflowSource(int, string, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use IWorkflowEngine. Scheduled for removal in v10.0.0.")]
public virtual int AddContentWorkflowSource(int workflowId, string sourceName, string sourceType)
Parameters
Type Name Description
int workflowId
string sourceName
string sourceType
Returns
Type Description
int

AddContentWorkflowState(int, string, int, bool, bool, bool, bool, string, string, string, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use IWorkflowEngine. Scheduled for removal in v10.0.0.")]
public virtual int AddContentWorkflowState(int workflowId, string stateName, int order, bool isActive, bool sendEmail, bool sendMessage, bool isDisposalState, string onCompleteMessageSubject, string onCompleteMessageBody, string onDiscardMessageSubject, string onDiscardMessageBody)
Parameters
Type Name Description
int workflowId
string stateName
int order
bool isActive
bool sendEmail
bool sendMessage
bool isDisposalState
string onCompleteMessageSubject
string onCompleteMessageBody
string onDiscardMessageSubject
string onDiscardMessageBody
Returns
Type Description
int

AddContentWorkflowStatePermission(int, int, int, bool, int, int)

Declaration
public virtual int AddContentWorkflowStatePermission(int stateId, int permissionId, int roleId, bool allowAccess, int userId, int createdByUserId)
Parameters
Type Name Description
int stateId
int permissionId
int roleId
bool allowAccess
int userId
int createdByUserId
Returns
Type Description
int

AddDefaultFolderTypes(int)

Declaration
public virtual void AddDefaultFolderTypes(int portalID)
Parameters
Type Name Description
int portalID

AddDesktopModule(int, string, string, string, string, string, bool, bool, string, int, int, string, string, string, int, int, string, string)

Declaration
public virtual int AddDesktopModule(int packageID, string moduleName, string folderName, string friendlyName, string description, string version, bool isPremium, bool isAdmin, string businessControllerClass, int supportedFeatures, int shareable, string compatibleVersions, string dependencies, string permissions, int contentItemId, int createdByUserID, string adminPage, string hostPage)
Parameters
Type Name Description
int packageID
string moduleName
string folderName
string friendlyName
string description
string version
bool isPremium
bool isAdmin
string businessControllerClass
int supportedFeatures
int shareable
string compatibleVersions
string dependencies
string permissions
int contentItemId
int createdByUserID
string adminPage
string hostPage
Returns
Type Description
int

AddDesktopModulePermission(int, int, int, bool, int, int)

Declaration
public virtual int AddDesktopModulePermission(int portalDesktopModuleID, int permissionID, int roleID, bool allowAccess, int userID, int createdByUserID)
Parameters
Type Name Description
int portalDesktopModuleID
int permissionID
int roleID
bool allowAccess
int userID
int createdByUserID
Returns
Type Description
int

AddEventMessage(string, int, string, string, string, string, string, string, string, DateTime, DateTime, string)

Declaration
public virtual int AddEventMessage(string eventName, int priority, string processorType, string processorCommand, string body, string sender, string subscriberId, string authorizedRoles, string exceptionMessage, DateTime sentDate, DateTime expirationDate, string attributes)
Parameters
Type Name Description
string eventName
int priority
string processorType
string processorCommand
string body
string sender
string subscriberId
string authorizedRoles
string exceptionMessage
DateTime sentDate
DateTime expirationDate
string attributes
Returns
Type Description
int

AddExtensionUrlProvider(int, int, string, string, string, bool, bool, bool, bool)

Declaration
public virtual int AddExtensionUrlProvider(int providerId, int desktopModuleId, string providerName, string providerType, string settingsControlSrc, bool isActive, bool rewriteAllUrls, bool redirectAllUrls, bool replaceAllUrls)
Parameters
Type Name Description
int providerId
int desktopModuleId
string providerName
string providerType
string settingsControlSrc
bool isActive
bool rewriteAllUrls
bool redirectAllUrls
bool replaceAllUrls
Returns
Type Description
int

AddFile(int, Guid, Guid, string, string, long, int, int, string, string, int, int, string, DateTime, string, string, DateTime, DateTime, bool, int)

Declaration
public virtual int AddFile(int portalId, Guid uniqueId, Guid versionGuid, string fileName, string extension, long size, int width, int height, string contentType, string folder, int folderId, int createdByUserID, string hash, DateTime lastModificationTime, string title, string description, DateTime startDate, DateTime endDate, bool enablePublishPeriod, int contentItemId)
Parameters
Type Name Description
int portalId
Guid uniqueId
Guid versionGuid
string fileName
string extension
long size
int width
int height
string contentType
string folder
int folderId
int createdByUserID
string hash
DateTime lastModificationTime
string title
string description
DateTime startDate
DateTime endDate
bool enablePublishPeriod
int contentItemId
Returns
Type Description
int

AddFileVersion(int, Guid, Guid, string, string, long, int, int, string, string, int, int, string, DateTime, string, bool, DateTime, DateTime, int, bool, byte[])

Declaration
public virtual int AddFileVersion(int fileId, Guid uniqueId, Guid versionGuid, string fileName, string extension, long size, int width, int height, string contentType, string folder, int folderId, int userId, string hash, DateTime lastModificationTime, string title, bool enablePublishPeriod, DateTime startDate, DateTime endDate, int contentItemID, bool published, byte[] content = null)
Parameters
Type Name Description
int fileId
Guid uniqueId
Guid versionGuid
string fileName
string extension
long size
int width
int height
string contentType
string folder
int folderId
int userId
string hash
DateTime lastModificationTime
string title
bool enablePublishPeriod
DateTime startDate
DateTime endDate
int contentItemID
bool published
byte[] content
Returns
Type Description
int

AddFolder(int, Guid, Guid, string, string, int, bool, bool, DateTime, int, int, bool, int, int)

Declaration
public virtual int AddFolder(int portalId, Guid uniqueId, Guid versionGuid, string folderPath, string mappedPath, int storageLocation, bool isProtected, bool isCached, DateTime lastUpdated, int createdByUserId, int folderMappingId, bool isVersioned, int workflowId, int parentId)
Parameters
Type Name Description
int portalId
Guid uniqueId
Guid versionGuid
string folderPath
string mappedPath
int storageLocation
bool isProtected
bool isCached
DateTime lastUpdated
int createdByUserId
int folderMappingId
bool isVersioned
int workflowId
int parentId
Returns
Type Description
int

AddFolderMapping(int, string, string, int)

Declaration
public virtual int AddFolderMapping(int portalID, string mappingName, string folderProviderType, int createdByUserID)
Parameters
Type Name Description
int portalID
string mappingName
string folderProviderType
int createdByUserID
Returns
Type Description
int

AddFolderMappingSetting(int, string, string, int)

Declaration
public virtual void AddFolderMappingSetting(int folderMappingID, string settingName, string settingValue, int createdByUserID)
Parameters
Type Name Description
int folderMappingID
string settingName
string settingValue
int createdByUserID

AddFolderPermission(int, int, int, bool, int, int)

Declaration
public virtual int AddFolderPermission(int folderId, int permissionId, int roleID, bool allowAccess, int userId, int createdByUserID)
Parameters
Type Name Description
int folderId
int permissionId
int roleID
bool allowAccess
int userId
int createdByUserID
Returns
Type Description
int

AddIPFilter(string, string, int, int)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.11.1. Use the overload that takes a notes string. Scheduled for removal in v11.0.0.")]
public virtual int AddIPFilter(string ipAddress, string subnetMask, int ruleType, int createdByUserId)
Parameters
Type Name Description
string ipAddress
string subnetMask
int ruleType
int createdByUserId
Returns
Type Description
int

AddIPFilter(string, string, int, int, string)

Declaration
public virtual int AddIPFilter(string ipAddress, string subnetMask, int ruleType, int createdByUserId, string notes)
Parameters
Type Name Description
string ipAddress
string subnetMask
int ruleType
int createdByUserId
string notes
Returns
Type Description
int

AddLanguage(string, string, string, int)

Declaration
public virtual int AddLanguage(string cultureCode, string cultureName, string fallbackCulture, int createdByUserID)
Parameters
Type Name Description
string cultureCode
string cultureName
string fallbackCulture
int createdByUserID
Returns
Type Description
int

AddLanguagePack(int, int, int, int)

Declaration
public virtual int AddLanguagePack(int packageID, int languageID, int dependentPackageID, int createdByUserID)
Parameters
Type Name Description
int packageID
int languageID
int dependentPackageID
int createdByUserID
Returns
Type Description
int

AddListEntry(string, string, string, int, int, bool, int, string, int, bool, int)

Declaration
public virtual int AddListEntry(string listName, string value, string text, int parentID, int level, bool enableSortOrder, int definitionID, string description, int portalID, bool systemList, int createdByUserID)
Parameters
Type Name Description
string listName
string value
string text
int parentID
int level
bool enableSortOrder
int definitionID
string description
int portalID
bool systemList
int createdByUserID
Returns
Type Description
int

AddLog(string, string, int, string, int, string, DateTime, string, string, int, ExceptionInfo, bool)

Declaration
public virtual void AddLog(string logGUID, string logTypeKey, int logUserID, string logUserName, int logPortalID, string logPortalName, DateTime logCreateDate, string logServerName, string logProperties, int logConfigID, ExceptionInfo exception, bool notificationActive)
Parameters
Type Name Description
string logGUID
string logTypeKey
int logUserID
string logUserName
int logPortalID
string logPortalName
DateTime logCreateDate
string logServerName
string logProperties
int logConfigID
ExceptionInfo exception
bool notificationActive

AddLogType(string, string, string, string, string)

Declaration
public virtual void AddLogType(string logTypeKey, string logTypeFriendlyName, string logTypeDescription, string logTypeCSSClass, string logTypeOwner)
Parameters
Type Name Description
string logTypeKey
string logTypeFriendlyName
string logTypeDescription
string logTypeCSSClass
string logTypeOwner

AddLogTypeConfigInfo(bool, string, string, int, bool, int, int, int, string, string)

Declaration
public virtual void AddLogTypeConfigInfo(bool loggingIsActive, string logTypeKey, string logTypePortalID, int keepMostRecent, bool emailNotificationIsActive, int threshold, int notificationThresholdTime, int notificationThresholdTimeType, string mailFromAddress, string mailToAddress)
Parameters
Type Name Description
bool loggingIsActive
string logTypeKey
string logTypePortalID
int keepMostRecent
bool emailNotificationIsActive
int threshold
int notificationThresholdTime
int notificationThresholdTimeType
string mailFromAddress
string mailToAddress

AddModule(int, int, int, bool, DateTime, DateTime, bool, bool, bool, bool, int)

Declaration
public virtual int AddModule(int contentItemId, int portalId, int moduleDefId, bool allTabs, DateTime startDate, DateTime endDate, bool inheritViewPermissions, bool isShareable, bool isShareableViewOnly, bool isDeleted, int createdByUserID)
Parameters
Type Name Description
int contentItemId
int portalId
int moduleDefId
bool allTabs
DateTime startDate
DateTime endDate
bool inheritViewPermissions
bool isShareable
bool isShareableViewOnly
bool isDeleted
int createdByUserID
Returns
Type Description
int

AddModuleControl(int, string, string, string, string, int, int, string, bool, bool, int)

Declaration
public virtual int AddModuleControl(int moduleDefId, string controlKey, string controlTitle, string controlSrc, string iconFile, int controlType, int viewOrder, string helpUrl, bool supportsPartialRendering, bool supportsPopUps, int createdByUserID)
Parameters
Type Name Description
int moduleDefId
string controlKey
string controlTitle
string controlSrc
string iconFile
int controlType
int viewOrder
string helpUrl
bool supportsPartialRendering
bool supportsPopUps
int createdByUserID
Returns
Type Description
int

AddModuleDefinition(int, string, string, int, int)

Declaration
public virtual int AddModuleDefinition(int desktopModuleId, string friendlyName, string definitionName, int defaultCacheTime, int createdByUserID)
Parameters
Type Name Description
int desktopModuleId
string friendlyName
string definitionName
int defaultCacheTime
int createdByUserID
Returns
Type Description
int

AddModulePermission(int, int, int, int, bool, int, int)

Declaration
public virtual int AddModulePermission(int moduleId, int portalId, int permissionId, int roleId, bool allowAccess, int userId, int createdByUserId)
Parameters
Type Name Description
int moduleId
int portalId
int permissionId
int roleId
bool allowAccess
int userId
int createdByUserId
Returns
Type Description
int

AddOutputCacheItem(int, string, string, DateTime)

Declaration
public virtual void AddOutputCacheItem(int itemId, string cacheKey, string output, DateTime expiration)
Parameters
Type Name Description
int itemId
string cacheKey
string output
DateTime expiration

AddPackage(int, string, string, string, string, string, string, string, string, string, string, string, string, bool, int, string, string)

Declaration
public virtual int AddPackage(int portalID, string name, string friendlyName, string description, string type, string version, string license, string manifest, string owner, string organization, string url, string email, string releaseNotes, bool isSystemPackage, int createdByUserID, string folderName, string iconFile)
Parameters
Type Name Description
int portalID
string name
string friendlyName
string description
string type
string version
string license
string manifest
string owner
string organization
string url
string email
string releaseNotes
bool isSystemPackage
int createdByUserID
string folderName
string iconFile
Returns
Type Description
int

AddPasswordHistory(int, string, string, int)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.2.0. Please use the overload that takes daysRetained. Scheduled for removal in v11.0.0.")]
public virtual void AddPasswordHistory(int userId, string password, string passwordHistory, int retained)
Parameters
Type Name Description
int userId
string password
string passwordHistory
int retained

AddPasswordHistory(int, string, string, int, int)

Declaration
public virtual void AddPasswordHistory(int userId, string password, string passwordHistory, int passwordsRetained, int daysRetained)
Parameters
Type Name Description
int userId
string password
string passwordHistory
int passwordsRetained
int daysRetained

AddPermission(string, int, string, string, int)

Declaration
public virtual int AddPermission(string permissionCode, int moduleDefID, string permissionKey, string permissionName, int createdByUserID)
Parameters
Type Name Description
string permissionCode
int moduleDefID
string permissionKey
string permissionName
int createdByUserID
Returns
Type Description
int

AddPortalAlias(int, string, string, string, string, bool, int)

Declaration
public virtual int AddPortalAlias(int portalID, string hTTPAlias, string cultureCode, string skin, string browserType, bool isPrimary, int createdByUserID)
Parameters
Type Name Description
int portalID
string hTTPAlias
string cultureCode
string skin
string browserType
bool isPrimary
int createdByUserID
Returns
Type Description
int

AddPortalDesktopModule(int, int, int)

Declaration
public virtual int AddPortalDesktopModule(int portalId, int desktopModuleId, int createdByUserID)
Parameters
Type Name Description
int portalId
int desktopModuleId
int createdByUserID
Returns
Type Description
int

AddPortalLanguage(int, int, bool, int)

Declaration
public virtual int AddPortalLanguage(int portalID, int languageID, bool isPublished, int createdByUserID)
Parameters
Type Name Description
int portalID
int languageID
bool isPublished
int createdByUserID
Returns
Type Description
int

AddPortalPermission(int, int, int, bool, int, int)

Declaration
public virtual int AddPortalPermission(int portalId, int permissionId, int roleId, bool allowAccess, int userId, int createdByUserId)
Parameters
Type Name Description
int portalId
int permissionId
int roleId
bool allowAccess
int userId
int createdByUserId
Returns
Type Description
int

AddProfile(int, int)

Declaration
public virtual void AddProfile(int userId, int portalId)
Parameters
Type Name Description
int userId
int portalId

AddPropertyDefinition(int, int, int, string, string, string, bool, bool, string, int, bool, int, int, int)

Declaration
public virtual int AddPropertyDefinition(int portalId, int moduleDefId, int dataType, string defaultValue, string propertyCategory, string propertyName, bool readOnly, bool required, string validationExpression, int viewOrder, bool visible, int length, int defaultVisibility, int createdByUserId)
Parameters
Type Name Description
int portalId
int moduleDefId
int dataType
string defaultValue
string propertyCategory
string propertyName
bool readOnly
bool required
string validationExpression
int viewOrder
bool visible
int length
int defaultVisibility
int createdByUserId
Returns
Type Description
int

AddRedirectMessage(int, int, string)

Declaration
public virtual Guid AddRedirectMessage(int userId, int tabId, string text)
Parameters
Type Name Description
int userId
int tabId
string text
Returns
Type Description
Guid

AddRole(int, int, string, string, float, string, string, float, int, string, bool, bool, string, string, int, int, int, bool)

Declaration
public virtual int AddRole(int portalId, int roleGroupId, string roleName, string description, float serviceFee, string billingPeriod, string billingFrequency, float trialFee, int trialPeriod, string trialFrequency, bool isPublic, bool autoAssignment, string rsvpCode, string iconFile, int createdByUserID, int status, int securityMode, bool isSystemRole)
Parameters
Type Name Description
int portalId
int roleGroupId
string roleName
string description
float serviceFee
string billingPeriod
string billingFrequency
float trialFee
int trialPeriod
string trialFrequency
bool isPublic
bool autoAssignment
string rsvpCode
string iconFile
int createdByUserID
int status
int securityMode
bool isSystemRole
Returns
Type Description
int

AddRoleGroup(int, string, string, int)

Declaration
public virtual int AddRoleGroup(int portalId, string groupName, string description, int createdByUserID)
Parameters
Type Name Description
int portalId
string groupName
string description
int createdByUserID
Returns
Type Description
int

AddSchedule(string, int, string, int, string, int, string, bool, bool, string, string, int, string, DateTime)

Declaration
public virtual int AddSchedule(string typeFullName, int timeLapse, string timeLapseMeasurement, int retryTimeLapse, string retryTimeLapseMeasurement, int retainHistoryNum, string attachToEvent, bool catchUpEnabled, bool enabled, string objectDependencies, string servers, int createdByUserID, string friendlyName, DateTime scheduleStartDate)
Parameters
Type Name Description
string typeFullName
int timeLapse
string timeLapseMeasurement
int retryTimeLapse
string retryTimeLapseMeasurement
int retainHistoryNum
string attachToEvent
bool catchUpEnabled
bool enabled
string objectDependencies
string servers
int createdByUserID
string friendlyName
DateTime scheduleStartDate
Returns
Type Description
int

AddScheduleHistory(int, DateTime, string)

Declaration
public virtual int AddScheduleHistory(int scheduleID, DateTime startDate, string server)
Parameters
Type Name Description
int scheduleID
DateTime startDate
string server
Returns
Type Description
int

AddScheduleItemSetting(int, string, string)

Declaration
public virtual void AddScheduleItemSetting(int scheduleID, string name, string value)
Parameters
Type Name Description
int scheduleID
string name
string value

AddSearchDeletedItems(SearchDocumentToDelete)

Declaration
public void AddSearchDeletedItems(SearchDocumentToDelete deletedIDocument)
Parameters
Type Name Description
SearchDocumentToDelete deletedIDocument

AddSearchStopWords(string, int, int, string)

Declaration
public virtual int AddSearchStopWords(string stopWords, int createdByUserId, int portalId, string cultureCode)
Parameters
Type Name Description
string stopWords
int createdByUserId
int portalId
string cultureCode
Returns
Type Description
int

AddSkin(int, string)

Declaration
public virtual int AddSkin(int skinPackageID, string skinSrc)
Parameters
Type Name Description
int skinPackageID
string skinSrc
Returns
Type Description
int

AddSkinControl(int, string, string, bool, int)

Declaration
public virtual int AddSkinControl(int packageID, string controlKey, string controlSrc, bool supportsPartialRendering, int createdByUserID)
Parameters
Type Name Description
int packageID
string controlKey
string controlSrc
bool supportsPartialRendering
int createdByUserID
Returns
Type Description
int

AddSkinPackage(int, int, string, string, int)

Declaration
public virtual int AddSkinPackage(int packageID, int portalID, string skinName, string skinType, int createdByUserId)
Parameters
Type Name Description
int packageID
int portalID
string skinName
string skinType
int createdByUserId
Returns
Type Description
int

AddSynonymsGroup(string, int, int, string)

Declaration
public virtual int AddSynonymsGroup(string synonymsTags, int createdByUserId, int portalId, string cultureCode)
Parameters
Type Name Description
string synonymsTags
int createdByUserId
int portalId
string cultureCode
Returns
Type Description
int

AddTabAfter(TabInfo, int, int)

Declaration
public virtual int AddTabAfter(TabInfo tab, int afterTabId, int createdByUserID)
Parameters
Type Name Description
TabInfo tab
int afterTabId
int createdByUserID
Returns
Type Description
int

AddTabBefore(TabInfo, int, int)

Declaration
public virtual int AddTabBefore(TabInfo tab, int beforeTabId, int createdByUserID)
Parameters
Type Name Description
TabInfo tab
int beforeTabId
int createdByUserID
Returns
Type Description
int

AddTabModule(int, int, string, string, string, int, string, int, string, string, string, string, string, int, string, bool, bool, bool, bool, string, DateTime, int, Guid, Guid, Guid, Guid, string, int)

Declaration
public virtual void AddTabModule(int tabId, int moduleId, string moduleTitle, string header, string footer, int moduleOrder, string paneName, int cacheTime, string cacheMethod, string alignment, string color, string border, string iconFile, int visibility, string containerSrc, bool displayTitle, bool displayPrint, bool displaySyndicate, bool isWebSlice, string webSliceTitle, DateTime webSliceExpiryDate, int webSliceTTL, Guid uniqueId, Guid versionGuid, Guid defaultLanguageGuid, Guid localizedVersionGuid, string cultureCode, int createdByUserID)
Parameters
Type Name Description
int tabId
int moduleId
string moduleTitle
string header
string footer
int moduleOrder
string paneName
int cacheTime
string cacheMethod
string alignment
string color
string border
string iconFile
int visibility
string containerSrc
bool displayTitle
bool displayPrint
bool displaySyndicate
bool isWebSlice
string webSliceTitle
DateTime webSliceExpiryDate
int webSliceTTL
Guid uniqueId
Guid versionGuid
Guid defaultLanguageGuid
Guid localizedVersionGuid
string cultureCode
int createdByUserID

AddTabPermission(int, int, int, bool, int, int)

Declaration
public virtual int AddTabPermission(int tabId, int permissionId, int roleID, bool allowAccess, int userId, int createdByUserID)
Parameters
Type Name Description
int tabId
int permissionId
int roleID
bool allowAccess
int userId
int createdByUserID
Returns
Type Description
int

AddTabToEnd(TabInfo, int)

Declaration
public virtual int AddTabToEnd(TabInfo tab, int createdByUserID)
Parameters
Type Name Description
TabInfo tab
int createdByUserID
Returns
Type Description
int

AddUrl(int, string)

Declaration
public virtual void AddUrl(int portalID, string url)
Parameters
Type Name Description
int portalID
string url

AddUrlLog(int, int)

Declaration
public virtual void AddUrlLog(int urlTrackingID, int userID)
Parameters
Type Name Description
int urlTrackingID
int userID

AddUrlTracking(int, string, string, bool, bool, int, bool)

Declaration
public virtual void AddUrlTracking(int portalID, string url, string urlType, bool logActivity, bool trackClicks, int moduleID, bool newWindow)
Parameters
Type Name Description
int portalID
string url
string urlType
bool logActivity
bool trackClicks
int moduleID
bool newWindow

AddUser(int, string, string, string, int, bool, string, string, bool, bool, int)

Declaration
public virtual int AddUser(int portalID, string username, string firstName, string lastName, int affiliateId, bool isSuperUser, string email, string displayName, bool updatePassword, bool isApproved, int createdByUserID)
Parameters
Type Name Description
int portalID
string username
string firstName
string lastName
int affiliateId
bool isSuperUser
string email
string displayName
bool updatePassword
bool isApproved
int createdByUserID
Returns
Type Description
int

AddUserAuthentication(int, string, string, int)

Declaration
public virtual int AddUserAuthentication(int userID, string authenticationType, string authenticationToken, int createdByUserID)
Parameters
Type Name Description
int userID
string authenticationType
string authenticationToken
int createdByUserID
Returns
Type Description
int

AddUserPortal(int, int)

Declaration
public virtual void AddUserPortal(int portalId, int userId)
Parameters
Type Name Description
int portalId
int userId

AddUserRole(int, int, int, int, bool, DateTime, DateTime, int)

Declaration
public virtual int AddUserRole(int portalId, int userId, int roleId, int status, bool isOwner, DateTime effectiveDate, DateTime expiryDate, int createdByUserID)
Parameters
Type Name Description
int portalId
int userId
int roleId
int status
bool isOwner
DateTime effectiveDate
DateTime expiryDate
int createdByUserID
Returns
Type Description
int

BulkInsert(string, string, DataTable)

Declaration
public abstract void BulkInsert(string procedureName, string tableParameterName, DataTable dataTable)
Parameters
Type Name Description
string procedureName
string tableParameterName
DataTable dataTable

BulkInsert(string, string, DataTable, Dictionary<string, object>)

Declaration
public abstract void BulkInsert(string procedureName, string tableParameterName, DataTable dataTable, Dictionary<string, object> commandParameters)
Parameters
Type Name Description
string procedureName
string tableParameterName
DataTable dataTable
Dictionary<string, object> commandParameters

BulkInsert(string, string, DataTable, int)

Declaration
public abstract void BulkInsert(string procedureName, string tableParameterName, DataTable dataTable, int timeoutSec)
Parameters
Type Name Description
string procedureName
string tableParameterName
DataTable dataTable
int timeoutSec

BulkInsert(string, string, DataTable, int, Dictionary<string, object>)

Declaration
public abstract void BulkInsert(string procedureName, string tableParameterName, DataTable dataTable, int timeoutSec, Dictionary<string, object> commandParameters)
Parameters
Type Name Description
string procedureName
string tableParameterName
DataTable dataTable
int timeoutSec
Dictionary<string, object> commandParameters

CanDeleteSkin(string, string)

Declaration
public virtual bool CanDeleteSkin(string skinType, string skinFoldername)
Parameters
Type Name Description
string skinType
string skinFoldername
Returns
Type Description
bool

ChangeUsername(int, string)

Declaration
public virtual void ChangeUsername(int userId, string newUsername)
Parameters
Type Name Description
int userId
string newUsername

ClearFileContent(int)

Declaration
public virtual void ClearFileContent(int fileId)
Parameters
Type Name Description
int fileId

ClearLog()

Declaration
public virtual void ClearLog()

CommitTransaction(DbTransaction)

Declaration
public virtual void CommitTransaction(DbTransaction transaction)
Parameters
Type Name Description
DbTransaction transaction

ConvertTabToNeutralLanguage(int, int, string)

Declaration
public virtual void ConvertTabToNeutralLanguage(int portalId, int tabId, string cultureCode)
Parameters
Type Name Description
int portalId
int tabId
string cultureCode

CountLegacyFiles()

Declaration
public virtual int CountLegacyFiles()
Returns
Type Description
int

CreatePortal(string, string, DateTime, double, double, int, int, int, string, int)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Please use CreatePortal overload with cultureCode. Scheduled for removal in v10.0.0.")]
public virtual int CreatePortal(string portalname, string currency, DateTime expiryDate, double hostFee, double hostSpace, int pageQuota, int userQuota, int siteLogHistory, string homeDirectory, int createdByUserID)
Parameters
Type Name Description
string portalname
string currency
DateTime expiryDate
double hostFee
double hostSpace
int pageQuota
int userQuota
int siteLogHistory
string homeDirectory
int createdByUserID
Returns
Type Description
int

CreatePortal(string, string, DateTime, double, double, int, int, int, string, string, int)

Declaration
public virtual int CreatePortal(string portalname, string currency, DateTime expiryDate, double hostFee, double hostSpace, int pageQuota, int userQuota, int siteLogHistory, string homeDirectory, string cultureCode, int createdByUserID)
Parameters
Type Name Description
string portalname
string currency
DateTime expiryDate
double hostFee
double hostSpace
int pageQuota
int userQuota
int siteLogHistory
string homeDirectory
string cultureCode
int createdByUserID
Returns
Type Description
int

DeleteAuthCookie(string)

Declaration
public virtual void DeleteAuthCookie(string cookieValue)
Parameters
Type Name Description
string cookieValue

DeleteAuthentication(int)

Declaration
public virtual void DeleteAuthentication(int authenticationID)
Parameters
Type Name Description
int authenticationID

DeleteContentWorkflowLogs(int, int)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use IWorkflowEngine. Scheduled for removal in v10.0.0.")]
public virtual int DeleteContentWorkflowLogs(int contentItemId, int workflowId)
Parameters
Type Name Description
int contentItemId
int workflowId
Returns
Type Description
int

DeleteContentWorkflowState(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use IWorkflowEngine. Scheduled for removal in v10.0.0.")]
public virtual void DeleteContentWorkflowState(int stateId)
Parameters
Type Name Description
int stateId

DeleteContentWorkflowStatePermission(int)

Declaration
public virtual void DeleteContentWorkflowStatePermission(int workflowStatePermissionId)
Parameters
Type Name Description
int workflowStatePermissionId

DeleteDesktopModule(int)

Declaration
public virtual void DeleteDesktopModule(int desktopModuleId)
Parameters
Type Name Description
int desktopModuleId

DeleteDesktopModulePermission(int)

Declaration
public virtual void DeleteDesktopModulePermission(int desktopModulePermissionID)
Parameters
Type Name Description
int desktopModulePermissionID

DeleteDesktopModulePermissionsByPortalDesktopModuleID(int)

Declaration
public virtual void DeleteDesktopModulePermissionsByPortalDesktopModuleID(int portalDesktopModuleID)
Parameters
Type Name Description
int portalDesktopModuleID

DeleteDesktopModulePermissionsByUserID(int, int)

Declaration
public virtual void DeleteDesktopModulePermissionsByUserID(int userID, int portalID)
Parameters
Type Name Description
int userID
int portalID

DeleteExpiredAuthCookies(DateTime)

Declaration
public virtual void DeleteExpiredAuthCookies(DateTime utcExpiredBefore)
Parameters
Type Name Description
DateTime utcExpiredBefore

DeleteExtensionUrlProvider(int)

Declaration
public virtual void DeleteExtensionUrlProvider(int providerId)
Parameters
Type Name Description
int providerId

DeleteFile(int, string, int)

Declaration
public virtual void DeleteFile(int portalId, string fileName, int folderId)
Parameters
Type Name Description
int portalId
string fileName
int folderId

DeleteFileVersion(int, int)

Declaration
public virtual int DeleteFileVersion(int fileId, int version)
Parameters
Type Name Description
int fileId
int version
Returns
Type Description
int

DeleteFiles(int)

Declaration
public virtual void DeleteFiles(int portalId)
Parameters
Type Name Description
int portalId

DeleteFolder(int, string)

Declaration
public virtual void DeleteFolder(int portalId, string folderPath)
Parameters
Type Name Description
int portalId
string folderPath

DeleteFolderMapping(int)

Declaration
public virtual void DeleteFolderMapping(int folderMappingID)
Parameters
Type Name Description
int folderMappingID

DeleteFolderPermission(int)

Declaration
public virtual void DeleteFolderPermission(int folderPermissionId)
Parameters
Type Name Description
int folderPermissionId

DeleteFolderPermissionsByFolderPath(int, string)

Declaration
public virtual void DeleteFolderPermissionsByFolderPath(int portalId, string folderPath)
Parameters
Type Name Description
int portalId
string folderPath

DeleteFolderPermissionsByUserID(int, int)

Declaration
public virtual void DeleteFolderPermissionsByUserID(int portalId, int userId)
Parameters
Type Name Description
int portalId
int userId

DeleteIPFilter(int)

Declaration
public virtual void DeleteIPFilter(int ipFilterid)
Parameters
Type Name Description
int ipFilterid

DeleteLanguage(int)

Declaration
public virtual void DeleteLanguage(int languageID)
Parameters
Type Name Description
int languageID

DeleteLanguagePack(int)

Declaration
public virtual void DeleteLanguagePack(int languagePackID)
Parameters
Type Name Description
int languagePackID

DeleteList(string, string)

Declaration
public virtual void DeleteList(string listName, string parentKey)
Parameters
Type Name Description
string listName
string parentKey

DeleteListEntryByID(int, bool)

Declaration
public virtual void DeleteListEntryByID(int entryID, bool deleteChild)
Parameters
Type Name Description
int entryID
bool deleteChild

DeleteListEntryByListName(string, string, bool)

Declaration
public virtual void DeleteListEntryByListName(string listName, string value, bool deleteChild)
Parameters
Type Name Description
string listName
string value
bool deleteChild

DeleteLog(string)

Declaration
public virtual void DeleteLog(string logGUID)
Parameters
Type Name Description
string logGUID

DeleteLogType(string)

Declaration
public virtual void DeleteLogType(string logTypeKey)
Parameters
Type Name Description
string logTypeKey

DeleteLogTypeConfigInfo(string)

Declaration
public virtual void DeleteLogTypeConfigInfo(string id)
Parameters
Type Name Description
string id

DeleteModule(int)

Declaration
public virtual void DeleteModule(int moduleId)
Parameters
Type Name Description
int moduleId

DeleteModuleControl(int)

Declaration
public virtual void DeleteModuleControl(int moduleControlId)
Parameters
Type Name Description
int moduleControlId

DeleteModuleDefinition(int)

Declaration
public virtual void DeleteModuleDefinition(int moduleDefId)
Parameters
Type Name Description
int moduleDefId

DeleteModulePermission(int)

Declaration
public virtual void DeleteModulePermission(int modulePermissionId)
Parameters
Type Name Description
int modulePermissionId

DeleteModulePermissionsByModuleID(int, int)

Declaration
public virtual void DeleteModulePermissionsByModuleID(int moduleId, int portalId)
Parameters
Type Name Description
int moduleId
int portalId

DeleteModulePermissionsByUserID(int, int)

Declaration
public virtual void DeleteModulePermissionsByUserID(int portalId, int userId)
Parameters
Type Name Description
int portalId
int userId

DeleteModuleSetting(int, string)

Declaration
public virtual void DeleteModuleSetting(int moduleId, string settingName)
Parameters
Type Name Description
int moduleId
string settingName

DeleteModuleSettings(int)

Declaration
public virtual void DeleteModuleSettings(int moduleId)
Parameters
Type Name Description
int moduleId

DeleteOldRedirectMessage(DateTime)

Declaration
public virtual void DeleteOldRedirectMessage(DateTime cutofDateTime)
Parameters
Type Name Description
DateTime cutofDateTime

DeletePackage(int)

Declaration
public virtual void DeletePackage(int packageID)
Parameters
Type Name Description
int packageID

DeletePermission(int)

Declaration
public virtual void DeletePermission(int permissionID)
Parameters
Type Name Description
int permissionID

DeletePortalAlias(int)

Declaration
public virtual void DeletePortalAlias(int portalAliasID)
Parameters
Type Name Description
int portalAliasID

DeletePortalDesktopModules(int, int)

Declaration
public virtual void DeletePortalDesktopModules(int portalId, int desktopModuleId)
Parameters
Type Name Description
int portalId
int desktopModuleId

DeletePortalInfo(int)

Declaration
public virtual void DeletePortalInfo(int portalId)
Parameters
Type Name Description
int portalId

DeletePortalLanguages(int, int)

Declaration
public virtual void DeletePortalLanguages(int portalID, int languageID)
Parameters
Type Name Description
int portalID
int languageID

DeletePortalPermission(int)

Declaration
public virtual void DeletePortalPermission(int portalPermissionId)
Parameters
Type Name Description
int portalPermissionId

DeletePortalPermissionsByPortalID(int)

Declaration
public virtual void DeletePortalPermissionsByPortalID(int portalId)
Parameters
Type Name Description
int portalId

DeletePortalPermissionsByUserID(int, int)

Declaration
public virtual void DeletePortalPermissionsByUserID(int portalId, int userId)
Parameters
Type Name Description
int portalId
int userId

DeletePortalSetting(int, string, string)

Declaration
public virtual void DeletePortalSetting(int portalId, string settingName, string cultureCode)
Parameters
Type Name Description
int portalId
string settingName
string cultureCode

DeletePortalSettings(int, string)

Declaration
public virtual void DeletePortalSettings(int portalId, string cultureCode)
Parameters
Type Name Description
int portalId
string cultureCode

DeletePreviewProfile(int)

Declaration
public virtual void DeletePreviewProfile(int id)
Parameters
Type Name Description
int id

DeleteProcessedSearchDeletedItems(DateTime)

Declaration
public void DeleteProcessedSearchDeletedItems(DateTime cutoffTime)
Parameters
Type Name Description
DateTime cutoffTime

DeletePropertyDefinition(int)

Declaration
public virtual void DeletePropertyDefinition(int definitionId)
Parameters
Type Name Description
int definitionId

DeleteRedirection(int)

Declaration
public virtual void DeleteRedirection(int id)
Parameters
Type Name Description
int id

DeleteRedirectionRule(int)

Declaration
public virtual void DeleteRedirectionRule(int id)
Parameters
Type Name Description
int id

DeleteRole(int)

Declaration
public virtual void DeleteRole(int roleId)
Parameters
Type Name Description
int roleId

DeleteRoleGroup(int)

Declaration
public virtual void DeleteRoleGroup(int roleGroupId)
Parameters
Type Name Description
int roleGroupId

DeleteSchedule(int)

Declaration
public virtual void DeleteSchedule(int scheduleID)
Parameters
Type Name Description
int scheduleID

DeleteSearchStopWords(int)

Declaration
public virtual void DeleteSearchStopWords(int stopWordsId)
Parameters
Type Name Description
int stopWordsId

DeleteServer(int)

Declaration
public virtual void DeleteServer(int serverId)
Parameters
Type Name Description
int serverId

DeleteSkin(int)

Declaration
public virtual void DeleteSkin(int skinID)
Parameters
Type Name Description
int skinID

DeleteSkinControl(int)

Declaration
public virtual void DeleteSkinControl(int skinControlID)
Parameters
Type Name Description
int skinControlID

DeleteSkinPackage(int)

Declaration
public virtual void DeleteSkinPackage(int skinPackageID)
Parameters
Type Name Description
int skinPackageID

DeleteSynonymsGroup(int)

Declaration
public virtual void DeleteSynonymsGroup(int synonymsGroupId)
Parameters
Type Name Description
int synonymsGroupId

DeleteTab(int)

Declaration
public virtual void DeleteTab(int tabId)
Parameters
Type Name Description
int tabId

DeleteTabModule(int, int, bool, int)

Declaration
public virtual void DeleteTabModule(int tabId, int moduleId, bool softDelete, int lastModifiedByUserId = -1)
Parameters
Type Name Description
int tabId
int moduleId
bool softDelete
int lastModifiedByUserId

DeleteTabModuleSetting(int, string)

Declaration
public virtual void DeleteTabModuleSetting(int tabModuleId, string settingName)
Parameters
Type Name Description
int tabModuleId
string settingName

DeleteTabModuleSettings(int)

Declaration
public virtual void DeleteTabModuleSettings(int tabModuleId)
Parameters
Type Name Description
int tabModuleId

DeleteTabPermission(int)

Declaration
public virtual void DeleteTabPermission(int tabPermissionId)
Parameters
Type Name Description
int tabPermissionId

DeleteTabPermissionsByTabID(int)

Declaration
public virtual void DeleteTabPermissionsByTabID(int tabId)
Parameters
Type Name Description
int tabId

DeleteTabPermissionsByUserID(int, int)

Declaration
public virtual void DeleteTabPermissionsByUserID(int portalId, int userId)
Parameters
Type Name Description
int portalId
int userId

DeleteTabSetting(int, string)

Declaration
public virtual void DeleteTabSetting(int tabId, string settingName)
Parameters
Type Name Description
int tabId
string settingName

DeleteTabSettings(int)

Declaration
public virtual void DeleteTabSettings(int tabId)
Parameters
Type Name Description
int tabId

DeleteTabUrl(int, int)

Declaration
public virtual void DeleteTabUrl(int tabId, int seqNum)
Parameters
Type Name Description
int tabId
int seqNum

DeleteTabVersion(int)

Declaration
public virtual void DeleteTabVersion(int tabVersionId)
Parameters
Type Name Description
int tabVersionId

DeleteTabVersionDetail(int)

Declaration
public virtual void DeleteTabVersionDetail(int tabVersionDetailId)
Parameters
Type Name Description
int tabVersionDetailId

DeleteTabVersionDetailByModule(int)

Declaration
public virtual void DeleteTabVersionDetailByModule(int moduleId)
Parameters
Type Name Description
int moduleId

DeleteTranslatedTabs(int, string)

Declaration
public virtual void DeleteTranslatedTabs(int tabId, string cultureCode)
Parameters
Type Name Description
int tabId
string cultureCode

DeleteUrl(int, string)

Declaration
public virtual void DeleteUrl(int portalID, string url)
Parameters
Type Name Description
int portalID
string url

DeleteUrlTracking(int, string, int)

Declaration
public virtual void DeleteUrlTracking(int portalID, string url, int moduleID)
Parameters
Type Name Description
int portalID
string url
int moduleID

DeleteUserFromPortal(int, int)

Declaration
public virtual void DeleteUserFromPortal(int userId, int portalId)
Parameters
Type Name Description
int userId
int portalId

DeleteUserRole(int, int)

Declaration
public virtual void DeleteUserRole(int userId, int roleId)
Parameters
Type Name Description
int userId
int roleId

DeleteUsersOnline(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 8.0.0. Other solutions exist outside of the DNN Platform. Scheduled for removal in v11.0.0.")]
public virtual void DeleteUsersOnline(int timeWindow)
Parameters
Type Name Description
int timeWindow

EnsureLocalizationExists(int, string)

Declaration
public virtual void EnsureLocalizationExists(int portalID, string cultureCode)
Parameters
Type Name Description
int portalID
string cultureCode

EnsureNeutralLanguage(int, string)

Declaration
public virtual void EnsureNeutralLanguage(int portalId, string cultureCode)
Parameters
Type Name Description
int portalId
string cultureCode

ExecuteDataSet(string, params object[])

Declaration
public virtual DataSet ExecuteDataSet(string procedureName, params object[] commandParameters)
Parameters
Type Name Description
string procedureName
object[] commandParameters
Returns
Type Description
DataSet

ExecuteNonQuery(int, string, params object[])

Declaration
public abstract void ExecuteNonQuery(int timeoutSec, string procedureName, params object[] commandParameters)
Parameters
Type Name Description
int timeoutSec
string procedureName
object[] commandParameters

ExecuteNonQuery(string, params object[])

Declaration
public abstract void ExecuteNonQuery(string procedureName, params object[] commandParameters)
Parameters
Type Name Description
string procedureName
object[] commandParameters

ExecuteReader(int, string, params object[])

Declaration
public abstract IDataReader ExecuteReader(int timeoutSec, string procedureName, params object[] commandParameters)
Parameters
Type Name Description
int timeoutSec
string procedureName
object[] commandParameters
Returns
Type Description
IDataReader

ExecuteReader(string, params object[])

Declaration
public abstract IDataReader ExecuteReader(string procedureName, params object[] commandParameters)
Parameters
Type Name Description
string procedureName
object[] commandParameters
Returns
Type Description
IDataReader

ExecuteSQL(string)

Declaration
public abstract IDataReader ExecuteSQL(string sql)
Parameters
Type Name Description
string sql
Returns
Type Description
IDataReader

ExecuteSQL(string, params IDataParameter[])

Declaration
public virtual IDataReader ExecuteSQL(string sql, params IDataParameter[] commandParameters)
Parameters
Type Name Description
string sql
IDataParameter[] commandParameters
Returns
Type Description
IDataReader

ExecuteSQL(string, int)

Declaration
public abstract IDataReader ExecuteSQL(string sql, int timeoutSec)
Parameters
Type Name Description
string sql
int timeoutSec
Returns
Type Description
IDataReader

ExecuteSQLTemp(string, string)

Declaration
public abstract IDataReader ExecuteSQLTemp(string connectionString, string sql)
Parameters
Type Name Description
string connectionString
string sql
Returns
Type Description
IDataReader

ExecuteSQLTemp(string, string, int)

Declaration
public abstract IDataReader ExecuteSQLTemp(string connectionString, string sql, int timeoutSec)
Parameters
Type Name Description
string connectionString
string sql
int timeoutSec
Returns
Type Description
IDataReader

ExecuteSQLTemp(string, string, int, out string)

Declaration
public abstract IDataReader ExecuteSQLTemp(string connectionString, string sql, int timeoutSec, out string errorMessage)
Parameters
Type Name Description
string connectionString
string sql
int timeoutSec
string errorMessage
Returns
Type Description
IDataReader

ExecuteSQLTemp(string, string, out string)

Declaration
public abstract IDataReader ExecuteSQLTemp(string connectionString, string sql, out string errorMessage)
Parameters
Type Name Description
string connectionString
string sql
string errorMessage
Returns
Type Description
IDataReader

ExecuteScalar(string, params object[])

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. 0.  This method is unnecessary.  Use the generic version ExecuteScalar<T>. Scheduled for removal in v10.0.0.")]
public virtual object ExecuteScalar(string procedureName, params object[] commandParameters)
Parameters
Type Name Description
string procedureName
object[] commandParameters
Returns
Type Description
object

ExecuteScalar<T>(int, string, params object[])

Declaration
public abstract T ExecuteScalar<T>(int timeoutSec, string procedureName, params object[] commandParameters)
Parameters
Type Name Description
int timeoutSec
string procedureName
object[] commandParameters
Returns
Type Description
T
Type Parameters
Name Description
T

ExecuteScalar<T>(string, params object[])

Declaration
public abstract T ExecuteScalar<T>(string procedureName, params object[] commandParameters)
Parameters
Type Name Description
string procedureName
object[] commandParameters
Returns
Type Description
T
Type Parameters
Name Description
T

ExecuteScript(string)

Declaration
public abstract string ExecuteScript(string script)
Parameters
Type Name Description
string script
Returns
Type Description
string

ExecuteScript(string, int)

Declaration
public abstract string ExecuteScript(string script, int timeoutSec)
Parameters
Type Name Description
string script
int timeoutSec
Returns
Type Description
string

ExecuteScript(string, string)

Declaration
public abstract string ExecuteScript(string connectionString, string sql)
Parameters
Type Name Description
string connectionString
string sql
Returns
Type Description
string

ExecuteScript(string, string, int)

Declaration
public abstract string ExecuteScript(string connectionString, string sql, int timeoutSec)
Parameters
Type Name Description
string connectionString
string sql
int timeoutSec
Returns
Type Description
string

FindAuthCookie(string)

Declaration
public virtual IDataReader FindAuthCookie(string cookieValue)
Parameters
Type Name Description
string cookieValue
Returns
Type Description
IDataReader

FindDatabaseVersion(int, int, int)

Declaration
public virtual IDataReader FindDatabaseVersion(int major, int minor, int build)
Parameters
Type Name Description
int major
int minor
int build
Returns
Type Description
IDataReader

GetAllFiles()

Declaration
public virtual DataTable GetAllFiles()
Returns
Type Description
DataTable

GetAllModules()

Declaration
public virtual IDataReader GetAllModules()
Returns
Type Description
IDataReader

GetAllPortals()

Declaration
public virtual IDataReader GetAllPortals()
Returns
Type Description
IDataReader

GetAllProfiles()

Declaration
public virtual IDataReader GetAllProfiles()
Returns
Type Description
IDataReader

GetAllRedirections()

Declaration
public virtual IDataReader GetAllRedirections()
Returns
Type Description
IDataReader

GetAllSearchTypes()

Declaration
public virtual IDataReader GetAllSearchTypes()
Returns
Type Description
IDataReader

GetAllSynonymsGroups(int, string)

Declaration
public virtual IDataReader GetAllSynonymsGroups(int portalId, string cultureCode)
Parameters
Type Name Description
int portalId
string cultureCode
Returns
Type Description
IDataReader

GetAllTabs()

Declaration
public virtual IDataReader GetAllTabs()
Returns
Type Description
IDataReader

GetAllTabsModules(int, bool)

Declaration
public virtual IDataReader GetAllTabsModules(int portalId, bool allTabs)
Parameters
Type Name Description
int portalId
bool allTabs
Returns
Type Description
IDataReader

GetAllTabsModulesByModuleID(int)

Declaration
public virtual IDataReader GetAllTabsModulesByModuleID(int moduleId)
Parameters
Type Name Description
int moduleId
Returns
Type Description
IDataReader

GetAllUsers(int, int, int, bool, bool)

Declaration
public virtual IDataReader GetAllUsers(int portalID, int pageIndex, int pageSize, bool includeDeleted, bool superUsersOnly)
Parameters
Type Name Description
int portalID
int pageIndex
int pageSize
bool includeDeleted
bool superUsersOnly
Returns
Type Description
IDataReader

GetAuthenticationService(int)

Declaration
public virtual IDataReader GetAuthenticationService(int authenticationID)
Parameters
Type Name Description
int authenticationID
Returns
Type Description
IDataReader

GetAuthenticationServiceByPackageID(int)

Declaration
public virtual IDataReader GetAuthenticationServiceByPackageID(int packageID)
Parameters
Type Name Description
int packageID
Returns
Type Description
IDataReader

GetAuthenticationServiceByType(string)

Declaration
public virtual IDataReader GetAuthenticationServiceByType(string authenticationType)
Parameters
Type Name Description
string authenticationType
Returns
Type Description
IDataReader

GetAuthenticationServices()

Declaration
public virtual IDataReader GetAuthenticationServices()
Returns
Type Description
IDataReader

GetAvailableUsersForIndex(int, DateTime, int, int)

Declaration
public virtual IDataReader GetAvailableUsersForIndex(int portalId, DateTime startDate, int startUserId, int numberOfUsers)
Parameters
Type Name Description
int portalId
DateTime startDate
int startUserId
int numberOfUsers
Returns
Type Description
IDataReader

GetConnectionStringBuilder()

Declaration
public virtual DbConnectionStringBuilder GetConnectionStringBuilder()
Returns
Type Description
DbConnectionStringBuilder

GetContentWorkflow(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use IWorkflowEngine. Scheduled for removal in v10.0.0.")]
public virtual IDataReader GetContentWorkflow(int workflowId)
Parameters
Type Name Description
int workflowId
Returns
Type Description
IDataReader

GetContentWorkflowLogs(int, int)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use IWorkflowLogger.GetWorkflowLogs. Scheduled for removal in v10.0.0.")]
public virtual IDataReader GetContentWorkflowLogs(int contentItemId, int workflowId)
Parameters
Type Name Description
int contentItemId
int workflowId
Returns
Type Description
IDataReader

GetContentWorkflowSource(int, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use IWorkflowEngine. Scheduled for removal in v10.0.0.")]
public virtual IDataReader GetContentWorkflowSource(int workflowId, string sourceName)
Parameters
Type Name Description
int workflowId
string sourceName
Returns
Type Description
IDataReader

GetContentWorkflowState(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use IWorkflowEngine. Scheduled for removal in v10.0.0.")]
public virtual IDataReader GetContentWorkflowState(int stateId)
Parameters
Type Name Description
int stateId
Returns
Type Description
IDataReader

GetContentWorkflowStatePermission(int)

Declaration
public virtual IDataReader GetContentWorkflowStatePermission(int workflowStatePermissionId)
Parameters
Type Name Description
int workflowStatePermissionId
Returns
Type Description
IDataReader

GetContentWorkflowStatePermissions()

Declaration
public virtual IDataReader GetContentWorkflowStatePermissions()
Returns
Type Description
IDataReader

GetContentWorkflowStatePermissionsByStateID(int)

Declaration
public virtual IDataReader GetContentWorkflowStatePermissionsByStateID(int stateId)
Parameters
Type Name Description
int stateId
Returns
Type Description
IDataReader

GetContentWorkflowStateUsageCount(int)

Declaration
public virtual int GetContentWorkflowStateUsageCount(int stateId)
Parameters
Type Name Description
int stateId
Returns
Type Description
int

GetContentWorkflowStates(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use IWorkflowEngine. Scheduled for removal in v10.0.0.")]
public virtual IDataReader GetContentWorkflowStates(int workflowId)
Parameters
Type Name Description
int workflowId
Returns
Type Description
IDataReader

GetContentWorkflowUsage(int, int, int)

Declaration
public virtual IDataReader GetContentWorkflowUsage(int workflowId, int pageIndex, int pageSize)
Parameters
Type Name Description
int workflowId
int pageIndex
int pageSize
Returns
Type Description
IDataReader

GetContentWorkflowUsageCount(int)

Declaration
public virtual int GetContentWorkflowUsageCount(int workflowId)
Parameters
Type Name Description
int workflowId
Returns
Type Description
int

GetContentWorkflows(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use IWorkflowEngine. Scheduled for removal in v10.0.0.")]
public virtual IDataReader GetContentWorkflows(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetCustomAliasesForTabs()

Declaration
public virtual IDataReader GetCustomAliasesForTabs()
Returns
Type Description
IDataReader

GetDatabaseEngineVersion()

Declaration
public virtual Version GetDatabaseEngineVersion()
Returns
Type Description
Version

GetDatabaseInstallVersion()

Declaration
public virtual IDataReader GetDatabaseInstallVersion()
Returns
Type Description
IDataReader

GetDatabaseTime()

Declaration
public virtual DateTime GetDatabaseTime()
Returns
Type Description
DateTime

GetDatabaseTimeOffset()

Declaration
public virtual DateTimeOffset GetDatabaseTimeOffset()
Returns
Type Description
DateTimeOffset

GetDatabaseTimeUtc()

Declaration
public virtual DateTime GetDatabaseTimeUtc()
Returns
Type Description
DateTime

GetDatabaseVersion()

Declaration
public virtual IDataReader GetDatabaseVersion()
Returns
Type Description
IDataReader

GetDefaultLanguageByModule(string)

Declaration
public virtual IDataReader GetDefaultLanguageByModule(string moduleList)
Parameters
Type Name Description
string moduleList
Returns
Type Description
IDataReader

GetDeletedUsers(int)

Declaration
public virtual IDataReader GetDeletedUsers(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetDesktopModulePermission(int)

Declaration
public virtual IDataReader GetDesktopModulePermission(int desktopModulePermissionID)
Parameters
Type Name Description
int desktopModulePermissionID
Returns
Type Description
IDataReader

GetDesktopModulePermissions()

Declaration
public virtual IDataReader GetDesktopModulePermissions()
Returns
Type Description
IDataReader

GetDesktopModulePermissionsByPortalDesktopModuleID(int)

Declaration
public virtual IDataReader GetDesktopModulePermissionsByPortalDesktopModuleID(int portalDesktopModuleID)
Parameters
Type Name Description
int portalDesktopModuleID
Returns
Type Description
IDataReader

GetDesktopModules()

Declaration
public virtual IDataReader GetDesktopModules()
Returns
Type Description
IDataReader

GetDesktopModulesByPortal(int)

Declaration
public virtual IDataReader GetDesktopModulesByPortal(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetDisplayNameForUser(int, string)

Declaration
public virtual IDataReader GetDisplayNameForUser(int userId, string spaceReplacement)
Parameters
Type Name Description
int userId
string spaceReplacement
Returns
Type Description
IDataReader

GetDuplicateEmailCount(int)

Declaration
public virtual int GetDuplicateEmailCount(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
int

GetEnabledAuthenticationServices()

Declaration
public virtual IDataReader GetEnabledAuthenticationServices()
Returns
Type Description
IDataReader

GetEventLogPendingNotif(int)

Declaration
public virtual IDataReader GetEventLogPendingNotif(int logConfigID)
Parameters
Type Name Description
int logConfigID
Returns
Type Description
IDataReader

GetEventLogPendingNotifConfig()

Declaration
public virtual IDataReader GetEventLogPendingNotifConfig()
Returns
Type Description
IDataReader

GetEventMessages(string)

Declaration
public virtual IDataReader GetEventMessages(string eventName)
Parameters
Type Name Description
string eventName
Returns
Type Description
IDataReader

GetEventMessagesBySubscriber(string, string)

Declaration
public virtual IDataReader GetEventMessagesBySubscriber(string eventName, string subscriberId)
Parameters
Type Name Description
string eventName
string subscriberId
Returns
Type Description
IDataReader

GetExpiredPortals()

Declaration
public virtual IDataReader GetExpiredPortals()
Returns
Type Description
IDataReader

GetExtensionUrlProviders(int)

Declaration
public virtual IDataReader GetExtensionUrlProviders(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetFile(string, int, bool)

Declaration
public virtual IDataReader GetFile(string fileName, int folderId, bool retrieveUnpublishedFiles = false)
Parameters
Type Name Description
string fileName
int folderId
bool retrieveUnpublishedFiles
Returns
Type Description
IDataReader

GetFileById(int, bool)

Declaration
public virtual IDataReader GetFileById(int fileId, bool retrieveUnpublishedFiles = false)
Parameters
Type Name Description
int fileId
bool retrieveUnpublishedFiles
Returns
Type Description
IDataReader

GetFileByUniqueID(Guid)

Declaration
public virtual IDataReader GetFileByUniqueID(Guid uniqueId)
Parameters
Type Name Description
Guid uniqueId
Returns
Type Description
IDataReader

GetFileContent(int)

Declaration
public virtual IDataReader GetFileContent(int fileId)
Parameters
Type Name Description
int fileId
Returns
Type Description
IDataReader

GetFileVersion(int, int)

Declaration
public virtual IDataReader GetFileVersion(int fileId, int version)
Parameters
Type Name Description
int fileId
int version
Returns
Type Description
IDataReader

GetFileVersionContent(int, int)

Declaration
public virtual IDataReader GetFileVersionContent(int fileId, int version)
Parameters
Type Name Description
int fileId
int version
Returns
Type Description
IDataReader

GetFileVersions(int)

Declaration
public virtual IDataReader GetFileVersions(int fileId)
Parameters
Type Name Description
int fileId
Returns
Type Description
IDataReader

GetFileVersionsInFolder(int)

Declaration
public virtual IDataReader GetFileVersionsInFolder(int folderId)
Parameters
Type Name Description
int folderId
Returns
Type Description
IDataReader

GetFiles(int, bool)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.3.0. Please use GetFiles(int, bool, bool) instead. Scheduled for removal in v11.0.0.")]
public virtual IDataReader GetFiles(int folderId, bool retrieveUnpublishedFiles = false)
Parameters
Type Name Description
int folderId
bool retrieveUnpublishedFiles
Returns
Type Description
IDataReader

GetFiles(int, bool, bool)

Declaration
public virtual IDataReader GetFiles(int folderId, bool retrieveUnpublishedFiles, bool recursive)
Parameters
Type Name Description
int folderId
bool retrieveUnpublishedFiles
bool recursive
Returns
Type Description
IDataReader

GetFolder(int)

Declaration
public virtual IDataReader GetFolder(int folderId)
Parameters
Type Name Description
int folderId
Returns
Type Description
IDataReader

GetFolder(int, string)

Declaration
public virtual IDataReader GetFolder(int portalId, string folderPath)
Parameters
Type Name Description
int portalId
string folderPath
Returns
Type Description
IDataReader

GetFolderByUniqueID(Guid)

Declaration
public virtual IDataReader GetFolderByUniqueID(Guid uniqueId)
Parameters
Type Name Description
Guid uniqueId
Returns
Type Description
IDataReader

GetFolderMapping(int)

Declaration
public virtual IDataReader GetFolderMapping(int folderMappingID)
Parameters
Type Name Description
int folderMappingID
Returns
Type Description
IDataReader

GetFolderMappingByMappingName(int, string)

Declaration
public virtual IDataReader GetFolderMappingByMappingName(int portalID, string mappingName)
Parameters
Type Name Description
int portalID
string mappingName
Returns
Type Description
IDataReader

GetFolderMappingSetting(int, string)

Declaration
public virtual IDataReader GetFolderMappingSetting(int folderMappingID, string settingName)
Parameters
Type Name Description
int folderMappingID
string settingName
Returns
Type Description
IDataReader

GetFolderMappingSettings(int)

Declaration
public virtual IDataReader GetFolderMappingSettings(int folderMappingID)
Parameters
Type Name Description
int folderMappingID
Returns
Type Description
IDataReader

GetFolderMappings(int)

Declaration
public virtual IDataReader GetFolderMappings(int portalID)
Parameters
Type Name Description
int portalID
Returns
Type Description
IDataReader

GetFolderPermission(int)

Declaration
public virtual IDataReader GetFolderPermission(int folderPermissionId)
Parameters
Type Name Description
int folderPermissionId
Returns
Type Description
IDataReader

GetFolderPermissionsByFolderPath(int, string, int)

Declaration
public virtual IDataReader GetFolderPermissionsByFolderPath(int portalId, string folderPath, int permissionId)
Parameters
Type Name Description
int portalId
string folderPath
int permissionId
Returns
Type Description
IDataReader

GetFolderPermissionsByPortal(int)

Declaration
public virtual IDataReader GetFolderPermissionsByPortal(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetFolderPermissionsByPortalAndPath(int, string)

Declaration
public virtual IDataReader GetFolderPermissionsByPortalAndPath(int portalId, string pathName)
Parameters
Type Name Description
int portalId
string pathName
Returns
Type Description
IDataReader

GetFoldersByPortal(int)

Declaration
public virtual IDataReader GetFoldersByPortal(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetFoldersByPortalAndPermissions(int, string, int)

Declaration
public virtual IDataReader GetFoldersByPortalAndPermissions(int portalId, string permissions, int userId)
Parameters
Type Name Description
int portalId
string permissions
int userId
Returns
Type Description
IDataReader

GetHostSetting(string)

Declaration
public virtual IDataReader GetHostSetting(string settingName)
Parameters
Type Name Description
string settingName
Returns
Type Description
IDataReader

GetHostSettings()

Declaration
public virtual IDataReader GetHostSettings()
Returns
Type Description
IDataReader

GetIPFilter(int)

Declaration
public virtual IDataReader GetIPFilter(int ipf)
Parameters
Type Name Description
int ipf
Returns
Type Description
IDataReader

GetIPFilters()

Declaration
public virtual IDataReader GetIPFilters()
Returns
Type Description
IDataReader

GetInstallVersion()

Declaration
public virtual Version GetInstallVersion()
Returns
Type Description
Version

GetInstalledModules()

Declaration
public virtual IDataReader GetInstalledModules()
Returns
Type Description
IDataReader

GetLanguagePackByPackage(int)

Declaration
public virtual IDataReader GetLanguagePackByPackage(int packageID)
Parameters
Type Name Description
int packageID
Returns
Type Description
IDataReader

GetLanguages()

Declaration
public virtual IDataReader GetLanguages()
Returns
Type Description
IDataReader

GetLanguagesByPortal(int)

Declaration
public virtual IDataReader GetLanguagesByPortal(int portalID)
Parameters
Type Name Description
int portalID
Returns
Type Description
IDataReader

GetLastAppliedIteration(int, int, int)

Declaration
public virtual int GetLastAppliedIteration(int major, int minor, int build)
Parameters
Type Name Description
int major
int minor
int build
Returns
Type Description
int

GetLegacyFolderCount()

Declaration
public virtual int GetLegacyFolderCount()
Returns
Type Description
int

GetList(string, string, int)

Declaration
public virtual IDataReader GetList(string listName, string parentKey, int portalID)
Parameters
Type Name Description
string listName
string parentKey
int portalID
Returns
Type Description
IDataReader

GetListEntriesByListName(string, string, int)

Declaration
public virtual IDataReader GetListEntriesByListName(string listName, string parentKey, int portalID)
Parameters
Type Name Description
string listName
string parentKey
int portalID
Returns
Type Description
IDataReader

GetListEntry(int)

Declaration
public virtual IDataReader GetListEntry(int entryID)
Parameters
Type Name Description
int entryID
Returns
Type Description
IDataReader

GetListEntry(string, string)

Declaration
public virtual IDataReader GetListEntry(string listName, string value)
Parameters
Type Name Description
string listName
string value
Returns
Type Description
IDataReader

GetLists(int)

Declaration
public virtual IDataReader GetLists(int portalID)
Parameters
Type Name Description
int portalID
Returns
Type Description
IDataReader

GetLogTypeConfigInfo()

Declaration
public virtual IDataReader GetLogTypeConfigInfo()
Returns
Type Description
IDataReader

GetLogTypeConfigInfoByID(int)

Declaration
public virtual IDataReader GetLogTypeConfigInfoByID(int id)
Parameters
Type Name Description
int id
Returns
Type Description
IDataReader

GetLogTypeInfo()

Declaration
public virtual IDataReader GetLogTypeInfo()
Returns
Type Description
IDataReader

GetLogs(int, string, int, int)

Declaration
public virtual IDataReader GetLogs(int portalID, string logType, int pageSize, int pageIndex)
Parameters
Type Name Description
int portalID
string logType
int pageSize
int pageIndex
Returns
Type Description
IDataReader

GetModule(int, int)

Declaration
public virtual IDataReader GetModule(int moduleId, int tabId)
Parameters
Type Name Description
int moduleId
int tabId
Returns
Type Description
IDataReader

GetModuleByDefinition(int, string)

Declaration
public virtual IDataReader GetModuleByDefinition(int portalId, string definitionName)
Parameters
Type Name Description
int portalId
string definitionName
Returns
Type Description
IDataReader

GetModuleByUniqueID(Guid)

Declaration
public virtual IDataReader GetModuleByUniqueID(Guid uniqueId)
Parameters
Type Name Description
Guid uniqueId
Returns
Type Description
IDataReader

GetModuleControls()

Declaration
public virtual IDataReader GetModuleControls()
Returns
Type Description
IDataReader

GetModuleDefinitions()

Declaration
public virtual IDataReader GetModuleDefinitions()
Returns
Type Description
IDataReader

GetModulePackagesInUse(int, bool)

Declaration
public virtual IDataReader GetModulePackagesInUse(int portalID, bool forHost)
Parameters
Type Name Description
int portalID
bool forHost
Returns
Type Description
IDataReader

GetModulePermission(int)

Declaration
public virtual IDataReader GetModulePermission(int modulePermissionId)
Parameters
Type Name Description
int modulePermissionId
Returns
Type Description
IDataReader

GetModulePermissionsByModuleID(int, int)

Declaration
public virtual IDataReader GetModulePermissionsByModuleID(int moduleID, int permissionId)
Parameters
Type Name Description
int moduleID
int permissionId
Returns
Type Description
IDataReader

GetModulePermissionsByPortal(int)

Declaration
public virtual IDataReader GetModulePermissionsByPortal(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetModulePermissionsByTabID(int)

Declaration
public virtual IDataReader GetModulePermissionsByTabID(int tabId)
Parameters
Type Name Description
int tabId
Returns
Type Description
IDataReader

GetModuleSetting(int, string)

Declaration
public virtual IDataReader GetModuleSetting(int moduleId, string settingName)
Parameters
Type Name Description
int moduleId
string settingName
Returns
Type Description
IDataReader

GetModuleSettings(int)

Declaration
public virtual IDataReader GetModuleSettings(int moduleId)
Parameters
Type Name Description
int moduleId
Returns
Type Description
IDataReader

GetModuleSettingsByTab(int)

Declaration
public virtual IDataReader GetModuleSettingsByTab(int tabId)
Parameters
Type Name Description
int tabId
Returns
Type Description
IDataReader

GetModules(int)

Declaration
public virtual IDataReader GetModules(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetNextScheduledTask(string)

Declaration
public virtual IDataReader GetNextScheduledTask(string server)
Parameters
Type Name Description
string server
Returns
Type Description
IDataReader

GetNull(object)

Declaration
public virtual object GetNull(object field)
Parameters
Type Name Description
object field
Returns
Type Description
object

GetOnlineUser(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 8.0.0. Other solutions exist outside of the DNN Platform. Scheduled for removal in v11.0.0.")]
public virtual IDataReader GetOnlineUser(int userId)
Parameters
Type Name Description
int userId
Returns
Type Description
IDataReader

GetOnlineUsers(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 8.0.0. Other solutions exist outside of the DNN Platform. Scheduled for removal in v11.0.0.")]
public virtual IDataReader GetOnlineUsers(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetOutputCacheItem(string)

Declaration
public virtual IDataReader GetOutputCacheItem(string cacheKey)
Parameters
Type Name Description
string cacheKey
Returns
Type Description
IDataReader

GetOutputCacheItemCount(int)

Declaration
public virtual int GetOutputCacheItemCount(int itemId)
Parameters
Type Name Description
int itemId
Returns
Type Description
int

GetOutputCacheKeys()

Declaration
public virtual IDataReader GetOutputCacheKeys()
Returns
Type Description
IDataReader

GetOutputCacheKeys(int)

Declaration
public virtual IDataReader GetOutputCacheKeys(int itemId)
Parameters
Type Name Description
int itemId
Returns
Type Description
IDataReader

GetPackageDependencies()

Declaration
public virtual IDataReader GetPackageDependencies()
Returns
Type Description
IDataReader

GetPackageTypes()

Declaration
public virtual IDataReader GetPackageTypes()
Returns
Type Description
IDataReader

GetPackages(int)

Declaration
public virtual IDataReader GetPackages(int portalID)
Parameters
Type Name Description
int portalID
Returns
Type Description
IDataReader

GetPasswordHistory(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.2.0. Please use the overload that takes passwordsRetained and daysRetained. Scheduled for removal in v11.0.0.")]
public virtual IDataReader GetPasswordHistory(int userId)
Parameters
Type Name Description
int userId
Returns
Type Description
IDataReader

GetPasswordHistory(int, int, int)

Declaration
public virtual IDataReader GetPasswordHistory(int userId, int passwordsRetained, int daysRetained)
Parameters
Type Name Description
int userId
int passwordsRetained
int daysRetained
Returns
Type Description
IDataReader

GetPortalAliases()

Declaration
public virtual IDataReader GetPortalAliases()
Returns
Type Description
IDataReader

GetPortalByPortalAliasID(int)

Declaration
public virtual IDataReader GetPortalByPortalAliasID(int portalAliasId)
Parameters
Type Name Description
int portalAliasId
Returns
Type Description
IDataReader

GetPortalDefaultLanguage(int)

Declaration
public virtual string GetPortalDefaultLanguage(int portalID)
Parameters
Type Name Description
int portalID
Returns
Type Description
string

GetPortalDesktopModules(int, int)

Declaration
public virtual IDataReader GetPortalDesktopModules(int portalId, int desktopModuleId)
Parameters
Type Name Description
int portalId
int desktopModuleId
Returns
Type Description
IDataReader

GetPortalLocalizations(int)

Declaration
public virtual IDataReader GetPortalLocalizations(int portalID)
Parameters
Type Name Description
int portalID
Returns
Type Description
IDataReader

GetPortalPermissionsByPortal(int)

Declaration
public virtual IDataReader GetPortalPermissionsByPortal(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetPortalRoles(int)

Declaration
public virtual IDataReader GetPortalRoles(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetPortalSettings(int, string)

Declaration
public virtual IDataReader GetPortalSettings(int portalId, string cultureCode)
Parameters
Type Name Description
int portalId
string cultureCode
Returns
Type Description
IDataReader

GetPortalSpaceUsed(int)

Declaration
public virtual IDataReader GetPortalSpaceUsed(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetPortals(string)

Declaration
public virtual IDataReader GetPortals(string cultureCode)
Parameters
Type Name Description
string cultureCode
Returns
Type Description
IDataReader

GetPortalsByName(string, int, int)

Declaration
public virtual IDataReader GetPortalsByName(string nameToMatch, int pageIndex, int pageSize)
Parameters
Type Name Description
string nameToMatch
int pageIndex
int pageSize
Returns
Type Description
IDataReader

GetPortalsByUser(int)

Declaration
public virtual IDataReader GetPortalsByUser(int userId)
Parameters
Type Name Description
int userId
Returns
Type Description
IDataReader

GetPreviewProfiles(int)

Declaration
public virtual IDataReader GetPreviewProfiles(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetProfile(int, int)

Declaration
public virtual IDataReader GetProfile(int userId, int portalId)
Parameters
Type Name Description
int userId
int portalId
Returns
Type Description
IDataReader

GetPropertyDefinition(int)

Declaration
public virtual IDataReader GetPropertyDefinition(int definitionId)
Parameters
Type Name Description
int definitionId
Returns
Type Description
IDataReader

GetPropertyDefinitionByName(int, string)

Declaration
public virtual IDataReader GetPropertyDefinitionByName(int portalId, string name)
Parameters
Type Name Description
int portalId
string name
Returns
Type Description
IDataReader

GetPropertyDefinitionsByPortal(int)

Declaration
public virtual IDataReader GetPropertyDefinitionsByPortal(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetProviderPath()

Declaration
public virtual string GetProviderPath()
Returns
Type Description
string

GetRedirectMessage(Guid)

Declaration
public virtual string GetRedirectMessage(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
string

GetRedirectionRules(int)

Declaration
public virtual IDataReader GetRedirectionRules(int redirectionId)
Parameters
Type Name Description
int redirectionId
Returns
Type Description
IDataReader

GetRedirections(int)

Declaration
public virtual IDataReader GetRedirections(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetRoleGroup(int, int)

Declaration
public virtual IDataReader GetRoleGroup(int portalId, int roleGroupId)
Parameters
Type Name Description
int portalId
int roleGroupId
Returns
Type Description
IDataReader

GetRoleGroupByName(int, string)

Declaration
public virtual IDataReader GetRoleGroupByName(int portalID, string roleGroupName)
Parameters
Type Name Description
int portalID
string roleGroupName
Returns
Type Description
IDataReader

GetRoleGroups(int)

Declaration
public virtual IDataReader GetRoleGroups(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetRoleSettings(int)

Declaration
public virtual IDataReader GetRoleSettings(int roleId)
Parameters
Type Name Description
int roleId
Returns
Type Description
IDataReader

GetRoles()

Declaration
public virtual IDataReader GetRoles()
Returns
Type Description
IDataReader

GetRolesBasicSearch(int, int, int, string)

Declaration
public virtual IDataReader GetRolesBasicSearch(int portalID, int pageIndex, int pageSize, string filterBy)
Parameters
Type Name Description
int portalID
int pageIndex
int pageSize
string filterBy
Returns
Type Description
IDataReader

GetSchedule()

Declaration
public virtual IDataReader GetSchedule()
Returns
Type Description
IDataReader

GetSchedule(int)

Declaration
public virtual IDataReader GetSchedule(int scheduleID)
Parameters
Type Name Description
int scheduleID
Returns
Type Description
IDataReader

GetSchedule(string)

Declaration
public virtual IDataReader GetSchedule(string server)
Parameters
Type Name Description
string server
Returns
Type Description
IDataReader

GetSchedule(string, string)

Declaration
public virtual IDataReader GetSchedule(string typeFullName, string server)
Parameters
Type Name Description
string typeFullName
string server
Returns
Type Description
IDataReader

GetScheduleByEvent(string, string)

Declaration
public virtual IDataReader GetScheduleByEvent(string eventName, string server)
Parameters
Type Name Description
string eventName
string server
Returns
Type Description
IDataReader

GetScheduleHistory(int)

Declaration
public virtual IDataReader GetScheduleHistory(int scheduleID)
Parameters
Type Name Description
int scheduleID
Returns
Type Description
IDataReader

GetScheduleItemSettings(int)

Declaration
public virtual IDataReader GetScheduleItemSettings(int scheduleID)
Parameters
Type Name Description
int scheduleID
Returns
Type Description
IDataReader

GetSearchCommonWordsByLocale(string)

Declaration
public virtual IDataReader GetSearchCommonWordsByLocale(string locale)
Parameters
Type Name Description
string locale
Returns
Type Description
IDataReader

GetSearchDeletedItems(DateTime)

Declaration
public IDataReader GetSearchDeletedItems(DateTime cutoffTime)
Parameters
Type Name Description
DateTime cutoffTime
Returns
Type Description
IDataReader

GetSearchIndexers()

Declaration
public virtual IDataReader GetSearchIndexers()
Returns
Type Description
IDataReader

GetSearchModules(int)

Declaration
public virtual IDataReader GetSearchModules(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetSearchResultModules(int)

Declaration
public virtual IDataReader GetSearchResultModules(int portalID)
Parameters
Type Name Description
int portalID
Returns
Type Description
IDataReader

GetSearchSettings(int)

Declaration
public virtual IDataReader GetSearchSettings(int moduleId)
Parameters
Type Name Description
int moduleId
Returns
Type Description
IDataReader

GetSearchStopWords(int, string)

Declaration
public virtual IDataReader GetSearchStopWords(int portalId, string cultureCode)
Parameters
Type Name Description
int portalId
string cultureCode
Returns
Type Description
IDataReader

GetServers()

Declaration
public virtual IDataReader GetServers()
Returns
Type Description
IDataReader

GetServices(int, int)

Declaration
public virtual IDataReader GetServices(int portalId, int userId)
Parameters
Type Name Description
int portalId
int userId
Returns
Type Description
IDataReader

GetSingleLog(string)

Declaration
public virtual IDataReader GetSingleLog(string logGUID)
Parameters
Type Name Description
string logGUID
Returns
Type Description
IDataReader

GetSingleUserByEmail(int, string)

Declaration
public virtual int GetSingleUserByEmail(int portalId, string emailToMatch)
Parameters
Type Name Description
int portalId
string emailToMatch
Returns
Type Description
int

GetSkinByPackageID(int)

Declaration
public virtual IDataReader GetSkinByPackageID(int packageID)
Parameters
Type Name Description
int packageID
Returns
Type Description
IDataReader

GetSkinControl(int)

Declaration
public virtual IDataReader GetSkinControl(int skinControlID)
Parameters
Type Name Description
int skinControlID
Returns
Type Description
IDataReader

GetSkinControlByKey(string)

Declaration
public virtual IDataReader GetSkinControlByKey(string controlKey)
Parameters
Type Name Description
string controlKey
Returns
Type Description
IDataReader

GetSkinControlByPackageID(int)

Declaration
public virtual IDataReader GetSkinControlByPackageID(int packageID)
Parameters
Type Name Description
int packageID
Returns
Type Description
IDataReader

GetSkinControls()

Declaration
public virtual IDataReader GetSkinControls()
Returns
Type Description
IDataReader

GetSkinPackage(int, string, string)

Declaration
public virtual IDataReader GetSkinPackage(int portalID, string skinName, string skinType)
Parameters
Type Name Description
int portalID
string skinName
string skinType
Returns
Type Description
IDataReader

GetTab(int)

Declaration
public virtual IDataReader GetTab(int tabId)
Parameters
Type Name Description
int tabId
Returns
Type Description
IDataReader

GetTabAliasSkins(int)

Declaration
public virtual IDataReader GetTabAliasSkins(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetTabByUniqueID(Guid)

Declaration
public virtual IDataReader GetTabByUniqueID(Guid uniqueId)
Parameters
Type Name Description
Guid uniqueId
Returns
Type Description
IDataReader

GetTabCustomAliases(int)

Declaration
public virtual IDataReader GetTabCustomAliases(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetTabModule(int)

Declaration
public virtual IDataReader GetTabModule(int tabModuleId)
Parameters
Type Name Description
int tabModuleId
Returns
Type Description
IDataReader

GetTabModuleIdsBySettingNameAndValue(int, string, string)

Declaration
public virtual IDataReader GetTabModuleIdsBySettingNameAndValue(int portalId, string settingName, string expectedValue)
Parameters
Type Name Description
int portalId
string settingName
string expectedValue
Returns
Type Description
IDataReader

GetTabModuleOrder(int, string)

Declaration
public virtual IDataReader GetTabModuleOrder(int tabId, string paneName)
Parameters
Type Name Description
int tabId
string paneName
Returns
Type Description
IDataReader

GetTabModuleSetting(int, string)

Declaration
public virtual IDataReader GetTabModuleSetting(int tabModuleId, string settingName)
Parameters
Type Name Description
int tabModuleId
string settingName
Returns
Type Description
IDataReader

GetTabModuleSettings(int)

Declaration
public virtual IDataReader GetTabModuleSettings(int tabModuleId)
Parameters
Type Name Description
int tabModuleId
Returns
Type Description
IDataReader

GetTabModuleSettingsByName(int, string)

Declaration
public virtual IDataReader GetTabModuleSettingsByName(int portalId, string settingName)
Parameters
Type Name Description
int portalId
string settingName
Returns
Type Description
IDataReader

GetTabModuleSettingsByTab(int)

Declaration
public virtual IDataReader GetTabModuleSettingsByTab(int tabId)
Parameters
Type Name Description
int tabId
Returns
Type Description
IDataReader

GetTabModules(int)

Declaration
public virtual IDataReader GetTabModules(int tabId)
Parameters
Type Name Description
int tabId
Returns
Type Description
IDataReader

GetTabPanes(int)

Declaration
public virtual IDataReader GetTabPanes(int tabId)
Parameters
Type Name Description
int tabId
Returns
Type Description
IDataReader

GetTabPaths(int, string)

Declaration
public virtual IDataReader GetTabPaths(int portalId, string cultureCode)
Parameters
Type Name Description
int portalId
string cultureCode
Returns
Type Description
IDataReader

GetTabPermissionsByPortal(int)

Declaration
public virtual IDataReader GetTabPermissionsByPortal(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetTabPermissionsByTabID(int, int)

Declaration
public virtual IDataReader GetTabPermissionsByTabID(int tabId, int permissionId)
Parameters
Type Name Description
int tabId
int permissionId
Returns
Type Description
IDataReader

GetTabSetting(int, string)

Declaration
public virtual IDataReader GetTabSetting(int tabID, string settingName)
Parameters
Type Name Description
int tabID
string settingName
Returns
Type Description
IDataReader

GetTabSettings(int)

Declaration
public virtual IDataReader GetTabSettings(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetTabUrls(int)

Declaration
public virtual IDataReader GetTabUrls(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetTabVersionDetails(int)

Declaration
public virtual IDataReader GetTabVersionDetails(int tabVersionId)
Parameters
Type Name Description
int tabVersionId
Returns
Type Description
IDataReader

GetTabVersionDetailsHistory(int, int)

Declaration
public virtual IDataReader GetTabVersionDetailsHistory(int tabId, int version)
Parameters
Type Name Description
int tabId
int version
Returns
Type Description
IDataReader

GetTabVersions(int)

Declaration
public virtual IDataReader GetTabVersions(int tabId)
Parameters
Type Name Description
int tabId
Returns
Type Description
IDataReader

GetTabs(int)

Declaration
public virtual IDataReader GetTabs(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IDataReader

GetTabsByModuleID(int)

Declaration
public virtual IDataReader GetTabsByModuleID(int moduleID)
Parameters
Type Name Description
int moduleID
Returns
Type Description
IDataReader

GetTabsByPackageID(int, int, bool)

Declaration
public virtual IDataReader GetTabsByPackageID(int portalID, int packageID, bool forHost)
Parameters
Type Name Description
int portalID
int packageID
bool forHost
Returns
Type Description
IDataReader

GetTabsByTabModuleID(int)

Declaration
public virtual IDataReader GetTabsByTabModuleID(int tabModuleID)
Parameters
Type Name Description
int tabModuleID
Returns
Type Description
IDataReader

GetTransaction()

Declaration
public virtual DbTransaction GetTransaction()
Returns
Type Description
DbTransaction

GetUnAuthorizedUsers(int, bool, bool)

Declaration
public virtual IDataReader GetUnAuthorizedUsers(int portalId, bool includeDeleted, bool superUsersOnly)
Parameters
Type Name Description
int portalId
bool includeDeleted
bool superUsersOnly
Returns
Type Description
IDataReader

GetUnappliedIterations(string)

Declaration
public virtual string GetUnappliedIterations(string version)
Parameters
Type Name Description
string version
Returns
Type Description
string

GetUrl(int, string)

Declaration
public virtual IDataReader GetUrl(int portalID, string url)
Parameters
Type Name Description
int portalID
string url
Returns
Type Description
IDataReader

GetUrlLog(int, DateTime, DateTime)

Declaration
public virtual IDataReader GetUrlLog(int urlTrackingID, DateTime startDate, DateTime endDate)
Parameters
Type Name Description
int urlTrackingID
DateTime startDate
DateTime endDate
Returns
Type Description
IDataReader

GetUrlTracking(int, string, int)

Declaration
public virtual IDataReader GetUrlTracking(int portalID, string url, int moduleID)
Parameters
Type Name Description
int portalID
string url
int moduleID
Returns
Type Description
IDataReader

GetUrls(int)

Declaration
public virtual IDataReader GetUrls(int portalID)
Parameters
Type Name Description
int portalID
Returns
Type Description
IDataReader

GetUser(int, int)

Declaration
public virtual IDataReader GetUser(int portalId, int userId)
Parameters
Type Name Description
int portalId
int userId
Returns
Type Description
IDataReader

GetUserAuthentication(int)

Declaration
public virtual IDataReader GetUserAuthentication(int userID)
Parameters
Type Name Description
int userID
Returns
Type Description
IDataReader

GetUserByAuthToken(int, string, string)

Declaration
public virtual IDataReader GetUserByAuthToken(int portalID, string userToken, string authType)
Parameters
Type Name Description
int portalID
string userToken
string authType
Returns
Type Description
IDataReader

GetUserByDisplayName(int, string)

Declaration
public virtual IDataReader GetUserByDisplayName(int portalId, string displayName)
Parameters
Type Name Description
int portalId
string displayName
Returns
Type Description
IDataReader

GetUserByPasswordResetToken(int, string)

Declaration
public virtual IDataReader GetUserByPasswordResetToken(int portalId, string resetToken)
Parameters
Type Name Description
int portalId
string resetToken
Returns
Type Description
IDataReader

GetUserByUsername(int, string)

Declaration
public virtual IDataReader GetUserByUsername(int portalId, string username)
Parameters
Type Name Description
int portalId
string username
Returns
Type Description
IDataReader

GetUserByUsername(string, string)

Declaration
public virtual IDataReader GetUserByUsername(string username, string spaceReplacement)
Parameters
Type Name Description
string username
string spaceReplacement
Returns
Type Description
IDataReader

GetUserByVanityUrl(int, string)

Declaration
public virtual IDataReader GetUserByVanityUrl(int portalId, string vanityUrl)
Parameters
Type Name Description
int portalId
string vanityUrl
Returns
Type Description
IDataReader

GetUserCountByPortal(int)

Declaration
public virtual int GetUserCountByPortal(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
int

GetUserProfile(int)

Declaration
public virtual IDataReader GetUserProfile(int userId)
Parameters
Type Name Description
int userId
Returns
Type Description
IDataReader

GetUserRole(int, int, int)

Declaration
public virtual IDataReader GetUserRole(int portalID, int userId, int roleId)
Parameters
Type Name Description
int portalID
int userId
int roleId
Returns
Type Description
IDataReader

GetUserRoles(int, int)

Declaration
public virtual IDataReader GetUserRoles(int portalID, int userId)
Parameters
Type Name Description
int portalID
int userId
Returns
Type Description
IDataReader

GetUserRolesByUsername(int, string, string)

Declaration
public virtual IDataReader GetUserRolesByUsername(int portalID, string username, string rolename)
Parameters
Type Name Description
int portalID
string username
string rolename
Returns
Type Description
IDataReader

GetUsersAdvancedSearch(int, int, int, int, int, bool, int, int, string, bool, string, string)

Declaration
public virtual IDataReader GetUsersAdvancedSearch(int portalId, int userId, int filterUserId, int fitlerRoleId, int relationTypeId, bool isAdmin, int pageIndex, int pageSize, string sortColumn, bool sortAscending, string propertyNames, string propertyValues)
Parameters
Type Name Description
int portalId
int userId
int filterUserId
int fitlerRoleId
int relationTypeId
bool isAdmin
int pageIndex
int pageSize
string sortColumn
bool sortAscending
string propertyNames
string propertyValues
Returns
Type Description
IDataReader

GetUsersBasicSearch(int, int, int, string, bool, string, string)

Declaration
public virtual IDataReader GetUsersBasicSearch(int portalId, int pageIndex, int pageSize, string sortColumn, bool sortAscending, string propertyName, string propertyValue)
Parameters
Type Name Description
int portalId
int pageIndex
int pageSize
string sortColumn
bool sortAscending
string propertyName
string propertyValue
Returns
Type Description
IDataReader

GetUsersByDisplayname(int, string, int, int, bool, bool)

Declaration
public virtual IDataReader GetUsersByDisplayname(int portalId, string name, int pageIndex, int pageSize, bool includeDeleted, bool superUsersOnly)
Parameters
Type Name Description
int portalId
string name
int pageIndex
int pageSize
bool includeDeleted
bool superUsersOnly
Returns
Type Description
IDataReader

GetUsersByEmail(int, string, int, int, bool, bool)

Declaration
public virtual IDataReader GetUsersByEmail(int portalID, string email, int pageIndex, int pageSize, bool includeDeleted, bool superUsersOnly)
Parameters
Type Name Description
int portalID
string email
int pageIndex
int pageSize
bool includeDeleted
bool superUsersOnly
Returns
Type Description
IDataReader

GetUsersByProfileProperty(int, string, string, int, int, bool, bool)

Declaration
public virtual IDataReader GetUsersByProfileProperty(int portalID, string propertyName, string propertyValue, int pageIndex, int pageSize, bool includeDeleted, bool superUsersOnly)
Parameters
Type Name Description
int portalID
string propertyName
string propertyValue
int pageIndex
int pageSize
bool includeDeleted
bool superUsersOnly
Returns
Type Description
IDataReader

GetUsersByRolename(int, string)

Declaration
public virtual IDataReader GetUsersByRolename(int portalID, string rolename)
Parameters
Type Name Description
int portalID
string rolename
Returns
Type Description
IDataReader

GetUsersByUsername(int, string, int, int, bool, bool)

Declaration
public virtual IDataReader GetUsersByUsername(int portalID, string username, int pageIndex, int pageSize, bool includeDeleted, bool superUsersOnly)
Parameters
Type Name Description
int portalID
string username
int pageIndex
int pageSize
bool includeDeleted
bool superUsersOnly
Returns
Type Description
IDataReader

GetVersion()

Declaration
public virtual Version GetVersion()
Returns
Type Description
Version

Instance()

Declaration
public static DataProvider Instance()
Returns
Type Description
DataProvider

LocalizeTab(int, string, int)

Declaration
public virtual void LocalizeTab(int tabId, string cultureCode, int lastModifiedByUserID)
Parameters
Type Name Description
int tabId
string cultureCode
int lastModifiedByUserID

MarkAsPublished(int)

Declaration
public virtual void MarkAsPublished(int tabId)
Parameters
Type Name Description
int tabId

MoveTabAfter(int, int, int)

Declaration
public virtual void MoveTabAfter(int tabId, int afterTabId, int lastModifiedByUserID)
Parameters
Type Name Description
int tabId
int afterTabId
int lastModifiedByUserID

MoveTabBefore(int, int, int)

Declaration
public virtual void MoveTabBefore(int tabId, int beforeTabId, int lastModifiedByUserID)
Parameters
Type Name Description
int tabId
int beforeTabId
int lastModifiedByUserID

MoveTabModule(int, int, int, string, int)

Declaration
public virtual void MoveTabModule(int fromTabId, int moduleId, int toTabId, string toPaneName, int lastModifiedByUserID)
Parameters
Type Name Description
int fromTabId
int moduleId
int toTabId
string toPaneName
int lastModifiedByUserID

MoveTabToParent(int, int, int)

Declaration
public virtual void MoveTabToParent(int tabId, int parentId, int lastModifiedByUserID)
Parameters
Type Name Description
int tabId
int parentId
int lastModifiedByUserID

PurgeExpiredOutputCacheItems()

Declaration
public virtual void PurgeExpiredOutputCacheItems()

PurgeLog()

Declaration
public virtual void PurgeLog()

PurgeOutputCache()

Declaration
public virtual void PurgeOutputCache()

PurgeScheduleHistory()

Declaration
public virtual void PurgeScheduleHistory()

RegisterAssembly(int, string, string)

Declaration
public virtual int RegisterAssembly(int packageID, string assemblyName, string version)
Parameters
Type Name Description
int packageID
string assemblyName
string version
Returns
Type Description
int

RemoveOutputCacheItem(int)

Declaration
public virtual void RemoveOutputCacheItem(int itemId)
Parameters
Type Name Description
int itemId

RemovePortalLocalization(int, string)

Declaration
public virtual void RemovePortalLocalization(int portalID, string cultureCode)
Parameters
Type Name Description
int portalID
string cultureCode

RemoveUser(int, int)

Declaration
public virtual void RemoveUser(int userId, int portalId)
Parameters
Type Name Description
int userId
int portalId

ReplaceServerOnSchedules(string, string)

Declaration
public virtual void ReplaceServerOnSchedules(string oldServername, string newServerName)
Parameters
Type Name Description
string oldServername
string newServerName

ResetFilePublishedVersion(int)

Declaration
public virtual void ResetFilePublishedVersion(int fileId)
Parameters
Type Name Description
int fileId

ResetTermsAgreement(int)

Declaration
public virtual void ResetTermsAgreement(int portalId)
Parameters
Type Name Description
int portalId

RestoreTabModule(int, int)

Declaration
public virtual void RestoreTabModule(int tabId, int moduleId)
Parameters
Type Name Description
int tabId
int moduleId

RestoreUser(int, int)

Declaration
public virtual void RestoreUser(int userId, int portalId)
Parameters
Type Name Description
int userId
int portalId

RollbackTransaction(DbTransaction)

Declaration
public virtual void RollbackTransaction(DbTransaction transaction)
Parameters
Type Name Description
DbTransaction transaction

SaveExtensionUrlProviderSetting(int, int, string, string)

Declaration
public virtual void SaveExtensionUrlProviderSetting(int providerId, int portalId, string settingName, string settingValue)
Parameters
Type Name Description
int providerId
int portalId
string settingName
string settingValue

SavePackageDependency(int, int, string, string)

Declaration
public virtual int SavePackageDependency(int packageDependencyId, int packageId, string packageName, string version)
Parameters
Type Name Description
int packageDependencyId
int packageId
string packageName
string version
Returns
Type Description
int

SavePreviewProfile(int, int, string, int, int, string, int, int)

Declaration
public virtual int SavePreviewProfile(int id, int portalId, string name, int width, int height, string userAgent, int sortOrder, int userId)
Parameters
Type Name Description
int id
int portalId
string name
int width
int height
string userAgent
int sortOrder
int userId
Returns
Type Description
int

SaveRedirection(int, int, string, int, int, int, bool, int, object, bool, int)

Declaration
public virtual int SaveRedirection(int id, int portalId, string name, int type, int sortOrder, int sourceTabId, bool includeChildTabs, int targetType, object targetValue, bool enabled, int userId)
Parameters
Type Name Description
int id
int portalId
string name
int type
int sortOrder
int sourceTabId
bool includeChildTabs
int targetType
object targetValue
bool enabled
int userId
Returns
Type Description
int

SaveRedirectionRule(int, int, string, string)

Declaration
public virtual void SaveRedirectionRule(int id, int redirectionId, string capbility, string expression)
Parameters
Type Name Description
int id
int redirectionId
string capbility
string expression

SaveTabUrl(int, int, int, int, string, string, string, string, bool, int)

Declaration
public virtual void SaveTabUrl(int tabId, int seqNum, int portalAliasId, int portalAliasUsage, string url, string queryString, string cultureCode, string httpStatus, bool isSystem, int modifiedByUserID)
Parameters
Type Name Description
int tabId
int seqNum
int portalAliasId
int portalAliasUsage
string url
string queryString
string cultureCode
string httpStatus
bool isSystem
int modifiedByUserID

SaveTabVersion(int, int, DateTime, int, bool, int, int)

Declaration
public virtual int SaveTabVersion(int tabVersionId, int tabId, DateTime timeStamp, int version, bool isPublished, int createdByUserID, int modifiedByUserID)
Parameters
Type Name Description
int tabVersionId
int tabId
DateTime timeStamp
int version
bool isPublished
int createdByUserID
int modifiedByUserID
Returns
Type Description
int

SaveTabVersionDetail(int, int, int, int, string, int, int, int, int)

Declaration
public virtual int SaveTabVersionDetail(int tabVersionDetailId, int tabVersionId, int moduleId, int moduleVersion, string paneName, int moduleOrder, int action, int createdByUserID, int modifiedByUserID)
Parameters
Type Name Description
int tabVersionDetailId
int tabVersionId
int moduleId
int moduleVersion
string paneName
int moduleOrder
int action
int createdByUserID
int modifiedByUserID
Returns
Type Description
int

SearchProfilePropertyValues(int, string, string)

Declaration
public virtual IDataReader SearchProfilePropertyValues(int portalId, string propertyName, string searchString)
Parameters
Type Name Description
int portalId
string propertyName
string searchString
Returns
Type Description
IDataReader

SetAllPortalTabsSecure(int, bool)

Declaration
public virtual void SetAllPortalTabsSecure(int portalId, bool secure)
Parameters
Type Name Description
int portalId
bool secure

SetCorePackageVersions()

Declaration
public virtual void SetCorePackageVersions()

SetEventMessageComplete(int)

Declaration
public virtual void SetEventMessageComplete(int eventMessageId)
Parameters
Type Name Description
int eventMessageId

SetFileHasBeenPublished(int, bool)

Declaration
public virtual void SetFileHasBeenPublished(int fileId, bool hasBeenPublished)
Parameters
Type Name Description
int fileId
bool hasBeenPublished

SetPublishedVersion(int, int)

Declaration
public void SetPublishedVersion(int fileId, int newPublishedVersion)
Parameters
Type Name Description
int fileId
int newPublishedVersion

TestDatabaseConnection(DbConnectionStringBuilder, string, string)

Declaration
public virtual string TestDatabaseConnection(DbConnectionStringBuilder builder, string owner, string qualifier)
Parameters
Type Name Description
DbConnectionStringBuilder builder
string owner
string qualifier
Returns
Type Description
string

UnRegisterAssembly(int, string)

Declaration
public virtual bool UnRegisterAssembly(int packageID, string assemblyName)
Parameters
Type Name Description
int packageID
string assemblyName
Returns
Type Description
bool

UpdateAuthCookie(string, DateTime, int)

Declaration
public virtual void UpdateAuthCookie(string cookieValue, DateTime utcExpiry, int userId)
Parameters
Type Name Description
string cookieValue
DateTime utcExpiry
int userId

UpdateAuthentication(int, int, string, bool, string, string, string, int)

Declaration
public virtual void UpdateAuthentication(int authenticationID, int packageID, string authenticationType, bool isEnabled, string settingsControlSrc, string loginControlSrc, string logoffControlSrc, int lastModifiedByUserID)
Parameters
Type Name Description
int authenticationID
int packageID
string authenticationType
bool isEnabled
string settingsControlSrc
string loginControlSrc
string logoffControlSrc
int lastModifiedByUserID

UpdateContentWorkflow(int, string, string, bool, bool, bool, bool)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use IWorkflowEngine. Scheduled for removal in v10.0.0.")]
public virtual void UpdateContentWorkflow(int workflowId, string workflowName, string description, bool isDeleted, bool startAfterCreating, bool startAfterEditing, bool dispositionEnabled)
Parameters
Type Name Description
int workflowId
string workflowName
string description
bool isDeleted
bool startAfterCreating
bool startAfterEditing
bool dispositionEnabled

UpdateContentWorkflowState(int, string, int, bool, bool, bool, bool, string, string, string, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use IWorkflowEngine. Scheduled for removal in v10.0.0.")]
public virtual void UpdateContentWorkflowState(int stateId, string stateName, int order, bool isActive, bool sendEmail, bool sendMessage, bool isDisposalState, string onCompleteMessageSubject, string onCompleteMessageBody, string onDiscardMessageSubject, string onDiscardMessageBody)
Parameters
Type Name Description
int stateId
string stateName
int order
bool isActive
bool sendEmail
bool sendMessage
bool isDisposalState
string onCompleteMessageSubject
string onCompleteMessageBody
string onDiscardMessageSubject
string onDiscardMessageBody

UpdateContentWorkflowStatePermission(int, int, int, int, bool, int, int)

Declaration
public virtual void UpdateContentWorkflowStatePermission(int workflowStatePermissionId, int stateId, int permissionId, int roleId, bool allowAccess, int userId, int lastModifiedByUserId)
Parameters
Type Name Description
int workflowStatePermissionId
int stateId
int permissionId
int roleId
bool allowAccess
int userId
int lastModifiedByUserId

UpdateDatabaseVersion(int, int, int, string)

Declaration
public virtual void UpdateDatabaseVersion(int major, int minor, int build, string name)
Parameters
Type Name Description
int major
int minor
int build
string name

UpdateDatabaseVersionIncrement(int, int, int, int, string)

Declaration
public virtual void UpdateDatabaseVersionIncrement(int major, int minor, int build, int increment, string appName)
Parameters
Type Name Description
int major
int minor
int build
int increment
string appName

UpdateDesktopModule(int, int, string, string, string, string, string, bool, bool, string, int, int, string, string, string, int, int, string, string)

Declaration
public virtual void UpdateDesktopModule(int desktopModuleId, int packageID, string moduleName, string folderName, string friendlyName, string description, string version, bool isPremium, bool isAdmin, string businessControllerClass, int supportedFeatures, int shareable, string compatibleVersions, string dependencies, string permissions, int contentItemId, int lastModifiedByUserID, string adminpage, string hostpage)
Parameters
Type Name Description
int desktopModuleId
int packageID
string moduleName
string folderName
string friendlyName
string description
string version
bool isPremium
bool isAdmin
string businessControllerClass
int supportedFeatures
int shareable
string compatibleVersions
string dependencies
string permissions
int contentItemId
int lastModifiedByUserID
string adminpage
string hostpage

UpdateDesktopModulePermission(int, int, int, int, bool, int, int)

Declaration
public virtual void UpdateDesktopModulePermission(int desktopModulePermissionID, int portalDesktopModuleID, int permissionID, int roleID, bool allowAccess, int userID, int lastModifiedByUserID)
Parameters
Type Name Description
int desktopModulePermissionID
int portalDesktopModuleID
int permissionID
int roleID
bool allowAccess
int userID
int lastModifiedByUserID

UpdateEventLogPendingNotif(int)

Declaration
public virtual void UpdateEventLogPendingNotif(int logConfigID)
Parameters
Type Name Description
int logConfigID

UpdateExtensionUrlProvider(int, bool)

Declaration
public virtual void UpdateExtensionUrlProvider(int providerId, bool isActive)
Parameters
Type Name Description
int providerId
bool isActive

UpdateFile(int, Guid, string, string, long, int, int, string, int, int, string, DateTime, string, string, DateTime, DateTime, bool, int)

Declaration
public virtual void UpdateFile(int fileId, Guid versionGuid, string fileName, string extension, long size, int width, int height, string contentType, int folderId, int lastModifiedByUserID, string hash, DateTime lastModificationTime, string title, string description, DateTime startDate, DateTime endDate, bool enablePublishPeriod, int contentItemId)
Parameters
Type Name Description
int fileId
Guid versionGuid
string fileName
string extension
long size
int width
int height
string contentType
int folderId
int lastModifiedByUserID
string hash
DateTime lastModificationTime
string title
string description
DateTime startDate
DateTime endDate
bool enablePublishPeriod
int contentItemId

UpdateFileContent(int, byte[])

Declaration
public virtual void UpdateFileContent(int fileId, byte[] content)
Parameters
Type Name Description
int fileId
byte[] content

UpdateFileHashCode(int, string)

Declaration
public virtual void UpdateFileHashCode(int fileId, string hashCode)
Parameters
Type Name Description
int fileId
string hashCode

UpdateFileLastModificationTime(int, DateTime)

Declaration
public virtual void UpdateFileLastModificationTime(int fileId, DateTime lastModificationTime)
Parameters
Type Name Description
int fileId
DateTime lastModificationTime

UpdateFileVersion(int, Guid)

Declaration
public virtual void UpdateFileVersion(int fileId, Guid versionGuid)
Parameters
Type Name Description
int fileId
Guid versionGuid

UpdateFolder(int, Guid, int, string, int, string, bool, bool, DateTime, int, int, bool, int, int)

Declaration
public virtual void UpdateFolder(int portalId, Guid versionGuid, int folderId, string folderPath, int storageLocation, string mappedPath, bool isProtected, bool isCached, DateTime lastUpdated, int lastModifiedByUserID, int folderMappingID, bool isVersioned, int workflowID, int parentID)
Parameters
Type Name Description
int portalId
Guid versionGuid
int folderId
string folderPath
int storageLocation
string mappedPath
bool isProtected
bool isCached
DateTime lastUpdated
int lastModifiedByUserID
int folderMappingID
bool isVersioned
int workflowID
int parentID

UpdateFolderMapping(int, string, int, int)

Declaration
public virtual void UpdateFolderMapping(int folderMappingID, string mappingName, int priority, int lastModifiedByUserID)
Parameters
Type Name Description
int folderMappingID
string mappingName
int priority
int lastModifiedByUserID

UpdateFolderMappingSetting(int, string, string, int)

Declaration
public virtual void UpdateFolderMappingSetting(int folderMappingID, string settingName, string settingValue, int lastModifiedByUserID)
Parameters
Type Name Description
int folderMappingID
string settingName
string settingValue
int lastModifiedByUserID

UpdateFolderPermission(int, int, int, int, bool, int, int)

Declaration
public virtual void UpdateFolderPermission(int folderPermissionID, int folderID, int permissionID, int roleID, bool allowAccess, int userID, int lastModifiedByUserID)
Parameters
Type Name Description
int folderPermissionID
int folderID
int permissionID
int roleID
bool allowAccess
int userID
int lastModifiedByUserID

UpdateFolderVersion(int, Guid)

Declaration
public virtual void UpdateFolderVersion(int folderId, Guid versionGuid)
Parameters
Type Name Description
int folderId
Guid versionGuid

UpdateHostSetting(string, string, bool, int)

Declaration
public virtual void UpdateHostSetting(string settingName, string settingValue, bool settingIsSecure, int lastModifiedByUserID)
Parameters
Type Name Description
string settingName
string settingValue
bool settingIsSecure
int lastModifiedByUserID

UpdateIPFilter(int, string, string, int, int)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.11.1. Use the overload that takes a notes string. Scheduled for removal in v11.0.0.")]
public virtual void UpdateIPFilter(int ipFilterid, string ipAddress, string subnetMask, int ruleType, int lastModifiedByUserId)
Parameters
Type Name Description
int ipFilterid
string ipAddress
string subnetMask
int ruleType
int lastModifiedByUserId

UpdateIPFilter(int, string, string, int, int, string)

Declaration
public virtual void UpdateIPFilter(int ipFilterid, string ipAddress, string subnetMask, int ruleType, int lastModifiedByUserId, string notes)
Parameters
Type Name Description
int ipFilterid
string ipAddress
string subnetMask
int ruleType
int lastModifiedByUserId
string notes

UpdateLanguage(int, string, string, string, int)

Declaration
public virtual void UpdateLanguage(int languageID, string cultureCode, string cultureName, string fallbackCulture, int lastModifiedByUserID)
Parameters
Type Name Description
int languageID
string cultureCode
string cultureName
string fallbackCulture
int lastModifiedByUserID

UpdateLanguagePack(int, int, int, int, int)

Declaration
public virtual int UpdateLanguagePack(int languagePackID, int packageID, int languageID, int dependentPackageID, int lastModifiedByUserID)
Parameters
Type Name Description
int languagePackID
int packageID
int languageID
int dependentPackageID
int lastModifiedByUserID
Returns
Type Description
int

UpdateLegacyFolders()

Declaration
public virtual IDataReader UpdateLegacyFolders()
Returns
Type Description
IDataReader

UpdateListEntry(int, string, string, string, int)

Declaration
public virtual void UpdateListEntry(int entryID, string value, string text, string description, int lastModifiedByUserID)
Parameters
Type Name Description
int entryID
string value
string text
string description
int lastModifiedByUserID

UpdateListSortOrder(int, bool)

Declaration
public virtual void UpdateListSortOrder(int entryID, bool moveUp)
Parameters
Type Name Description
int entryID
bool moveUp

UpdateLogType(string, string, string, string, string)

Declaration
public virtual void UpdateLogType(string logTypeKey, string logTypeFriendlyName, string logTypeDescription, string logTypeCSSClass, string logTypeOwner)
Parameters
Type Name Description
string logTypeKey
string logTypeFriendlyName
string logTypeDescription
string logTypeCSSClass
string logTypeOwner

UpdateLogTypeConfigInfo(string, bool, string, string, int, bool, int, int, int, string, string)

Declaration
public virtual void UpdateLogTypeConfigInfo(string id, bool loggingIsActive, string logTypeKey, string logTypePortalID, int keepMostRecent, bool emailNotificationIsActive, int threshold, int notificationThresholdTime, int notificationThresholdTimeType, string mailFromAddress, string mailToAddress)
Parameters
Type Name Description
string id
bool loggingIsActive
string logTypeKey
string logTypePortalID
int keepMostRecent
bool emailNotificationIsActive
int threshold
int notificationThresholdTime
int notificationThresholdTimeType
string mailFromAddress
string mailToAddress

UpdateModule(int, int, int, bool, DateTime, DateTime, bool, bool, bool, bool, int)

Declaration
public virtual void UpdateModule(int moduleId, int moduleDefId, int contentItemId, bool allTabs, DateTime startDate, DateTime endDate, bool inheritViewPermissions, bool isShareable, bool isShareableViewOnly, bool isDeleted, int lastModifiedByUserID)
Parameters
Type Name Description
int moduleId
int moduleDefId
int contentItemId
bool allTabs
DateTime startDate
DateTime endDate
bool inheritViewPermissions
bool isShareable
bool isShareableViewOnly
bool isDeleted
int lastModifiedByUserID

UpdateModuleControl(int, int, string, string, string, string, int, int, string, bool, bool, int)

Declaration
public virtual void UpdateModuleControl(int moduleControlId, int moduleDefId, string controlKey, string controlTitle, string controlSrc, string iconFile, int controlType, int viewOrder, string helpUrl, bool supportsPartialRendering, bool supportsPopUps, int lastModifiedByUserID)
Parameters
Type Name Description
int moduleControlId
int moduleDefId
string controlKey
string controlTitle
string controlSrc
string iconFile
int controlType
int viewOrder
string helpUrl
bool supportsPartialRendering
bool supportsPopUps
int lastModifiedByUserID

UpdateModuleDefinition(int, string, string, int, int)

Declaration
public virtual void UpdateModuleDefinition(int moduleDefId, string friendlyName, string definitionName, int defaultCacheTime, int lastModifiedByUserID)
Parameters
Type Name Description
int moduleDefId
string friendlyName
string definitionName
int defaultCacheTime
int lastModifiedByUserID

UpdateModuleLastContentModifiedOnDate(int)

Declaration
public virtual void UpdateModuleLastContentModifiedOnDate(int moduleId)
Parameters
Type Name Description
int moduleId

UpdateModuleOrder(int, int, int, string)

Declaration
public virtual void UpdateModuleOrder(int tabId, int moduleId, int moduleOrder, string paneName)
Parameters
Type Name Description
int tabId
int moduleId
int moduleOrder
string paneName

UpdateModulePermission(int, int, int, int, int, bool, int, int)

Declaration
public virtual void UpdateModulePermission(int modulePermissionId, int moduleId, int portalId, int permissionId, int roleId, bool allowAccess, int userId, int lastModifiedByUserId)
Parameters
Type Name Description
int modulePermissionId
int moduleId
int portalId
int permissionId
int roleId
bool allowAccess
int userId
int lastModifiedByUserId

UpdateModuleSetting(int, string, string, int)

Declaration
public virtual void UpdateModuleSetting(int moduleId, string settingName, string settingValue, int lastModifiedByUserID)
Parameters
Type Name Description
int moduleId
string settingName
string settingValue
int lastModifiedByUserID

UpdatePackage(int, int, string, string, string, string, string, string, string, string, string, string, string, bool, int, string, string)

Declaration
public virtual void UpdatePackage(int packageID, int portalID, string friendlyName, string description, string type, string version, string license, string manifest, string owner, string organization, string url, string email, string releaseNotes, bool isSystemPackage, int lastModifiedByUserID, string folderName, string iconFile)
Parameters
Type Name Description
int packageID
int portalID
string friendlyName
string description
string type
string version
string license
string manifest
string owner
string organization
string url
string email
string releaseNotes
bool isSystemPackage
int lastModifiedByUserID
string folderName
string iconFile

UpdatePermission(int, string, int, string, string, int)

Declaration
public virtual void UpdatePermission(int permissionID, string permissionCode, int moduleDefID, string permissionKey, string permissionName, int lastModifiedByUserID)
Parameters
Type Name Description
int permissionID
string permissionCode
int moduleDefID
string permissionKey
string permissionName
int lastModifiedByUserID

UpdatePortalAlias(string, int)

Declaration
public virtual void UpdatePortalAlias(string portalAlias, int lastModifiedByUserID)
Parameters
Type Name Description
string portalAlias
int lastModifiedByUserID

UpdatePortalAliasInfo(int, int, string, string, string, string, bool, int)

Declaration
public virtual void UpdatePortalAliasInfo(int portalAliasID, int portalID, string hTTPAlias, string cultureCode, string skin, string browserType, bool isPrimary, int lastModifiedByUserID)
Parameters
Type Name Description
int portalAliasID
int portalID
string hTTPAlias
string cultureCode
string skin
string browserType
bool isPrimary
int lastModifiedByUserID

UpdatePortalDefaultLanguage(int, string)

Declaration
public virtual void UpdatePortalDefaultLanguage(int portalID, string cultureCode)
Parameters
Type Name Description
int portalID
string cultureCode

UpdatePortalInfo(int, int, string, string, string, DateTime, int, int, string, int, double, double, int, int, string, string, string, string, string, string, int, int, int, int, int, int, int, int, int, int, int, string, string, int, string)

Declaration
public virtual void UpdatePortalInfo(int portalId, int portalGroupId, string portalName, string logoFile, string footerText, DateTime expiryDate, int userRegistration, int bannerAdvertising, string currency, int administratorId, double hostFee, double hostSpace, int pageQuota, int userQuota, string paymentProcessor, string processorUserId, string processorPassword, string description, string keyWords, string backgroundFile, int siteLogHistory, int splashTabId, int homeTabId, int loginTabId, int registerTabId, int userTabId, int searchTabId, int custom404TabId, int custom500TabId, int termsTabId, int privacyTabId, string defaultLanguage, string homeDirectory, int lastModifiedByUserID, string cultureCode)
Parameters
Type Name Description
int portalId
int portalGroupId
string portalName
string logoFile
string footerText
DateTime expiryDate
int userRegistration
int bannerAdvertising
string currency
int administratorId
double hostFee
double hostSpace
int pageQuota
int userQuota
string paymentProcessor
string processorUserId
string processorPassword
string description
string keyWords
string backgroundFile
int siteLogHistory
int splashTabId
int homeTabId
int loginTabId
int registerTabId
int userTabId
int searchTabId
int custom404TabId
int custom500TabId
int termsTabId
int privacyTabId
string defaultLanguage
string homeDirectory
int lastModifiedByUserID
string cultureCode

UpdatePortalLanguage(int, int, bool, int)

Declaration
public virtual void UpdatePortalLanguage(int portalID, int languageID, bool isPublished, int updatedByUserID)
Parameters
Type Name Description
int portalID
int languageID
bool isPublished
int updatedByUserID

UpdatePortalSetting(int, string, string, int, string, bool)

Declaration
public virtual void UpdatePortalSetting(int portalId, string settingName, string settingValue, int userId, string cultureCode, bool isSecure)
Parameters
Type Name Description
int portalId
string settingName
string settingValue
int userId
string cultureCode
bool isSecure

UpdatePortalSetup(int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, string)

Declaration
public virtual void UpdatePortalSetup(int portalId, int administratorId, int administratorRoleId, int registeredRoleId, int splashTabId, int homeTabId, int loginTabId, int registerTabId, int userTabId, int searchTabId, int custom404TabId, int custom500TabId, int termsTabId, int privacyTabId, int adminTabId, string cultureCode)
Parameters
Type Name Description
int portalId
int administratorId
int administratorRoleId
int registeredRoleId
int splashTabId
int homeTabId
int loginTabId
int registerTabId
int userTabId
int searchTabId
int custom404TabId
int custom500TabId
int termsTabId
int privacyTabId
int adminTabId
string cultureCode

UpdateProfile(int, int, string)

Declaration
public virtual void UpdateProfile(int userId, int portalId, string profileData)
Parameters
Type Name Description
int userId
int portalId
string profileData

UpdateProfileProperty(int, int, int, string, int, string, DateTime)

Declaration
public virtual void UpdateProfileProperty(int profileId, int userId, int propertyDefinitionID, string propertyValue, int visibility, string extendedVisibility, DateTime lastUpdatedDate)
Parameters
Type Name Description
int profileId
int userId
int propertyDefinitionID
string propertyValue
int visibility
string extendedVisibility
DateTime lastUpdatedDate

UpdatePropertyDefinition(int, int, string, string, string, bool, bool, string, int, bool, int, int, int)

Declaration
public virtual void UpdatePropertyDefinition(int propertyDefinitionId, int dataType, string defaultValue, string propertyCategory, string propertyName, bool readOnly, bool required, string validation, int viewOrder, bool visible, int length, int defaultVisibility, int lastModifiedByUserId)
Parameters
Type Name Description
int propertyDefinitionId
int dataType
string defaultValue
string propertyCategory
string propertyName
bool readOnly
bool required
string validation
int viewOrder
bool visible
int length
int defaultVisibility
int lastModifiedByUserId

UpdateRole(int, int, string, string, float, string, string, float, int, string, bool, bool, string, string, int, int, int, bool)

Declaration
public virtual void UpdateRole(int roleId, int roleGroupId, string roleName, string description, float serviceFee, string billingPeriod, string billingFrequency, float trialFee, int trialPeriod, string trialFrequency, bool isPublic, bool autoAssignment, string rsvpCode, string iconFile, int lastModifiedByUserID, int status, int securityMode, bool isSystemRole)
Parameters
Type Name Description
int roleId
int roleGroupId
string roleName
string description
float serviceFee
string billingPeriod
string billingFrequency
float trialFee
int trialPeriod
string trialFrequency
bool isPublic
bool autoAssignment
string rsvpCode
string iconFile
int lastModifiedByUserID
int status
int securityMode
bool isSystemRole

UpdateRoleGroup(int, string, string, int)

Declaration
public virtual void UpdateRoleGroup(int roleGroupId, string groupName, string description, int lastModifiedByUserID)
Parameters
Type Name Description
int roleGroupId
string groupName
string description
int lastModifiedByUserID

UpdateRoleSetting(int, string, string, int)

Declaration
public virtual void UpdateRoleSetting(int roleId, string settingName, string settingValue, int lastModifiedByUserID)
Parameters
Type Name Description
int roleId
string settingName
string settingValue
int lastModifiedByUserID

UpdateSchedule(int, string, int, string, int, string, int, string, bool, bool, string, string, int, string, DateTime)

Declaration
public virtual void UpdateSchedule(int scheduleID, string typeFullName, int timeLapse, string timeLapseMeasurement, int retryTimeLapse, string retryTimeLapseMeasurement, int retainHistoryNum, string attachToEvent, bool catchUpEnabled, bool enabled, string objectDependencies, string servers, int lastModifiedByUserID, string friendlyName, DateTime scheduleStartDate)
Parameters
Type Name Description
int scheduleID
string typeFullName
int timeLapse
string timeLapseMeasurement
int retryTimeLapse
string retryTimeLapseMeasurement
int retainHistoryNum
string attachToEvent
bool catchUpEnabled
bool enabled
string objectDependencies
string servers
int lastModifiedByUserID
string friendlyName
DateTime scheduleStartDate

UpdateScheduleHistory(int, DateTime, bool, string, DateTime)

Declaration
public virtual void UpdateScheduleHistory(int scheduleHistoryID, DateTime endDate, bool succeeded, string logNotes, DateTime nextStart)
Parameters
Type Name Description
int scheduleHistoryID
DateTime endDate
bool succeeded
string logNotes
DateTime nextStart

UpdateSearchStopWords(int, string, int)

Declaration
public virtual void UpdateSearchStopWords(int stopWordsId, string stopWords, int lastModifiedUserId)
Parameters
Type Name Description
int stopWordsId
string stopWords
int lastModifiedUserId

UpdateServer(int, string, string, bool, string)

Declaration
public virtual void UpdateServer(int serverId, string url, string uniqueId, bool enabled, string group)
Parameters
Type Name Description
int serverId
string url
string uniqueId
bool enabled
string group

UpdateServerActivity(string, string, DateTime, DateTime, int, bool)

Declaration
public virtual int UpdateServerActivity(string serverName, string iisAppName, DateTime createdDate, DateTime lastActivityDate, int pingFailureCount, bool enabled)
Parameters
Type Name Description
string serverName
string iisAppName
DateTime createdDate
DateTime lastActivityDate
int pingFailureCount
bool enabled
Returns
Type Description
int

UpdateSkin(int, string)

Declaration
public virtual void UpdateSkin(int skinID, string skinSrc)
Parameters
Type Name Description
int skinID
string skinSrc

UpdateSkinControl(int, int, string, string, bool, int)

Declaration
public virtual void UpdateSkinControl(int skinControlID, int packageID, string controlKey, string controlSrc, bool supportsPartialRendering, int lastModifiedByUserID)
Parameters
Type Name Description
int skinControlID
int packageID
string controlKey
string controlSrc
bool supportsPartialRendering
int lastModifiedByUserID

UpdateSkinPackage(int, int, int, string, string, int)

Declaration
public virtual void UpdateSkinPackage(int skinPackageID, int packageID, int portalID, string skinName, string skinType, int lastModifiedByUserID)
Parameters
Type Name Description
int skinPackageID
int packageID
int portalID
string skinName
string skinType
int lastModifiedByUserID

UpdateSynonymsGroup(int, string, int)

Declaration
public virtual void UpdateSynonymsGroup(int synonymsGroupId, string synonymsTags, int lastModifiedUserId)
Parameters
Type Name Description
int synonymsGroupId
string synonymsTags
int lastModifiedUserId

UpdateTab(int, int, int, Guid, Guid, Guid, string, bool, bool, int, string, string, string, string, string, bool, string, string, string, DateTime, DateTime, int, string, bool, bool, float, int, string, bool)

Declaration
public virtual void UpdateTab(int tabId, int contentItemId, int portalId, Guid versionGuid, Guid defaultLanguageGuid, Guid localizedVersionGuid, string tabName, bool isVisible, bool disableLink, int parentId, string iconFile, string iconFileLarge, string title, string description, string keyWords, bool isDeleted, string url, string skinSrc, string containerSrc, DateTime startDate, DateTime endDate, int refreshInterval, string pageHeadText, bool isSecure, bool permanentRedirect, float siteMapPriority, int lastModifiedByuserID, string cultureCode, bool isSystem)
Parameters
Type Name Description
int tabId
int contentItemId
int portalId
Guid versionGuid
Guid defaultLanguageGuid
Guid localizedVersionGuid
string tabName
bool isVisible
bool disableLink
int parentId
string iconFile
string iconFileLarge
string title
string description
string keyWords
bool isDeleted
string url
string skinSrc
string containerSrc
DateTime startDate
DateTime endDate
int refreshInterval
string pageHeadText
bool isSecure
bool permanentRedirect
float siteMapPriority
int lastModifiedByuserID
string cultureCode
bool isSystem

UpdateTabModule(int, int, int, string, string, string, int, string, int, string, string, string, string, string, int, string, bool, bool, bool, bool, string, DateTime, int, Guid, Guid, Guid, string, int)

Declaration
public virtual void UpdateTabModule(int tabModuleId, int tabId, int moduleId, string moduleTitle, string header, string footer, int moduleOrder, string paneName, int cacheTime, string cacheMethod, string alignment, string color, string border, string iconFile, int visibility, string containerSrc, bool displayTitle, bool displayPrint, bool displaySyndicate, bool isWebSlice, string webSliceTitle, DateTime webSliceExpiryDate, int webSliceTTL, Guid versionGuid, Guid defaultLanguageGuid, Guid localizedVersionGuid, string cultureCode, int lastModifiedByUserID)
Parameters
Type Name Description
int tabModuleId
int tabId
int moduleId
string moduleTitle
string header
string footer
int moduleOrder
string paneName
int cacheTime
string cacheMethod
string alignment
string color
string border
string iconFile
int visibility
string containerSrc
bool displayTitle
bool displayPrint
bool displaySyndicate
bool isWebSlice
string webSliceTitle
DateTime webSliceExpiryDate
int webSliceTTL
Guid versionGuid
Guid defaultLanguageGuid
Guid localizedVersionGuid
string cultureCode
int lastModifiedByUserID

UpdateTabModuleSetting(int, string, string, int)

Declaration
public virtual void UpdateTabModuleSetting(int tabModuleId, string settingName, string settingValue, int lastModifiedByUserID)
Parameters
Type Name Description
int tabModuleId
string settingName
string settingValue
int lastModifiedByUserID

UpdateTabModuleTranslationStatus(int, Guid, int)

Declaration
public virtual void UpdateTabModuleTranslationStatus(int tabModuleId, Guid localizedVersionGuid, int lastModifiedByUserId)
Parameters
Type Name Description
int tabModuleId
Guid localizedVersionGuid
int lastModifiedByUserId

UpdateTabModuleVersion(int, Guid)

Declaration
public virtual void UpdateTabModuleVersion(int tabModuleId, Guid versionGuid)
Parameters
Type Name Description
int tabModuleId
Guid versionGuid

UpdateTabModuleVersionByModule(int)

Declaration
public virtual void UpdateTabModuleVersionByModule(int moduleId)
Parameters
Type Name Description
int moduleId

UpdateTabOrder(int, int, int, int)

Declaration
public virtual void UpdateTabOrder(int tabId, int tabOrder, int parentId, int lastModifiedByUserID)
Parameters
Type Name Description
int tabId
int tabOrder
int parentId
int lastModifiedByUserID

UpdateTabPermission(int, int, int, int, bool, int, int)

Declaration
public virtual void UpdateTabPermission(int tabPermissionId, int tabId, int permissionId, int roleID, bool allowAccess, int userId, int lastModifiedByUserID)
Parameters
Type Name Description
int tabPermissionId
int tabId
int permissionId
int roleID
bool allowAccess
int userId
int lastModifiedByUserID

UpdateTabSetting(int, string, string, int)

Declaration
public virtual void UpdateTabSetting(int tabId, string settingName, string settingValue, int lastModifiedByUserID)
Parameters
Type Name Description
int tabId
string settingName
string settingValue
int lastModifiedByUserID

UpdateTabTranslationStatus(int, Guid, int)

Declaration
public virtual void UpdateTabTranslationStatus(int tabId, Guid localizedVersionGuid, int lastModifiedByUserID)
Parameters
Type Name Description
int tabId
Guid localizedVersionGuid
int lastModifiedByUserID

UpdateTabVersion(int, Guid)

Declaration
public virtual void UpdateTabVersion(int tabId, Guid versionGuid)
Parameters
Type Name Description
int tabId
Guid versionGuid

UpdateUrlTracking(int, string, bool, bool, int, bool)

Declaration
public virtual void UpdateUrlTracking(int portalID, string url, bool logActivity, bool trackClicks, int moduleID, bool newWindow)
Parameters
Type Name Description
int portalID
string url
bool logActivity
bool trackClicks
int moduleID
bool newWindow

UpdateUrlTrackingStats(int, string, int)

Declaration
public virtual void UpdateUrlTrackingStats(int portalID, string url, int moduleID)
Parameters
Type Name Description
int portalID
string url
int moduleID

UpdateUser(int, int, string, string, bool, string, string, string, bool, bool, bool, string, Guid, DateTime, bool, int)

Declaration
public virtual void UpdateUser(int userId, int portalID, string firstName, string lastName, bool isSuperUser, string email, string displayName, string vanityUrl, bool updatePassword, bool isApproved, bool refreshRoles, string lastIpAddress, Guid passwordResetToken, DateTime passwordResetExpiration, bool isDeleted, int lastModifiedByUserID)
Parameters
Type Name Description
int userId
int portalID
string firstName
string lastName
bool isSuperUser
string email
string displayName
string vanityUrl
bool updatePassword
bool isApproved
bool refreshRoles
string lastIpAddress
Guid passwordResetToken
DateTime passwordResetExpiration
bool isDeleted
int lastModifiedByUserID

UpdateUserLastIpAddress(int, string)

Declaration
public virtual void UpdateUserLastIpAddress(int userId, string lastIpAddress)
Parameters
Type Name Description
int userId
string lastIpAddress

UpdateUserRole(int, int, bool, DateTime, DateTime, int)

Declaration
public virtual void UpdateUserRole(int userRoleId, int status, bool isOwner, DateTime effectiveDate, DateTime expiryDate, int lastModifiedByUserID)
Parameters
Type Name Description
int userRoleId
int status
bool isOwner
DateTime effectiveDate
DateTime expiryDate
int lastModifiedByUserID

UpdateUsersOnline(Hashtable)

Declaration
[Obsolete("Deprecated in DotNetNuke 8.0.0. Other solutions exist outside of the DNN Platform. Scheduled for removal in v11.0.0.")]
public virtual void UpdateUsersOnline(Hashtable userList)
Parameters
Type Name Description
Hashtable userList

UserAgreedToTerms(int, int)

Declaration
public virtual void UserAgreedToTerms(int portalId, int userId)
Parameters
Type Name Description
int portalId
int userId

UserRequestsRemoval(int, int, bool)

Declaration
public virtual void UserRequestsRemoval(int portalId, int userId, bool remove)
Parameters
Type Name Description
int portalId
int userId
bool remove

Extension Methods