PageManager

definitely-typed › Akumina › Digispace › Data › PageManager

Hierarchy

• PageManager

Index

Methods

• AddPageForGroup
• AddPagesForGroup
• CanUserSetPagePermissions
• ExecuteAsyncQuery
• GetAvailableWorkspaceTypes
• GetContainersForView
• GetDashboardPageForUser
• GetDashboardWidgetsViaAppManager
• GetLayoutsForToolBar
• GetPageActiveView
• GetPageAvailableViews
• GetPageChildWidgets
• GetPageLayouts
• GetPageObject
• GetPageObjectForPageUrl
• GetPageTypeInfo
• GetPageWidget
• GetPageWidgets
• GetPagesFromPageUrlList
• GetPermissionForPage
• GetSavedLayout
• GetWidgetsForPage
• GetWidgetsForToolbar
• IsDashBoardOrPageWidgetOrContainer
• IsDashboardOrPageWidgetOrContainerType
• IsGroupTypeCustom
• LoadNewPage
• ProvisionDashboardPageForUser
• ProvisionPageObject
• ProvisionPageWidgets
• ProvisionSavedLayout
• RemoveGroupPage
• RemoveGroupPageMapping
• RemoveGroupWidgetProperties
• RemovePagesForGroup
• SaveDashboardPage
• SavePage
• SetPageContents
• SetPermissionsForPage
• SetPersonasForPage
• SetTagsForPage
• getGrid

Methods

AddPageForGroup

▸ AddPageForGroup(pageModel: any): JQueryDeferred‹any›

Defined in index.d.ts:1281

Add Page for groups

Parameters:

Name	Type	Description
pageModel	any

Returns: JQueryDeferred‹any›

---

AddPagesForGroup

▸ AddPagesForGroup(model: any): JQueryDeferred‹any›

Defined in index.d.ts:1299

Add pages for group

Parameters:

Name	Type	Description
model	any

Returns: JQueryDeferred‹any›

---

CanUserSetPagePermissions

▸ CanUserSetPagePermissions(listName: string, useRootWeb: boolean): JQueryDeferred‹any›

Defined in index.d.ts:1131

Returns List of permissions for current user for passed list

Parameters:

Name	Type	Description
listName	string	Name of list
useRootWeb	boolean	Boolean flag

Returns: JQueryDeferred‹any›

---

ExecuteAsyncQuery

▸ ExecuteAsyncQuery(clientContext: any, collListItem: any, def: JQueryDeferred‹any›, idArray: any[], columnName: string): JQueryDeferred‹any›

Defined in index.d.ts:1339

Execute Share point query

Parameters:

Name	Type	Description
clientContext	any	-
collListItem	any	-
def	JQueryDeferred‹any›	-
idArray	any[]	-
columnName	string

Returns: JQueryDeferred‹any›

---

GetAvailableWorkspaceTypes

▸ GetAvailableWorkspaceTypes(groupType: string): JQueryDeferred‹any›

Defined in index.d.ts:1287

Get Available Workspace Types

Parameters:

Name	Type	Description
groupType	string

Returns: JQueryDeferred‹any›

---

GetContainersForView

▸ GetContainersForView(viewTemplateUrl: string): JQueryDeferred‹any›

Defined in index.d.ts:1232

Get containers for view

Parameters:

Name	Type	Description
viewTemplateUrl	string

Returns: JQueryDeferred‹any›

---

GetDashboardPageForUser

▸ GetDashboardPageForUser(userId: string): JQueryDeferred‹any›

Defined in index.d.ts:1208

Get Dashboard Page for User

Parameters:

Name	Type
userId	string

Returns: JQueryDeferred‹any›

resolves with dashboard page for user {title, userId, pageId}

---

GetDashboardWidgetsViaAppManager

▸ GetDashboardWidgetsViaAppManager(pageId: string): JQueryDeferred‹any›

Defined in index.d.ts:1195

Get Dashboard widgets

Parameters:

Name	Type	Description
pageId	string

Returns: JQueryDeferred‹any›

---

GetLayoutsForToolBar

▸ GetLayoutsForToolBar(pageId: string): JQueryDeferred‹any›

Defined in index.d.ts:1244

Get Layouts For ToolBar

Parameters:

Name	Type	Description
pageId	string

Returns: JQueryDeferred‹any›

---

GetPageActiveView

▸ GetPageActiveView(pageId: string): JQueryDeferred‹any›

Defined in index.d.ts:1226

Get Page Active View

Parameters:

Name	Type	Description
pageId	string

Returns: JQueryDeferred‹any›

---

GetPageAvailableViews

▸ GetPageAvailableViews(pageId: string): JQueryDeferred‹any›

Defined in index.d.ts:1220

Retrives available page views

Parameters:

Name	Type	Description
pageId	string

Returns: JQueryDeferred‹any›

---

GetPageChildWidgets

▸ GetPageChildWidgets(pageId: string): JQueryDeferred‹any›

Defined in index.d.ts:1238

Get Page Child widgets

Parameters:

Name	Type	Description
pageId	string

Returns: JQueryDeferred‹any›

---

GetPageLayouts

▸ GetPageLayouts(): any[]

Defined in index.d.ts:1085

Get default page layouts

Returns: any[]

Array of page layout object {displayOrder:, layoutId:, layoutImage:, layoutTemplate:, layoutTitle:, selectedLayout:, spPageLayoutId: }

---

GetPageObject

▸ GetPageObject(): JQueryDeferred‹any›

Defined in index.d.ts:1092

Returns: JQueryDeferred‹any›

---

GetPageObjectForPageUrl

▸ GetPageObjectForPageUrl(relativePageurl: string): JQueryDeferred‹any›

Defined in index.d.ts:1091

Get page object from pageURL

Parameters:

Name	Type	Description
relativePageurl	string	relative page URL

Returns: JQueryDeferred‹any›

---

GetPageTypeInfo

▸ GetPageTypeInfo(pageTypeParam: string): JQueryDeferred‹any›

Defined in index.d.ts:1168

Returns page type information

Parameters:

Name	Type	Description
pageTypeParam	string	Page Type

Returns: JQueryDeferred‹any›

---

GetPageWidget

▸ GetPageWidget(pageId: string): JQueryDeferred‹any›

Defined in index.d.ts:1201

Retrive page widget

Parameters:

Name	Type	Description
pageId	string

Returns: JQueryDeferred‹any›

---

GetPageWidgets

▸ GetPageWidgets(): JQueryDeferred‹any›

Defined in index.d.ts:1183

Resolves with all the page widgets

Returns: JQueryDeferred‹any›

---

GetPagesFromPageUrlList

▸ GetPagesFromPageUrlList(searchText: string): JQueryDeferred‹any›

Defined in index.d.ts:1124

Get matching pages from Page Url List

Parameters:

Name	Type	Description
searchText	string	Text to search existing pages

Returns: JQueryDeferred‹any›

---

GetPermissionForPage

▸ GetPermissionForPage(listName: string, itemId: string): JQueryDeferred‹any›

Defined in index.d.ts:1138

Get permissions for Page

Parameters:

Name	Type	Description
listName	string	Name of list
itemId	string	Page Id

Returns: JQueryDeferred‹any›

---

GetSavedLayout

▸ GetSavedLayout(Title?: undefined | string): JQueryDeferred‹any›

Defined in index.d.ts:1098

Get saved layout from Sharepoint

Parameters:

Name	Type	Description
Title?	undefined | string	Layout Name

Returns: JQueryDeferred‹any›

---

GetWidgetsForPage

▸ GetWidgetsForPage(pageId: string, legacy?: undefined | false | true): JQueryDeferred‹any›

Defined in index.d.ts:1111

Get widgets for page

Parameters:

Name	Type	Description
pageId	string	-
legacy?	undefined | false | true

Returns: JQueryDeferred‹any›

---

GetWidgetsForToolbar

▸ GetWidgetsForToolbar(): JQueryDeferred‹any›

Defined in index.d.ts:1249

Get Widgets For Toolbar

Returns: JQueryDeferred‹any›

---

IsDashBoardOrPageWidgetOrContainer

▸ IsDashBoardOrPageWidgetOrContainer(widgetInstances: any): boolean

Defined in index.d.ts:1305

Returns true if widget instance is either Dashboard, PageWidget or Container

Parameters:

Name	Type	Description
widgetInstances	any	string of widget Type

Returns: boolean

---

IsDashboardOrPageWidgetOrContainerType

▸ IsDashboardOrPageWidgetOrContainerType(widgetType: any): boolean

Defined in index.d.ts:1163

Returns true if widget type passed is either Dashboard, PageWidget or Container Type

Parameters:

Name	Type	Description
widgetType	any	string of widget Type

Returns: boolean

---

IsGroupTypeCustom

▸ IsGroupTypeCustom(type: string): boolean

Defined in index.d.ts:1293

Check if group type is custom

Parameters:

Name	Type	Description
type	string

Returns: boolean

---

LoadNewPage

▸ LoadNewPage(pageRouteInfo: any): void

Defined in index.d.ts:1189

Loads a new page

Parameters:

Name	Type	Description
pageRouteInfo	any	JSON object with page routing information

Returns: void

---

ProvisionDashboardPageForUser

▸ ProvisionDashboardPageForUser(userId: string): JQueryDeferred‹any›

Defined in index.d.ts:1214

Save dashboard page for user

Parameters:

Name	Type	Description
userId	string

Returns: JQueryDeferred‹any›

---

ProvisionPageObject

▸ ProvisionPageObject(pageObject: any): JQueryDeferred‹any›

Defined in index.d.ts:1255

Save update page objects

Parameters:

Name	Type	Description
pageObject	any

Returns: JQueryDeferred‹any›

---

ProvisionPageWidgets

▸ ProvisionPageWidgets(widgetName: string, pageId: string, pageWidgets: any[]): JQueryDeferred‹any›

Defined in index.d.ts:1263

Save page widgets

Parameters:

Name	Type	Description
widgetName	string	-
pageId	string	-
pageWidgets	any[]

Returns: JQueryDeferred‹any›

---

ProvisionSavedLayout

▸ ProvisionSavedLayout(data: any): JQueryDeferred‹any›

Defined in index.d.ts:1104

Save custom layout

Parameters:

Name	Type
data	any

Returns: JQueryDeferred‹any›

---

RemoveGroupPage

▸ RemoveGroupPage(pageIds: string[]): JQueryDeferred‹any›

Defined in index.d.ts:1323

Remove Group Page

Parameters:

Name	Type	Description
pageIds	string[]

Returns: JQueryDeferred‹any›

---

RemoveGroupPageMapping

▸ RemoveGroupPageMapping(groupId: string): JQueryDeferred‹any›

Defined in index.d.ts:1317

Remmove group page mapping

Parameters:

Name	Type	Description
groupId	string

Returns: JQueryDeferred‹any›

---

RemoveGroupWidgetProperties

▸ RemoveGroupWidgetProperties(widgetInstanceIds: string[]): JQueryDeferred‹any›

Defined in index.d.ts:1329

Remove Group WIdget properties

Parameters:

Name	Type	Description
widgetInstanceIds	string[]

Returns: JQueryDeferred‹any›

---

RemovePagesForGroup

▸ RemovePagesForGroup(groupId: string): JQueryDeferred‹any›

Defined in index.d.ts:1311

Remove pages for group

Parameters:

Name	Type	Description
groupId	string

Returns: JQueryDeferred‹any›

---

SaveDashboardPage

▸ SaveDashboardPage(pageId: string): JQueryDeferred‹any›

Defined in index.d.ts:1275

Save dashboard page

Parameters:

Name	Type	Description
pageId	string

Returns: JQueryDeferred‹any›

---

SavePage

▸ SavePage(pageId: string): JQueryDeferred‹any›

Defined in index.d.ts:1264

Parameters:

Name	Type
pageId	string

Returns: JQueryDeferred‹any›

---

SetPageContents

▸ SetPageContents(pageId: string, data: any): JQueryDeferred‹any›

Defined in index.d.ts:1118

Save page contents(widgets)

Parameters:

Name	Type
pageId	string
data	any

Returns: JQueryDeferred‹any›

---

SetPermissionsForPage

▸ SetPermissionsForPage(listName: string, itemId: string, editgroup: string[], readgroup: string[], useRootWeb: boolean): JQueryDeferred‹any›

Defined in index.d.ts:1178

Set permissions for Page

Parameters:

Name	Type	Description
listName	string	-
itemId	string	Page item Id
editgroup	string[]	Array User groups for edit permission
readgroup	string[]	Array User groups for read permission
useRootWeb	boolean

Returns: JQueryDeferred‹any›

---

SetPersonasForPage

▸ SetPersonasForPage(listName: string, itemId: string, personaList: any, columnName?: undefined | string): JQueryDeferred‹any›

Defined in index.d.ts:1147

Set personas for page

Parameters:

Name	Type	Description
listName	string	ListName of which item belongs
itemId	string	ID of item to set persona.
personaList	any	Semicolon seprated List of persona to set for item
columnName?	undefined | string	Coloumn Name

Returns: JQueryDeferred‹any›

---

SetTagsForPage

▸ SetTagsForPage(listName: string, itemId: string, columnName: string, list: any): JQueryDeferred‹any›

Defined in index.d.ts:1157

Set Tags for Page

Parameters:

Name	Type	Description
listName	string	List Name
itemId	string	Item Id of page
columnName	string	Coloumn Name to be updated for tags
list	any	semicolon seprated list of tags

Returns: JQueryDeferred‹any›

---

getGrid

▸ getGrid(): any[]

Defined in index.d.ts:1269

Provide grid details

Returns: any[]