Class ItemListServiceController

Inheritance

System.Object

DnnApiController

ItemListServiceController

Inherited Members

DnnApiController.PortalSettings

DnnApiController.UserInfo

DnnApiController.ActiveModule

Namespace: DotNetNuke.Web.InternalServices

Assembly: DotNetNuke.Web.dll

Syntax

public class ItemListServiceController : DnnApiController

Methods

| Improve this Doc View Source

GetFiles(Int32, String, Int32, String, Int32)

Declaration

public HttpResponseMessage GetFiles(int parentId, string filter, int sortOrder = 0, string permission = null, int portalId = null)

Parameters

Type	Name	Description
System.Int32	parentId
System.String	filter
System.Int32	sortOrder
System.String	permission
System.Int32	portalId

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

GetFolderDescendants(String, Int32, String, String, Int32)

Declaration

public HttpResponseMessage GetFolderDescendants(string parentId = null, int sortOrder = 0, string searchText = "", string permission = null, int portalId = null)

Parameters

Type	Name	Description
System.String	parentId
System.Int32	sortOrder
System.String	searchText
System.String	permission
System.Int32	portalId

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

GetFolders(Int32, String, Int32, Int32)

Declaration

public HttpResponseMessage GetFolders(int sortOrder = 0, string permission = null, int portalId = null, int parentFolderId = null)

Parameters

Type	Name	Description
System.Int32	sortOrder
System.String	permission
System.Int32	portalId
System.Int32	parentFolderId

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

GetPageDescendants(String, Int32, String, Int32, Boolean, Boolean, Boolean, Boolean, String, Boolean)

Declaration

public HttpResponseMessage GetPageDescendants(string parentId = null, int sortOrder = 0, string searchText = "", int portalId = null, bool includeDisabled = false, bool includeAllTypes = false, bool includeActive = true, bool includeHostPages = false, string roles = "", bool disabledNotSelectable = false)

Parameters

Type	Name	Description
System.String	parentId
System.Int32	sortOrder
System.String	searchText
System.Int32	portalId
System.Boolean	includeDisabled
System.Boolean	includeAllTypes
System.Boolean	includeActive
System.Boolean	includeHostPages
System.String	roles
System.Boolean	disabledNotSelectable

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

GetPageDescendantsInPortalGroup(String, Int32, String, Boolean, Boolean, Boolean, Boolean, 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
System.String	parentId
System.Int32	sortOrder
System.String	searchText
System.Boolean	includeDisabled
System.Boolean	includeAllTypes
System.Boolean	includeActive
System.Boolean	includeHostPages
System.String	roles

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

GetPages(Int32, Int32, Boolean, Boolean, Boolean, Boolean, String, Boolean)

Declaration

public HttpResponseMessage GetPages(int sortOrder = 0, int portalId = null, bool includeDisabled = false, bool includeAllTypes = false, bool includeActive = true, bool includeHostPages = false, string roles = "", bool disabledNotSelectable = false)

Parameters

Type	Name	Description
System.Int32	sortOrder
System.Int32	portalId
System.Boolean	includeDisabled
System.Boolean	includeAllTypes
System.Boolean	includeActive
System.Boolean	includeHostPages
System.String	roles
System.Boolean	disabledNotSelectable

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

GetPagesInPortalGroup(Int32)

Declaration

public HttpResponseMessage GetPagesInPortalGroup(int sortOrder = 0)

Parameters

Type	Name	Description
System.Int32	sortOrder

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

GetPortalsInGroup(Int32)

Declaration

public HttpResponseMessage GetPortalsInGroup(int sortOrder = 0)

Parameters

Type	Name	Description
System.Int32	sortOrder

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

GetTerms(String, Boolean, Boolean)

Declaration

public HttpResponseMessage GetTerms(string q, bool includeSystem, bool includeTags)

Parameters

Type	Name	Description
System.String	q
System.Boolean	includeSystem
System.Boolean	includeTags

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

GetTreePathForFolder(String, Int32, String, Int32)

Declaration

public HttpResponseMessage GetTreePathForFolder(string itemId, int sortOrder = 0, string permission = null, int portalId = null)

Parameters

Type	Name	Description
System.String	itemId
System.Int32	sortOrder
System.String	permission
System.Int32	portalId

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

GetTreePathForPage(String, Int32, Int32, Boolean, Boolean, Boolean, Boolean, String)

Declaration

public HttpResponseMessage GetTreePathForPage(string itemId, int sortOrder = 0, int portalId = null, bool includeDisabled = false, bool includeAllTypes = false, bool includeActive = true, bool includeHostPages = false, string roles = "")

Parameters

Type	Name	Description
System.String	itemId
System.Int32	sortOrder
System.Int32	portalId
System.Boolean	includeDisabled
System.Boolean	includeAllTypes
System.Boolean	includeActive
System.Boolean	includeHostPages
System.String	roles

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

GetTreePathForPageInPortalGroup(String, Int32, Boolean, Boolean, Boolean, Boolean, 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
System.String	itemId
System.Int32	sortOrder
System.Boolean	includeDisabled
System.Boolean	includeAllTypes
System.Boolean	includeActive
System.Boolean	includeHostPages
System.String	roles

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

SearchFiles(Int32, String, String, Int32, String, Int32)

Declaration

public HttpResponseMessage SearchFiles(int parentId, string filter, string searchText, int sortOrder = 0, string permission = null, int portalId = null)

Parameters

Type	Name	Description
System.Int32	parentId
System.String	filter
System.String	searchText
System.Int32	sortOrder
System.String	permission
System.Int32	portalId

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

SearchFolders(String, Int32, String, Int32)

Declaration

public HttpResponseMessage SearchFolders(string searchText, int sortOrder = 0, string permission = null, int portalId = null)

Parameters

Type	Name	Description
System.String	searchText
System.Int32	sortOrder
System.String	permission
System.Int32	portalId

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

SearchPages(String, Int32, Int32, Boolean, Boolean, Boolean, Boolean, String)

Declaration

public HttpResponseMessage SearchPages(string searchText, int sortOrder = 0, int portalId = null, bool includeDisabled = false, bool includeAllTypes = false, bool includeActive = true, bool includeHostPages = false, string roles = "")

Parameters

Type	Name	Description
System.String	searchText
System.Int32	sortOrder
System.Int32	portalId
System.Boolean	includeDisabled
System.Boolean	includeAllTypes
System.Boolean	includeActive
System.Boolean	includeHostPages
System.String	roles

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

SearchPagesInPortalGroup(String, Int32, Boolean, Boolean, Boolean, Boolean, 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
System.String	searchText
System.Int32	sortOrder
System.Boolean	includeDisabled
System.Boolean	includeAllTypes
System.Boolean	includeActive
System.Boolean	includeHostPages
System.String	roles

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

SearchUser(String)

Declaration

public HttpResponseMessage SearchUser(string q)

Parameters

Type	Name	Description
System.String	q

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

SortFiles(Int32, String, Int32, String, String, Int32)

Declaration

public HttpResponseMessage SortFiles(int parentId, string filter, int sortOrder = 0, string searchText = "", string permission = null, int portalId = null)

Parameters

Type	Name	Description
System.Int32	parentId
System.String	filter
System.Int32	sortOrder
System.String	searchText
System.String	permission
System.Int32	portalId

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

SortFolders(String, Int32, String, String, Int32)

Declaration

public HttpResponseMessage SortFolders(string treeAsJson, int sortOrder = 0, string searchText = "", string permission = null, int portalId = null)

Parameters

Type	Name	Description
System.String	treeAsJson
System.Int32	sortOrder
System.String	searchText
System.String	permission
System.Int32	portalId

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

SortPages(String, Int32, String, Int32, Boolean, Boolean, Boolean, Boolean, String)

Declaration

public HttpResponseMessage SortPages(string treeAsJson, int sortOrder = 0, string searchText = "", int portalId = null, bool includeDisabled = false, bool includeAllTypes = false, bool includeActive = true, bool includeHostPages = false, string roles = "")

Parameters

Type	Name	Description
System.String	treeAsJson
System.Int32	sortOrder
System.String	searchText
System.Int32	portalId
System.Boolean	includeDisabled
System.Boolean	includeAllTypes
System.Boolean	includeActive
System.Boolean	includeHostPages
System.String	roles

Returns

Type	Description
HttpResponseMessage

| Improve this Doc View Source

SortPagesInPortalGroup(String, Int32, String, Boolean, Boolean, Boolean, Boolean, 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
System.String	treeAsJson
System.Int32	sortOrder
System.String	searchText
System.Boolean	includeDisabled
System.Boolean	includeAllTypes
System.Boolean	includeActive
System.Boolean	includeHostPages
System.String	roles

Returns

Type	Description
HttpResponseMessage

Extension Methods

JsonExtensionsWeb.ToJson(Object)