Akumina Developer Documentation

Akumina Developer Documentation

  • API
  • Docs
  • Blog

›Classes

Modules

  • Akumina
  • AddIn
  • AppParts
  • Digispace
  • AppPart
  • Data
  • WidgetManager

Classes

  • Alignment
  • Cache
  • Configuration
  • Constants
  • GenericListPaging
  • Icons
  • Instructions
  • Location
  • Logger
  • Utilities
  • Banner
  • Calendar
  • CompanyCalendar
  • Traffic
  • Data
  • Eventing
  • CacheManager
  • DataFactory
  • Graph
  • Groups
  • Interchange
  • LanguageManager
  • PageManager
  • PersonaManager
  • RestSharepoint
  • SharePoint
  • WidgetFactory
  • WidgetManager
  • Menu
  • ConfigurationContext
  • Language
  • PageBuilderManager
  • PageContext
  • PerfLogger
  • ScriptManager
  • SiteContext
  • UserContext
  • Utilities
  • DateTimeManager
  • WidgetPropertyViews
  • WorkspaceContext
  • BaseWidget
  • Expression
  • PropertyExpression
  • SortDirection
  • Templates

Interfaces

  • IConstants
  • IGetListRequest
  • ILanguageRequest
  • IPageWidget
  • ISavePageWidgetRequest

SharePoint

definitely-typed › Akumina › Digispace › Data › SharePoint

Hierarchy

  • SharePoint

Index

Methods

  • CreateItem
  • CreateList
  • GetAppInstances
  • GetCurrentSiteId
  • GetList
  • GetSPGroupUsersByGroupName
  • GetSPUserGroups
  • GetSiteIdByUrl
  • GetSiteSPGroups
  • LoadTermSet
  • LoadTermSetById
  • UpdatePageObjectsItem
  • UpdatePageUrlsItem

Methods

CreateItem

▸ CreateItem(createItemRequest: any): JQueryDeferred‹any›

Defined in index.d.ts:829

Create new list item

Parameters:

NameTypeDescription
createItemRequestany

Returns: JQueryDeferred‹any›


CreateList

▸ CreateList(siteUrl: string, siteTitle: string, templateType: string, fieldsList: any[]): JQueryDeferred‹any›

Defined in index.d.ts:837

Create new list

Parameters:

NameTypeDescription
siteUrlstring-
siteTitlestring-
templateTypestring-
fieldsListany[]

Returns: JQueryDeferred‹any›


GetAppInstances

▸ GetAppInstances(successCallback: any, errorCallback: any): void

Defined in index.d.ts:839

Parameters:

NameType
successCallbackany
errorCallbackany

Returns: void


GetCurrentSiteId

▸ GetCurrentSiteId(): JQueryDeferred‹any›

Defined in index.d.ts:843

Get SiteID of current site

Returns: JQueryDeferred‹any›


GetList

▸ GetList(request: any): JQueryDeferred‹any›

Defined in index.d.ts:845

Parameters:

NameType
requestany

Returns: JQueryDeferred‹any›


GetSPGroupUsersByGroupName

▸ GetSPGroupUsersByGroupName(authorizationGroups: any[]): JQueryDeferred‹any›

Defined in index.d.ts:859

Get list of users under user groups

Parameters:

NameTypeDescription
authorizationGroupsany[]List of authorization Groups

Returns: JQueryDeferred‹any›


GetSPUserGroups

▸ GetSPUserGroups(): JQueryDeferred‹any›

Defined in index.d.ts:863

Get User Groups current user belongs to

Returns: JQueryDeferred‹any›


GetSiteIdByUrl

▸ GetSiteIdByUrl(siteUrl: string, useRootWeb: boolean): JQueryDeferred‹any›

Defined in index.d.ts:849

Parameters:

NameTypeDescription
siteUrlstringAbsolute path
useRootWebboolean-

Returns: JQueryDeferred‹any›


GetSiteSPGroups

▸ GetSiteSPGroups(): JQueryDeferred‹any›

Defined in index.d.ts:854

Get all SP user groups

Returns: JQueryDeferred‹any›

Resolves with array of {id, displayName, type, description}


LoadTermSet

▸ LoadTermSet(termSetName: string, columnName: string | null, columnValue: string | null): JQueryDeferred‹any›

Defined in index.d.ts:809

Parameters:

NameType
termSetNamestring
columnNamestring | null
columnValuestring | null

Returns: JQueryDeferred‹any›


LoadTermSetById

▸ LoadTermSetById(termSetId: string, columnName: string, columnValue?: string | null): JQueryDeferred‹any›

Defined in index.d.ts:810

Parameters:

NameType
termSetIdstring
columnNamestring
columnValue?string | null

Returns: JQueryDeferred‹any›


UpdatePageObjectsItem

▸ UpdatePageObjectsItem(pageTypeList: string, pageObject: any, pageId: string): JQueryDeferred‹any›

Defined in index.d.ts:817

Update Page object item

Parameters:

NameTypeDescription
pageTypeListstringList Name
pageObjectanyPage object to be updated
pageIdstringItem Id of page list item

Returns: JQueryDeferred‹any›


UpdatePageUrlsItem

▸ UpdatePageUrlsItem(pageObject: any, pageId: string, pageTypeList?: undefined | string): JQueryDeferred‹any›

Defined in index.d.ts:823

Parameters:

NameTypeDescription
pageObjectany-
pageIdstring-
pageTypeList?undefined | string

Returns: JQueryDeferred‹any›

← RestSharepointWidgetFactory →
  • Hierarchy
  • Index
    • Methods
  • Methods
    • CreateItem
    • CreateList
    • GetAppInstances
    • GetCurrentSiteId
    • GetList
    • GetSPGroupUsersByGroupName
    • GetSPUserGroups
    • GetSiteIdByUrl
    • GetSiteSPGroups
    • LoadTermSet
    • LoadTermSetById
    • UpdatePageObjectsItem
    • UpdatePageUrlsItem
Akumina Developer Documentation
Docs
Akumina Framework 5.0Akumina Widget BuilderAkumina Yeoman GeneratorSite Deployer
Community
Akumina Community Site
More
GitHubStar
Copyright © 2024 Akumina