Akumina Developer Documentation

Akumina Developer Documentation

  • API
  • Docs
  • Blog

Utilities

@types/akumina-core - v5.0.0 › Globals › Akumina › Digispace › Utilities

Hierarchy

  • Utilities

Index

Classes

  • DateTimeManager

Methods

  • AllPermissionsNA
  • ArePersonasDefined
  • AttemptReset
  • AzureADEnabledOrAppManagerLoggedIn
  • CheckAppManagerIsLoggedIn
  • ConvertValue
  • CreatePageLink
  • DeDupArray
  • ExitEditModeAndRefreshPage
  • FindSearchResultCategory
  • FormatDateStringToJSFormat
  • GetCurrentPageId
  • GetDashboardGridByInstance
  • GetDateFormatForSiteLocaleId
  • GetEmployeeDetailUrl
  • GetGuid
  • GetLinkForResult
  • GetLinkParameter
  • GetPageGridByInstance
  • GetPropertyValue
  • GetSearchParameter
  • GetSharepointBarElement
  • GetStickyNoteMessage
  • GetUrlParameters
  • HandleSharepointBar
  • HideSharepointBar
  • IsAppManagerLaguageCompatible
  • IsLoggedinToAppManager
  • IsSignInAccount
  • JsonArrayKeyToLower
  • LoginToAppmanagerHtml
  • OnSpaLinkClick
  • 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:360

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 ArePersonasDefined

▸ ArePersonasDefined(): boolean

Defined in index.d.ts:492

Returns: boolean


Static AttemptReset

▸ AttemptReset(callback: any): void

Defined in index.d.ts:364

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

Parameters:

NameType
callbackany

Returns: void


Static AzureADEnabledOrAppManagerLoggedIn

▸ AzureADEnabledOrAppManagerLoggedIn(): boolean

Defined in index.d.ts:490

Returns: boolean


Static CheckAppManagerIsLoggedIn

▸ CheckAppManagerIsLoggedIn(): void

Defined in index.d.ts:369

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:374

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 CreatePageLink

▸ CreatePageLink(url: string): string

Defined in index.d.ts:496

Parameters:

NameType
urlstring

Returns: string


Static DeDupArray

▸ DeDupArray(array: any): any

Defined in index.d.ts:379

Removes duplicate entries from an array

Parameters:

NameTypeDescription
arrayanyArray to be filter

Returns: any


Static ExitEditModeAndRefreshPage

▸ ExitEditModeAndRefreshPage(): void

Defined in index.d.ts:491

Returns: void


Static FindSearchResultCategory

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

Defined in index.d.ts:385

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:392

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:394

Returns an object with pageId property

Returns: any


Static GetDashboardGridByInstance

▸ GetDashboardGridByInstance(instanceId: string): string[]

Defined in index.d.ts:395

Parameters:

NameType
instanceIdstring

Returns: string[]


Static GetDateFormatForSiteLocaleId

▸ GetDateFormatForSiteLocaleId(): JQueryDeferred‹any›

Defined in index.d.ts:404

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:409

Resolves with Employee Detail Url

Parameters:

NameTypeDescription
idstringUserId

Returns: JQueryDeferred‹any›


Static GetGuid

▸ GetGuid(): string

Defined in index.d.ts:413

Get new GUID

Returns: string


Static GetLinkForResult

▸ GetLinkForResult(itemUrl: string): string

Defined in index.d.ts:414

Parameters:

NameType
itemUrlstring

Returns: string


Static GetLinkParameter

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

Defined in index.d.ts:415

Parameters:

NameType
itemUrlstring
paramToRetrievestring
defaultValuestring

Returns: string


Static GetPageGridByInstance

▸ GetPageGridByInstance(instanceId: string): string[]

Defined in index.d.ts:420

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): any

Defined in index.d.ts:421

Parameters:

NameType
requestInany
keystring
defaultValuestring
dataTypestring

Returns: any


Static GetSearchParameter

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

Defined in index.d.ts:423

Retrive search parameter value from results

Parameters:

NameType
itemResultsany[]
paramToRetrievestring
defaultValuestring

Returns: string


Static GetSharepointBarElement

▸ GetSharepointBarElement(): any

Defined in index.d.ts:427

Returns: any

element of sharepoint bar


Static GetStickyNoteMessage

▸ GetStickyNoteMessage(): string

Defined in index.d.ts:493

Returns: string


Static GetUrlParameters

▸ GetUrlParameters(): any

Defined in index.d.ts:431

Returns: any

object with URL parameters


Static HandleSharepointBar

▸ HandleSharepointBar(args: any): void

Defined in index.d.ts:432

Parameters:

NameType
argsany

Returns: void


Static HideSharepointBar

▸ HideSharepointBar(setCookie: boolean): void

Defined in index.d.ts:437

Hide sharepoint bar

Parameters:

NameTypeDescription
setCookiebooleanboolean

Returns: void


Static IsAppManagerLaguageCompatible

▸ IsAppManagerLaguageCompatible(): JQueryDeferred‹any›

Defined in index.d.ts:438

Returns: JQueryDeferred‹any›


Static IsLoggedinToAppManager

▸ IsLoggedinToAppManager(): void

Defined in index.d.ts:488

Returns: void


Static IsSignInAccount

▸ IsSignInAccount(): boolean

Defined in index.d.ts:494

Returns: boolean


Static JsonArrayKeyToLower

▸ JsonArrayKeyToLower(data: string): any[]

Defined in index.d.ts:443

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 LoginToAppmanagerHtml

▸ LoginToAppmanagerHtml(): void

Defined in index.d.ts:489

Returns: void


Static OnSpaLinkClick

▸ OnSpaLinkClick(pageRoute: string, openInNewWindow: boolean): void

Defined in index.d.ts:495

Parameters:

NameType
pageRoutestring
openInNewWindowboolean

Returns: void


Static OpenInterchange

▸ OpenInterchange(): void

Defined in index.d.ts:447

Open interchange in new tab

Returns: void


Static PageBindCloseWidgets

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

Defined in index.d.ts:448

Parameters:

NameType
argsany
gridany

Returns: void


Static PageResizeWidgets

▸ PageResizeWidgets(args: any): void

Defined in index.d.ts:449

Parameters:

NameType
argsany

Returns: void


Static PopUpLink

▸ PopUpLink(link: string): void

Defined in index.d.ts:454

Open link in new window/tab.

Parameters:

NameTypeDescription
linkstringLink to open

Returns: void


Static PromptExitEditMode

▸ PromptExitEditMode(): void

Defined in index.d.ts:456

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:458

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:465

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:470

Show sharepoint bar

Parameters:

NameTypeDescription
setCookiebooleanboolean

Returns: void


Static ToggleDebugger

▸ ToggleDebugger(): void

Defined in index.d.ts:474

Toggle Debugger panel

Returns: void


Static ToggleExistPageBuilderManager

▸ ToggleExistPageBuilderManager(): void

Defined in index.d.ts:475

Returns: void


Static ToggleImpersonator

▸ ToggleImpersonator(): void

Defined in index.d.ts:477

Toggle Impersonator mode

Returns: void


Static ToggleItemManager

▸ ToggleItemManager(): void

Defined in index.d.ts:479

Toggle Widget properties edit mode

Returns: void


Static ToggleLiveMode

▸ ToggleLiveMode(): void

Defined in index.d.ts:481

Toggle live preview mode

Returns: void


Static TogglePageBuilderManager

▸ TogglePageBuilderManager(): void

Defined in index.d.ts:483

Toggle page builder (Add new page)

Returns: void


Static TogglePageManager

▸ TogglePageManager(): void

Defined in index.d.ts:485

Toggle page edit mode

Returns: void


Static ToggleWidgetManager

▸ ToggleWidgetManager(): void

Defined in index.d.ts:487

Toggle widget edit mode

Returns: void

  • Hierarchy
  • Index
    • Classes
    • Methods
  • Methods
    • Static AllPermissionsNA
    • Static ArePersonasDefined
    • Static AttemptReset
    • Static AzureADEnabledOrAppManagerLoggedIn
    • Static CheckAppManagerIsLoggedIn
    • Static ConvertValue
    • Static CreatePageLink
    • Static DeDupArray
    • Static ExitEditModeAndRefreshPage
    • Static FindSearchResultCategory
    • Static FormatDateStringToJSFormat
    • Static GetCurrentPageId
    • Static GetDashboardGridByInstance
    • Static GetDateFormatForSiteLocaleId
    • Static GetEmployeeDetailUrl
    • Static GetGuid
    • Static GetLinkForResult
    • Static GetLinkParameter
    • Static GetPageGridByInstance
    • Static GetPropertyValue
    • Static GetSearchParameter
    • Static GetSharepointBarElement
    • Static GetStickyNoteMessage
    • Static GetUrlParameters
    • Static HandleSharepointBar
    • Static HideSharepointBar
    • Static IsAppManagerLaguageCompatible
    • Static IsLoggedinToAppManager
    • Static IsSignInAccount
    • Static JsonArrayKeyToLower
    • Static LoginToAppmanagerHtml
    • Static OnSpaLinkClick
    • 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