Utilities
definitely-typed › Akumina › Digispace › Utilities
Hierarchy
- Utilities
Index
Classes
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:
Name | Type | Description |
---|---|---|
isPagePropertisPopUp | boolean | null | true 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:
Name | Type |
---|---|
value | any |
dataType | string |
Returns: boolean | JSON
Static
DeDupArray
▸ DeDupArray(array
: any): any
Defined in index.d.ts:340
Removes duplicate entries from an array
Parameters:
Name | Type | Description |
---|---|---|
array | any | Array to be filter |
Returns: any
Static
FindSearchResultCategory
▸ FindSearchResultCategory(result
: any[], isCurrent
: boolean): string
Defined in index.d.ts:346
Parameters:
Name | Type |
---|---|
result | any[] |
isCurrent | boolean |
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:
Name | Type |
---|---|
format | string |
date | string |
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:
Name | Type |
---|---|
instanceId | string |
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:
Name | Type | Description |
---|---|---|
id | string | UserId |
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:
Name | Type |
---|---|
itemUrl | string |
Returns: string
Static
GetLinkParameter
▸ GetLinkParameter(itemUrl
: string, paramToRetrieve
: string, defaultValue
: string): string
Defined in index.d.ts:376
Parameters:
Name | Type |
---|---|
itemUrl | string |
paramToRetrieve | string |
defaultValue | string |
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:
Name | Type | Description |
---|---|---|
instanceId | string | Widget Instance ID |
Returns: string[]
Static
GetPropertyValue
▸ GetPropertyValue(requestIn
: any, key
: string, defaultValue
: string, dataType
: string): boolean | JSON
Defined in index.d.ts:386
Parameters:
Name | Type |
---|---|
requestIn | any |
key | string |
defaultValue | string |
dataType | string |
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:
Name | Type |
---|---|
itemResults | any[] |
paramToRetrieve | string |
defaultValue | string |
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:
Name | Type |
---|---|
args | any |
Returns: void
Static
HideSharepointBar
▸ HideSharepointBar(setCookie
: boolean): void
Defined in index.d.ts:402
Hide sharepoint bar
Parameters:
Name | Type | Description |
---|---|---|
setCookie | boolean | boolean |
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:
Name | Type |
---|---|
data | string |
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:
Name | Type |
---|---|
args | any |
grid | any |
Returns: void
Static
PageResizeWidgets
▸ PageResizeWidgets(args
: any): void
Defined in index.d.ts:414
Parameters:
Name | Type |
---|---|
args | any |
Returns: void
Static
PopUpLink
▸ PopUpLink(link
: string): void
Defined in index.d.ts:419
Open link in new window/tab.
Parameters:
Name | Type | Description |
---|---|---|
link | string | Link 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:
Name | Type | Description |
---|---|---|
message | string | Message text to show |
options | any | Custome options {width} |
actioncallback? | any | Method 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:
Name | Type | Description |
---|---|---|
setCookie | boolean | boolean |
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