Class ControlBarController

Inheritance
object
DnnApiController
ControlBarController
Inherited Members
Namespace: DotNetNuke.Web.InternalServices
Assembly: DotNetNuke.Web.dll
Syntax
[DnnAuthorize]
public class ControlBarController : DnnApiController

Constructors

ControlBarController(IBusinessControllerProvider)

Declaration
public ControlBarController(IBusinessControllerProvider businessControllerProvider)
Parameters
Type Name Description
IBusinessControllerProvider businessControllerProvider

Methods

AddModule(AddModuleDTO)

Declaration
[ValidateAntiForgeryToken]
[DnnPageEditor]
public HttpResponseMessage AddModule(ControlBarController.AddModuleDTO dto)
Parameters
Type Name Description
ControlBarController.AddModuleDTO dto
Returns
Type Description
HttpResponseMessage

CanAddModuleToPage()

Declaration
public bool CanAddModuleToPage()
Returns
Type Description
bool

ClearHostCache()

Declaration
[ValidateAntiForgeryToken]
[RequireHost]
public HttpResponseMessage ClearHostCache()
Returns
Type Description
HttpResponseMessage

CopyPermissionsToChildren()

Declaration
[ValidateAntiForgeryToken]
[DnnPageEditor]
public HttpResponseMessage CopyPermissionsToChildren()
Returns
Type Description
HttpResponseMessage

GetPageList(string)

Declaration
[DnnPageEditor]
public HttpResponseMessage GetPageList(string portal)
Parameters
Type Name Description
string portal
Returns
Type Description
HttpResponseMessage

GetPortalDesktopModules(string, int, int, string, string, bool, string)

Declaration
[DnnPageEditor]
public HttpResponseMessage GetPortalDesktopModules(string category, int loadingStartIndex, int loadingPageSize, string searchTerm, string excludeCategories = "", bool sortBookmarks = false, string topModule = "")
Parameters
Type Name Description
string category
int loadingStartIndex
int loadingPageSize
string searchTerm
string excludeCategories
bool sortBookmarks
string topModule
Returns
Type Description
HttpResponseMessage

GetTabModules(string)

Declaration
[DnnPageEditor]
public HttpResponseMessage GetTabModules(string tab)
Parameters
Type Name Description
string tab
Returns
Type Description
HttpResponseMessage

LockInstance(LockingDTO)

Declaration
[ValidateAntiForgeryToken]
[RequireHost]
public HttpResponseMessage LockInstance(ControlBarController.LockingDTO lockingRequest)
Parameters
Type Name Description
ControlBarController.LockingDTO lockingRequest
Returns
Type Description
HttpResponseMessage

LockSite(LockingDTO)

Declaration
[ValidateAntiForgeryToken]
[RequireHost]
public HttpResponseMessage LockSite(ControlBarController.LockingDTO lockingRequest)
Parameters
Type Name Description
ControlBarController.LockingDTO lockingRequest
Returns
Type Description
HttpResponseMessage

RecycleApplicationPool()

Declaration
[ValidateAntiForgeryToken]
[RequireHost]
public HttpResponseMessage RecycleApplicationPool()
Returns
Type Description
HttpResponseMessage

SaveBookmark(BookmarkDTO)

Declaration
[ValidateAntiForgeryToken]
[DnnPageEditor]
public HttpResponseMessage SaveBookmark(ControlBarController.BookmarkDTO bookmark)
Parameters
Type Name Description
ControlBarController.BookmarkDTO bookmark
Returns
Type Description
HttpResponseMessage

SwitchLanguage(SwitchLanguageDTO)

Declaration
[ValidateAntiForgeryToken]
public HttpResponseMessage SwitchLanguage(ControlBarController.SwitchLanguageDTO dto)
Parameters
Type Name Description
ControlBarController.SwitchLanguageDTO dto
Returns
Type Description
HttpResponseMessage

SwitchSite(SwitchSiteDTO)

Declaration
[ValidateAntiForgeryToken]
[RequireHost]
public HttpResponseMessage SwitchSite(ControlBarController.SwitchSiteDTO dto)
Parameters
Type Name Description
ControlBarController.SwitchSiteDTO dto
Returns
Type Description
HttpResponseMessage

ToggleUserMode(UserModeDTO)

Declaration
[ValidateAntiForgeryToken]
[DnnPageEditor]
public HttpResponseMessage ToggleUserMode(ControlBarController.UserModeDTO userMode)
Parameters
Type Name Description
ControlBarController.UserModeDTO userMode
Returns
Type Description
HttpResponseMessage

Extension Methods