DataFactory
definitely-typed › Akumina › Digispace › Data › DataFactory
Hierarchy
- DataFactory
Index
Constructors
Methods
- CanUserSetItemPermissions
- CreateList
- DeleteListItem
- GetAllList
- GetGroupsForSite
- GetItemsFromListByTitle
- GetList
- GetListEffectiveBasePermissions
- GetListPosition
- GetPagesFromPageUrlList
- GetPermissionForListItem
- GetSavedLayout
- GetSiteProperties
- GetWidgetsForPage
- LoadTermSet
- LoadTermSetByColumnName
- ProvisionPageObject
- ProvisionPageWidgets
- ProvisionSavedLayout
- Search
- SetImpl
- SetPermissionsForListItem
- SetPersonasForItem
- SetTagsForItem
- UpdateListItem
- UpdatePageObjectsItem
- UpdatePageUrlsItem
- UserPermissionsForListItem
Constructors
constructor
+ new DataFactory(legacyMode?: undefined | false | true): DataFactory
Defined in index.d.ts:626
Parameters:
| Name | Type |
|---|---|
legacyMode? | undefined | false | true |
Returns: DataFactory
Methods
CanUserSetItemPermissions
▸ CanUserSetItemPermissions(listName: string, useRootWeb: boolean): JQueryDeferred‹any›
Defined in index.d.ts:664
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›
CreateList
▸ CreateList(siteUrl: string, siteTitle: string, templateType: string, fieldsList: any[]): JQueryDeferred‹any›
Defined in index.d.ts:757
Create new list
Parameters:
| Name | Type | Description |
|---|---|---|
siteUrl | string | - |
siteTitle | string | - |
templateType | string | - |
fieldsList | any[] |
Returns: JQueryDeferred‹any›
DeleteListItem
▸ DeleteListItem(listName: string, itemid: string): JQueryDeferred‹any›
Defined in index.d.ts:798
Delete list item
Parameters:
| Name | Type | Description |
|---|---|---|
listName | string | listName to which item belongs |
itemid | string |
Returns: JQueryDeferred‹any›
GetAllList
▸ GetAllList(useRoot: boolean | undefined): JQueryDeferred‹any›
Defined in index.d.ts:711
Get All lists from the site. By default it fetechs from root site
Parameters:
| Name | Type | Description |
|---|---|---|
useRoot | boolean | undefined |
Returns: JQueryDeferred‹any›
GetGroupsForSite
▸ GetGroupsForSite(searchUniqueValue: any, currentPage: number, pageLimit: number): any
Defined in index.d.ts:767
Get all user groups for site
Parameters:
| Name | Type | Description |
|---|---|---|
searchUniqueValue | any | - |
currentPage | number | - |
pageLimit | number |
Returns: any
GetItemsFromListByTitle
▸ GetItemsFromListByTitle(listName: string, searchTerm: string, isroot: boolean): JQueryDeferred‹any›
Defined in index.d.ts:759
Parameters:
| Name | Type |
|---|---|
listName | string |
searchTerm | string |
isroot | boolean |
Returns: JQueryDeferred‹any›
GetList
▸ GetList(request: IGetListRequest): Promise‹any›
Defined in index.d.ts:638
Get list from SharePoint
Parameters:
| Name | Type | Description |
|---|---|---|
request | IGetListRequest |
Returns: Promise‹any›
GetListEffectiveBasePermissions
▸ GetListEffectiveBasePermissions(listName: string): JQueryDeferred‹__type›
Defined in index.d.ts:804
Get Permissin on list for current user
Parameters:
| Name | Type | Description |
|---|---|---|
listName | string | listName to fetch permission of |
Returns: JQueryDeferred‹__type›
GetListPosition
▸ GetListPosition(): JQueryDeferred‹any›
Defined in index.d.ts:714
Get List position
Returns: JQueryDeferred‹any›
GetPagesFromPageUrlList
▸ GetPagesFromPageUrlList(searchText: string): JQueryDeferred‹any›
Defined in index.d.ts:670
Get matching pages from Page Url List
Parameters:
| Name | Type | Description |
|---|---|---|
searchText | string | Text to search existing pages |
Returns: JQueryDeferred‹any›
GetPermissionForListItem
▸ GetPermissionForListItem(listName: string, itemId: string): JQueryDeferred‹any›
Defined in index.d.ts:677
Get permissions set for list item
Parameters:
| Name | Type | Description |
|---|---|---|
listName | string | Name of list |
itemId | string | List Item id |
Returns: JQueryDeferred‹any›
GetSavedLayout
▸ GetSavedLayout(layoutName: string): JQueryDeferred‹any›
Defined in index.d.ts:651
Get saved layout from Sharepoint
Parameters:
| Name | Type | Description |
|---|---|---|
layoutName | string | Layout Name |
Returns: JQueryDeferred‹any›
GetSiteProperties
▸ GetSiteProperties(request: any): JQueryDeferred‹any›
Defined in index.d.ts:726
Get Site Properties
Parameters:
| Name | Type | Description |
|---|---|---|
request | any |
Returns: JQueryDeferred‹any›
GetWidgetsForPage
▸ GetWidgetsForPage(pageId: string, legacy?: undefined | false | true): JQueryDeferred‹any›
Defined in index.d.ts:645
Get widgets for page
Parameters:
| Name | Type | Description |
|---|---|---|
pageId | string | - |
legacy? | undefined | false | true |
Returns: JQueryDeferred‹any›
LoadTermSet
▸ LoadTermSet(termSetName?: string | null, columnName?: string | null, columnValue?: string | null): JQueryDeferred‹any›
Defined in index.d.ts:748
Parameters:
| Name | Type |
|---|---|
termSetName? | string | null |
columnName? | string | null |
columnValue? | string | null |
Returns: JQueryDeferred‹any›
LoadTermSetByColumnName
▸ LoadTermSetByColumnName(request: IGetListRequest, columnName: string, columnValue?: string | null): JQueryDeferred‹any›
Defined in index.d.ts:749
Parameters:
| Name | Type |
|---|---|
request | IGetListRequest |
columnName | string |
columnValue? | string | null |
Returns: JQueryDeferred‹any›
ProvisionPageObject
▸ ProvisionPageObject(pageObject: any): JQueryDeferred‹any›
Defined in index.d.ts:738
Add new page to list
Parameters:
| Name | Type | Description |
|---|---|---|
pageObject | any | JSON object with properties for page |
Returns: JQueryDeferred‹any›
ProvisionPageWidgets
▸ ProvisionPageWidgets(widgetName: string, pageId: string, pageWidgets: any[]): JQueryDeferred‹any›
Defined in index.d.ts:746
Add/Save new widgets to page
Parameters:
| Name | Type | Description |
|---|---|---|
widgetName | string | - |
pageId | string | - |
pageWidgets | any[] |
Returns: JQueryDeferred‹any›
ProvisionSavedLayout
▸ ProvisionSavedLayout(layoutObject: any): JQueryDeferred‹any›
Defined in index.d.ts:657
Save custom layout
Parameters:
| Name | Type | Description |
|---|---|---|
layoutObject | any | JSON object having layout details |
Returns: JQueryDeferred‹any›
Search
▸ Search(request: any): JQueryDeferred‹any›
Defined in index.d.ts:720
Search in sharepoint list based on request
Parameters:
| Name | Type | Description |
|---|---|---|
request | any |
Returns: JQueryDeferred‹any›
SetImpl
▸ SetImpl(implementation: string): void
Defined in index.d.ts:632
#MARK - Not currently used.
Parameters:
| Name | Type | Description |
|---|---|---|
implementation | string |
Returns: void
SetPermissionsForListItem
▸ SetPermissionsForListItem(listName: string, itemId: string, editgroup: any, readgroup: any, useRootWeb: boolean): JQueryDeferred‹any›
Defined in index.d.ts:705
Set permissions for list item
Parameters:
| Name | Type | Description |
|---|---|---|
listName | string | - |
itemId | string | - |
editgroup | any | Array User groups for edit permission |
readgroup | any | Array User groups for read permission |
useRootWeb | boolean |
Returns: JQueryDeferred‹any›
SetPersonasForItem
▸ SetPersonasForItem(listName: string, itemId: number, personaList: any, columnName?: undefined | string): JQueryDeferred‹any›
Defined in index.d.ts:686
Set personas for list item
Parameters:
| Name | Type | Description |
|---|---|---|
listName | string | ListName of which item belongs |
itemId | number | ID of item to set persona. |
personaList | any | Semicolon seprated List of persona to set for item |
columnName? | undefined | string | column Name for persona |
Returns: JQueryDeferred‹any›
SetTagsForItem
▸ SetTagsForItem(listName: string, itemId: string, columnName: string, tagList: any): JQueryDeferred‹any›
Defined in index.d.ts:695
Set Tags for list item
Parameters:
| Name | Type | Description |
|---|---|---|
listName | string | List Name |
itemId | string | Item Id |
columnName | string | Coloumn Name for tags |
tagList | any | semicolon seprated list of tags |
Returns: JQueryDeferred‹any›
UpdateListItem
▸ UpdateListItem(listName: string, itemid: string, queryParams: any): JQueryDeferred‹any›
Defined in index.d.ts:791
Updates list item
Parameters:
| Name | Type | Description |
|---|---|---|
listName | string | listName to which item belongs |
itemid | string | - |
queryParams | any | data that needs to updated as an object |
Returns: JQueryDeferred‹any›
UpdatePageObjectsItem
▸ UpdatePageObjectsItem(pageTypeList: string, pageObject: any, pageId: string): JQueryDeferred‹any›
Defined in index.d.ts:732
Update page object Items
Parameters:
| Name | Type | Description |
|---|---|---|
pageTypeList | string | - |
pageObject | any | |
pageId | string | - |
Returns: JQueryDeferred‹any›
UpdatePageUrlsItem
▸ UpdatePageUrlsItem(pageObject: any, pageId: string, pageTypeList?: undefined | string): JQueryDeferred‹any›
Defined in index.d.ts:747
Parameters:
| Name | Type |
|---|---|
pageObject | any |
pageId | string |
pageTypeList? | undefined | string |
Returns: JQueryDeferred‹any›
UserPermissionsForListItem
▸ UserPermissionsForListItem(pageTypeList: string, pageId: string): JQueryDeferred‹any›
Defined in index.d.ts:774
Check user permission on list item
Parameters:
| Name | Type | Description |
|---|---|---|
pageTypeList | string | listName to which item belongs |
pageId | string |
Returns: JQueryDeferred‹any›
▸ UserPermissionsForListItem(pageReferenceList: any, pageId: string): JQueryDeferred‹any›
Defined in index.d.ts:783
Check if user have edit permission on list item.
Parameters:
| Name | Type |
|---|---|
pageReferenceList | any |
pageId | string |
Returns: JQueryDeferred‹any›
Resolves with {ReadPermission: bool, EditPermission: bool}