Show / Hide Table of Contents

Class ItemListServiceController

Inheritance
object
DnnApiController
ItemListServiceController
Inherited Members
DnnApiController.PortalSettings
DnnApiController.UserInfo
DnnApiController.ActiveModule
Namespace: DotNetNuke.Web.InternalServices
Assembly: DotNetNuke.Web.dll
Syntax
[DnnAuthorize]
public class ItemListServiceController : DnnApiController

Constructors

ItemListServiceController()

Declaration
public ItemListServiceController()

Methods

GetFiles(int, string, int, string, int)

Declaration
public HttpResponseMessage GetFiles(int parentId, string filter, int sortOrder = 0, string permission = null, int portalId = -1)
Parameters
Type Name Description
int parentId
string filter
int sortOrder
string permission
int portalId
Returns
Type Description
HttpResponseMessage

GetFolderDescendants(string, int, string, string, int)

Declaration
public HttpResponseMessage GetFolderDescendants(string parentId = null, int sortOrder = 0, string searchText = "", string permission = null, int portalId = -1)
Parameters
Type Name Description
string parentId
int sortOrder
string searchText
string permission
int portalId
Returns
Type Description
HttpResponseMessage

GetFolders(int, string, int, int)

Declaration
public HttpResponseMessage GetFolders(int sortOrder = 0, string permission = null, int portalId = -1, int parentFolderId = -1)
Parameters
Type Name Description
int sortOrder
string permission
int portalId
int parentFolderId
Returns
Type Description
HttpResponseMessage

GetPageDescendants(string, int, string, int, bool, bool, bool, bool, string, bool)

Declaration
public HttpResponseMessage GetPageDescendants(string parentId = null, int sortOrder = 0, string searchText = "", int portalId = -1, bool includeDisabled = false, bool includeAllTypes = false, bool includeActive = true, bool includeHostPages = false, string roles = "", bool disabledNotSelectable = false)
Parameters
Type Name Description
string parentId
int sortOrder
string searchText
int portalId
bool includeDisabled
bool includeAllTypes
bool includeActive
bool includeHostPages
string roles
bool disabledNotSelectable
Returns
Type Description
HttpResponseMessage

GetPageDescendantsInPortalGroup(string, int, string, bool, bool, bool, bool, string)

Declaration
public HttpResponseMessage GetPageDescendantsInPortalGroup(string parentId = null, int sortOrder = 0, string searchText = "", bool includeDisabled = false, bool includeAllTypes = false, bool includeActive = true, bool includeHostPages = false, string roles = "")
Parameters
Type Name Description
string parentId
int sortOrder
string searchText
bool includeDisabled
bool includeAllTypes
bool includeActive
bool includeHostPages
string roles
Returns
Type Description
HttpResponseMessage

GetPages(int, int, bool, bool, bool, bool, string, bool)

Declaration
public HttpResponseMessage GetPages(int sortOrder = 0, int portalId = -1, bool includeDisabled = false, bool includeAllTypes = false, bool includeActive = true, bool includeHostPages = false, string roles = "", bool disabledNotSelectable = false)
Parameters
Type Name Description
int sortOrder
int portalId
bool includeDisabled
bool includeAllTypes
bool includeActive
bool includeHostPages
string roles
bool disabledNotSelectable
Returns
Type Description
HttpResponseMessage

GetPagesInPortalGroup(int)

Declaration
public HttpResponseMessage GetPagesInPortalGroup(int sortOrder = 0)
Parameters
Type Name Description
int sortOrder
Returns
Type Description
HttpResponseMessage

GetPortalsInGroup(int)

Declaration
public HttpResponseMessage GetPortalsInGroup(int sortOrder = 0)
Parameters
Type Name Description
int sortOrder
Returns
Type Description
HttpResponseMessage

GetTerms(string, bool, bool)

Declaration
public HttpResponseMessage GetTerms(string q, bool includeSystem, bool includeTags)
Parameters
Type Name Description
string q
bool includeSystem
bool includeTags
Returns
Type Description
HttpResponseMessage

GetTreePathForFolder(string, int, string, int)

Declaration
public HttpResponseMessage GetTreePathForFolder(string itemId, int sortOrder = 0, string permission = null, int portalId = -1)
Parameters
Type Name Description
string itemId
int sortOrder
string permission
int portalId
Returns
Type Description
HttpResponseMessage

GetTreePathForPage(string, int, int, bool, bool, bool, bool, string)

Declaration
public HttpResponseMessage GetTreePathForPage(string itemId, int sortOrder = 0, int portalId = -1, bool includeDisabled = false, bool includeAllTypes = false, bool includeActive = true, bool includeHostPages = false, string roles = "")
Parameters
Type Name Description
string itemId
int sortOrder
int portalId
bool includeDisabled
bool includeAllTypes
bool includeActive
bool includeHostPages
string roles
Returns
Type Description
HttpResponseMessage

GetTreePathForPageInPortalGroup(string, int, bool, bool, bool, bool, string)

Declaration
public HttpResponseMessage GetTreePathForPageInPortalGroup(string itemId, int sortOrder = 0, bool includeDisabled = false, bool includeAllTypes = false, bool includeActive = true, bool includeHostPages = false, string roles = "")
Parameters
Type Name Description
string itemId
int sortOrder
bool includeDisabled
bool includeAllTypes
bool includeActive
bool includeHostPages
string roles
Returns
Type Description
HttpResponseMessage

SearchFiles(int, string, string, int, string, int)

Declaration
public HttpResponseMessage SearchFiles(int parentId, string filter, string searchText, int sortOrder = 0, string permission = null, int portalId = -1)
Parameters
Type Name Description
int parentId
string filter
string searchText
int sortOrder
string permission
int portalId
Returns
Type Description
HttpResponseMessage

SearchFolders(string, int, string, int)

Declaration
public HttpResponseMessage SearchFolders(string searchText, int sortOrder = 0, string permission = null, int portalId = -1)
Parameters
Type Name Description
string searchText
int sortOrder
string permission
int portalId
Returns
Type Description
HttpResponseMessage

SearchPages(string, int, int, bool, bool, bool, bool, string)

Declaration
public HttpResponseMessage SearchPages(string searchText, int sortOrder = 0, int portalId = -1, bool includeDisabled = false, bool includeAllTypes = false, bool includeActive = true, bool includeHostPages = false, string roles = "")
Parameters
Type Name Description
string searchText
int sortOrder
int portalId
bool includeDisabled
bool includeAllTypes
bool includeActive
bool includeHostPages
string roles
Returns
Type Description
HttpResponseMessage

SearchPagesInPortalGroup(string, int, bool, bool, bool, bool, string)

Declaration
public HttpResponseMessage SearchPagesInPortalGroup(string searchText, int sortOrder = 0, bool includeDisabled = false, bool includeAllTypes = false, bool includeActive = true, bool includeHostPages = false, string roles = "")
Parameters
Type Name Description
string searchText
int sortOrder
bool includeDisabled
bool includeAllTypes
bool includeActive
bool includeHostPages
string roles
Returns
Type Description
HttpResponseMessage

SearchUser(string)

Declaration
public HttpResponseMessage SearchUser(string q)
Parameters
Type Name Description
string q
Returns
Type Description
HttpResponseMessage

SortFiles(int, string, int, string, string, int)

Declaration
public HttpResponseMessage SortFiles(int parentId, string filter, int sortOrder = 0, string searchText = "", string permission = null, int portalId = -1)
Parameters
Type Name Description
int parentId
string filter
int sortOrder
string searchText
string permission
int portalId
Returns
Type Description
HttpResponseMessage

SortFolders(string, int, string, string, int)

Declaration
public HttpResponseMessage SortFolders(string treeAsJson, int sortOrder = 0, string searchText = "", string permission = null, int portalId = -1)
Parameters
Type Name Description
string treeAsJson
int sortOrder
string searchText
string permission
int portalId
Returns
Type Description
HttpResponseMessage

SortPages(string, int, string, int, bool, bool, bool, bool, string)

Declaration
public HttpResponseMessage SortPages(string treeAsJson, int sortOrder = 0, string searchText = "", int portalId = -1, bool includeDisabled = false, bool includeAllTypes = false, bool includeActive = true, bool includeHostPages = false, string roles = "")
Parameters
Type Name Description
string treeAsJson
int sortOrder
string searchText
int portalId
bool includeDisabled
bool includeAllTypes
bool includeActive
bool includeHostPages
string roles
Returns
Type Description
HttpResponseMessage

SortPagesInPortalGroup(string, int, string, bool, bool, bool, bool, string)

Declaration
public HttpResponseMessage SortPagesInPortalGroup(string treeAsJson, int sortOrder = 0, string searchText = "", bool includeDisabled = false, bool includeAllTypes = false, bool includeActive = true, bool includeHostPages = false, string roles = "")
Parameters
Type Name Description
string treeAsJson
int sortOrder
string searchText
bool includeDisabled
bool includeAllTypes
bool includeActive
bool includeHostPages
string roles
Returns
Type Description
HttpResponseMessage

Extension Methods

JsonExtensionsWeb.ToJson(object)
Back to top by the community, for the community... #DNNCMS