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

Utilities

definitely-typed › Akumina › Digispace › Utilities

Hierarchy

  • Utilities

Index

Classes

  • DateTimeManager

Methods

  • AllPermissionsNA
  • AttemptReset
  • CheckAppManagerIsLoggedIn
  • ConvertValue
  • DeDupArray
  • FindSearchResultCategory
  • FormatDateStringToJSFormat
  • GetCurrentPageId
  • GetDashboardGridByInstance
  • GetDateFormatForSiteLocaleId
  • GetEmployeeDetailUrl
  • GetGuid
  • GetLinkForResult
  • GetLinkParameter
  • GetManagerUrl
  • GetPageGridByInstance
  • GetPropertyValue
  • GetSearchParameter
  • GetSharepointBarElement
  • GetUrlParameters
  • HandleSharepointBar
  • HideSharepointBar
  • IsAppManagerLaguageCompatible
  • JsonArrayKeyToLower
  • OpenInterchange
  • PageBindCloseWidgets
  • PageResizeWidgets
  • PopUpLink
  • PromptExitEditMode
  • RegisterAppManagerLoggedInCheckHandler
  • ShowAlertPopup
  • ShowSharepointBar
  • ToggleDebugger
  • ToggleExistPageBuilderManager
  • ToggleImpersonator
  • ToggleItemManager
  • ToggleLiveMode
  • TogglePageBuilderManager
  • TogglePageManager
  • ToggleWidgetManager

Methods

Static AllPermissionsNA

▸ AllPermissionsNA(isPagePropertisPopUp: boolean | null): void

Defined in index.d.ts:321

Shows confirmation popup if all permissions are set as NA It is called from add page tab and page properties update

Parameters:

NameTypeDescription
isPagePropertisPopUpboolean | nulltrue if called from page properties.

Returns: void


Static AttemptReset

▸ AttemptReset(): void

Defined in index.d.ts:325

Called to show confirmation pop up while exiting edit page mode.

Returns: void


Static CheckAppManagerIsLoggedIn

▸ CheckAppManagerIsLoggedIn(): void

Defined in index.d.ts:330

Check if iser is logged into appmanager and set the flag accordingly

Returns: void


Static ConvertValue

▸ ConvertValue(value: any, dataType: string): boolean | JSON

Defined in index.d.ts:335

Takes string or any value as input & can return it as boolean or JSON @param value Any value @param dataType Required retrun type "bool", "boolean", "json"

Parameters:

NameType
valueany
dataTypestring

Returns: boolean | JSON


Static DeDupArray

▸ DeDupArray(array: any): any

Defined in index.d.ts:340

Removes duplicate entries from an array

Parameters:

NameTypeDescription
arrayanyArray to be filter

Returns: any


Static FindSearchResultCategory

▸ FindSearchResultCategory(result: any[], isCurrent: boolean): string

Defined in index.d.ts:346

Parameters:

NameType
resultany[]
isCurrentboolean

Returns: string

Returns value of key ListID or SiteTitle(in case of isCurrent true)


Static FormatDateStringToJSFormat

▸ FormatDateStringToJSFormat(format: string, date: string): string

Defined in index.d.ts:353

Convert date string to jsformat date string Acceptable formats "mm/dd/yy", "dd/mm/yy", "dd-mm-yy", "mm/dd/yyyy", "dd/mm/yyyy", "dd-mm-yyyy" @param format @param date @returns Converted date string in format "dd/mm/yy" or "mm/dd/yyyy"

Parameters:

NameType
formatstring
datestring

Returns: string


Static GetCurrentPageId

▸ GetCurrentPageId(): any

Defined in index.d.ts:355

Returns an object with pageId property

Returns: any


Static GetDashboardGridByInstance

▸ GetDashboardGridByInstance(instanceId: string): string[]

Defined in index.d.ts:356

Parameters:

NameType
instanceIdstring

Returns: string[]


Static GetDateFormatForSiteLocaleId

▸ GetDateFormatForSiteLocaleId(): JQueryDeferred‹any›

Defined in index.d.ts:365

Returns a deffered which will resolve with site specific date format object

Returns: JQueryDeferred‹any›

deffered resolved with object type: { "dateformat": "mm/dd/yy", "momentformat": "MM/DD/YY", "displayformat": "MM/DD/YYYY", "languagecode": "en-US" }


Static GetEmployeeDetailUrl

▸ GetEmployeeDetailUrl(id: string): JQueryDeferred‹any›

Defined in index.d.ts:370

Resolves with Employee Detail Url

Parameters:

NameTypeDescription
idstringUserId

Returns: JQueryDeferred‹any›


Static GetGuid

▸ GetGuid(): string

Defined in index.d.ts:374

Get new GUID

Returns: string


Static GetLinkForResult

▸ GetLinkForResult(itemUrl: string): string

Defined in index.d.ts:375

Parameters:

NameType
itemUrlstring

Returns: string


Static GetLinkParameter

▸ GetLinkParameter(itemUrl: string, paramToRetrieve: string, defaultValue: string): string

Defined in index.d.ts:376

Parameters:

NameType
itemUrlstring
paramToRetrievestring
defaultValuestring

Returns: string


Static GetManagerUrl

▸ GetManagerUrl(): string

Defined in index.d.ts:380

relative path for manager script

Returns: string


Static GetPageGridByInstance

▸ GetPageGridByInstance(instanceId: string): string[]

Defined in index.d.ts:385

Returns Page Grid for workspace widget Instancce Id's

Parameters:

NameTypeDescription
instanceIdstringWidget Instance ID

Returns: string[]


Static GetPropertyValue

▸ GetPropertyValue(requestIn: any, key: string, defaultValue: string, dataType: string): boolean | JSON

Defined in index.d.ts:386

Parameters:

NameType
requestInany
keystring
defaultValuestring
dataTypestring

Returns: boolean | JSON


Static GetSearchParameter

▸ GetSearchParameter(itemResults: any[], paramToRetrieve: string, defaultValue: string): string

Defined in index.d.ts:388

Retrive search parameter value from results

Parameters:

NameType
itemResultsany[]
paramToRetrievestring
defaultValuestring

Returns: string


Static GetSharepointBarElement

▸ GetSharepointBarElement(): any

Defined in index.d.ts:392

Returns: any

element of sharepoint bar


Static GetUrlParameters

▸ GetUrlParameters(): any

Defined in index.d.ts:396

Returns: any

object with URL parameters


Static HandleSharepointBar

▸ HandleSharepointBar(args: any): void

Defined in index.d.ts:397

Parameters:

NameType
argsany

Returns: void


Static HideSharepointBar

▸ HideSharepointBar(setCookie: boolean): void

Defined in index.d.ts:402

Hide sharepoint bar

Parameters:

NameTypeDescription
setCookiebooleanboolean

Returns: void


Static IsAppManagerLaguageCompatible

▸ IsAppManagerLaguageCompatible(): JQueryDeferred‹any›

Defined in index.d.ts:403

Returns: JQueryDeferred‹any›


Static JsonArrayKeyToLower

▸ JsonArrayKeyToLower(data: string): any[]

Defined in index.d.ts:408

Convert object keys to lowercase @param data JSON String of Array of objects @returns Array of JSON objects with all keys in lowercase

Parameters:

NameType
datastring

Returns: any[]


Static OpenInterchange

▸ OpenInterchange(): void

Defined in index.d.ts:412

Open interchange in new tab

Returns: void


Static PageBindCloseWidgets

▸ PageBindCloseWidgets(args: any, grid: any): void

Defined in index.d.ts:413

Parameters:

NameType
argsany
gridany

Returns: void


Static PageResizeWidgets

▸ PageResizeWidgets(args: any): void

Defined in index.d.ts:414

Parameters:

NameType
argsany

Returns: void


Static PopUpLink

▸ PopUpLink(link: string): void

Defined in index.d.ts:419

Open link in new window/tab.

Parameters:

NameTypeDescription
linkstringLink to open

Returns: void


Static PromptExitEditMode

▸ PromptExitEditMode(): void

Defined in index.d.ts:421

This method will show confirmation pop-up if user try to exit page edit mode

Returns: void


Static RegisterAppManagerLoggedInCheckHandler

▸ RegisterAppManagerLoggedInCheckHandler(): void

Defined in index.d.ts:423

Register timer to check if user is logged into appmanager every minute

Returns: void


Static ShowAlertPopup

▸ ShowAlertPopup(message: string, options: any, actioncallback?: any): void

Defined in index.d.ts:430

To show message in alert box

Parameters:

NameTypeDescription
messagestringMessage text to show
optionsanyCustome options {width}
actioncallback?anyMethod to be called when user click ok

Returns: void


Static ShowSharepointBar

▸ ShowSharepointBar(setCookie: boolean): void

Defined in index.d.ts:435

Show sharepoint bar

Parameters:

NameTypeDescription
setCookiebooleanboolean

Returns: void


Static ToggleDebugger

▸ ToggleDebugger(): void

Defined in index.d.ts:439

Toggle Debugger panel

Returns: void


Static ToggleExistPageBuilderManager

▸ ToggleExistPageBuilderManager(): void

Defined in index.d.ts:440

Returns: void


Static ToggleImpersonator

▸ ToggleImpersonator(): void

Defined in index.d.ts:442

Toggle Impersonator mode

Returns: void


Static ToggleItemManager

▸ ToggleItemManager(): void

Defined in index.d.ts:444

Toggle Widget properties edit mode

Returns: void


Static ToggleLiveMode

▸ ToggleLiveMode(): void

Defined in index.d.ts:446

Toggle live preview mode

Returns: void


Static TogglePageBuilderManager

▸ TogglePageBuilderManager(): void

Defined in index.d.ts:448

Toggle page builder (Add new page)

Returns: void


Static TogglePageManager

▸ TogglePageManager(): void

Defined in index.d.ts:450

Toggle page edit mode

Returns: void


Static ToggleWidgetManager

▸ ToggleWidgetManager(): void

Defined in index.d.ts:452

Toggle widget edit mode

Returns: void

← UserContextDateTimeManager →
  • Hierarchy
  • Index
    • Classes
    • Methods
  • Methods
    • Static AllPermissionsNA
    • Static AttemptReset
    • Static CheckAppManagerIsLoggedIn
    • Static ConvertValue
    • Static DeDupArray
    • Static FindSearchResultCategory
    • Static FormatDateStringToJSFormat
    • Static GetCurrentPageId
    • Static GetDashboardGridByInstance
    • Static GetDateFormatForSiteLocaleId
    • Static GetEmployeeDetailUrl
    • Static GetGuid
    • Static GetLinkForResult
    • Static GetLinkParameter
    • Static GetManagerUrl
    • Static GetPageGridByInstance
    • Static GetPropertyValue
    • Static GetSearchParameter
    • Static GetSharepointBarElement
    • Static GetUrlParameters
    • Static HandleSharepointBar
    • Static HideSharepointBar
    • Static IsAppManagerLaguageCompatible
    • Static JsonArrayKeyToLower
    • Static OpenInterchange
    • Static PageBindCloseWidgets
    • Static PageResizeWidgets
    • Static PopUpLink
    • Static PromptExitEditMode
    • Static RegisterAppManagerLoggedInCheckHandler
    • Static ShowAlertPopup
    • Static ShowSharepointBar
    • Static ToggleDebugger
    • Static ToggleExistPageBuilderManager
    • Static ToggleImpersonator
    • Static ToggleItemManager
    • Static ToggleLiveMode
    • Static TogglePageBuilderManager
    • Static TogglePageManager
    • Static ToggleWidgetManager
Akumina Developer Documentation
Docs
Akumina Framework 5.0Akumina Widget BuilderAkumina Yeoman GeneratorSite Deployer
Community
Akumina Community Site
More
GitHubStar
Copyright © 2024 Akumina