Interchange
definitely-typed › Akumina › Digispace › Data › Interchange
Hierarchy
- Interchange
Index
Methods
- AppPart
- CheckAssignedLicenses
- DecryptData
- EncryptData
- GetActivatedFeatures
- GetAppManagerLanguageId
- GetAppManagerVersion
- GetApps
- GetConfiguration
- GetDashboardWidgets
- GetFacets
- GetListsForContentType
- GetMenuApps
- GetMyAppsCacheKey
- GetPageObjectForPageUrl
- GetPermissionForListItemForCurrentUser
- GetSPGroupUsersAndUserGroupsList
- GetUserAccessibleApps
- GetUserGroups
- GetUserGroupsFromAppManager
- GetUserPersonas
- GetUsersData
- GetWidgetJS
- IsLoggedIntoAppManager
- IsWorkspaceMarkedAsDeleted
- MarkWorkspaceAsDeleted
- PerformChangeSite
- ProvisionPageWidgets
- RefreshAkToken
- UpdatePageObjectsCache
- UpdatePageProperties
- UpdateWidgetInstanceCache
- ValidateAkToken
Methods
AppPart
▸ AppPart(referenceList
: string, itemId
: string): any
Defined in index.d.ts:903
Parameters:
Name | Type |
---|---|
referenceList | string |
itemId | string |
Returns: any
CheckAssignedLicenses
▸ CheckAssignedLicenses(memberids
: string): JQueryDeferred‹any›
Defined in index.d.ts:1002
Check licenses assigned to members
Parameters:
Name | Type | Description |
---|---|---|
memberids | string | string |
Returns: JQueryDeferred‹any›
DecryptData
▸ DecryptData(data
: string): JQueryDeferred‹any›
Defined in index.d.ts:1070
Send data to decrypt
Parameters:
Name | Type | Description |
---|---|---|
data | string |
Returns: JQueryDeferred‹any›
EncryptData
▸ EncryptData(data
: string): JQueryDeferred‹any›
Defined in index.d.ts:1064
Send data to encrypt
Parameters:
Name | Type | Description |
---|---|---|
data | string |
Returns: JQueryDeferred‹any›
GetActivatedFeatures
▸ GetActivatedFeatures(): JQueryDeferred‹any›
Defined in index.d.ts:1008
Get activated Features on site.
Returns: JQueryDeferred‹any›
Resolves in success with JSON object
GetAppManagerLanguageId
▸ GetAppManagerLanguageId(): JQueryDeferred‹any›
Defined in index.d.ts:1053
Returns: JQueryDeferred‹any›
Resolves with language ID {number}
GetAppManagerVersion
▸ GetAppManagerVersion(): JQueryDeferred‹any›
Defined in index.d.ts:1058
Returns: JQueryDeferred‹any›
Def Resolves in success with Version Object {FileVersion: string, ProductVersion: string}
GetApps
▸ GetApps(listName
: string): JQueryDeferred‹any›
Defined in index.d.ts:953
Get list of apps available for user
Parameters:
Name | Type | Description |
---|---|---|
listName | string | String |
Returns: JQueryDeferred‹any›
GetConfiguration
▸ GetConfiguration(): any
Defined in index.d.ts:887
Get Configuration object
Returns: any
GetDashboardWidgets
▸ GetDashboardWidgets(): JQueryDeferred‹any›
Defined in index.d.ts:1019
Returns: JQueryDeferred‹any›
resolves with array of widget objects
GetFacets
▸ GetFacets(facetObj
: any[]): JQueryDeferred‹any›
Defined in index.d.ts:984
Get Facets from interchange
Parameters:
Name | Type | Description |
---|---|---|
facetObj | any[] | List of facets object |
Returns: JQueryDeferred‹any›
GetListsForContentType
▸ GetListsForContentType(contenttype
: string): JQueryDeferred‹any›
Defined in index.d.ts:929
Get sharepoint lists associated with the passed content type
Parameters:
Name | Type | Description |
---|---|---|
contenttype | string |
Returns: JQueryDeferred‹any›
GetMenuApps
▸ GetMenuApps(): any
Defined in index.d.ts:899
Returns: any
GetMyAppsCacheKey
▸ GetMyAppsCacheKey(attribute
: string): JQueryDeferred‹any›
Defined in index.d.ts:978
Get myapps cache key for the current user
Parameters:
Name | Type | Description |
---|---|---|
attribute | string |
Returns: JQueryDeferred‹any›
GetPageObjectForPageUrl
▸ GetPageObjectForPageUrl(relativePageUrl
: string): JQueryDeferred‹any›
Defined in index.d.ts:917
Get page object from pageURL
Parameters:
Name | Type | Description |
---|---|---|
relativePageUrl | string |
Returns: JQueryDeferred‹any›
GetPermissionForListItemForCurrentUser
▸ GetPermissionForListItemForCurrentUser(listName
: string, itemId
: string): JQueryDeferred‹any›
Defined in index.d.ts:935
Parameters:
Name | Type | Description |
---|---|---|
listName | string | SharePoint List name ex. GenericPages_AK |
itemId | string | Item Id for which permissions need to be checked |
Returns: JQueryDeferred‹any›
GetSPGroupUsersAndUserGroupsList
▸ GetSPGroupUsersAndUserGroupsList(authorization
: any): JQueryDeferred‹any›
Defined in index.d.ts:972
Get UserGroup list based of type of authoristion
Parameters:
Name | Type | Description |
---|---|---|
authorization | any |
Returns: JQueryDeferred‹any›
GetUserAccessibleApps
▸ GetUserAccessibleApps(groups
: null, appsData
: any[]): JQueryDeferred‹any›
Defined in index.d.ts:966
Filter user accessible apps from list of apps.
Parameters:
Name | Type | Description |
---|---|---|
groups | null | User Groups #MARK currently not used. |
appsData | any[] | List of apps |
Returns: JQueryDeferred‹any›
GetUserGroups
▸ GetUserGroups(model
: any): JQueryDeferred‹any›
Defined in index.d.ts:1048
Get user groups
Parameters:
Name | Type | Description |
---|---|---|
model | any |
Returns: JQueryDeferred‹any›
GetUserGroupsFromAppManager
▸ GetUserGroupsFromAppManager(): JQueryDeferred‹any›
Defined in index.d.ts:959
Get groups the current user is added to.
Returns: JQueryDeferred‹any›
def resolves in success with Array of names of User Groups of current user.
GetUserPersonas
▸ GetUserPersonas(userId
: string): JQueryDeferred‹any›
Defined in index.d.ts:947
To get personas assigned to a user
Parameters:
Name | Type |
---|---|
userId | string |
Returns: JQueryDeferred‹any›
deferred resolves with array of presonas string
GetUsersData
▸ GetUsersData(currentUserName
: string, filters
: any, pageSize
: number, pageNumber
: number, orderByField
: string, sortDirection
: string): any
Defined in index.d.ts:898
Get Users Data List
Parameters:
Name | Type | Description |
---|---|---|
currentUserName | string | - |
filters | any | - |
pageSize | number | - |
pageNumber | number | - |
orderByField | string | - |
sortDirection | string |
Returns: any
GetWidgetJS
▸ GetWidgetJS(widgets
: any[], widgetNames
: string[]): JQueryDeferred‹any›
Defined in index.d.ts:1042
Fetches widgets js
Parameters:
Name | Type | Description |
---|---|---|
widgets | any[] | Array of widget objects |
widgetNames | string[] | Array of widget names |
Returns: JQueryDeferred‹any›
IsLoggedIntoAppManager
▸ IsLoggedIntoAppManager(): JQueryDeferred‹any›
Defined in index.d.ts:940
Check if user is logged into appManager
Returns: JQueryDeferred‹any›
IsWorkspaceMarkedAsDeleted
▸ IsWorkspaceMarkedAsDeleted(workspaceId
: string): JQueryDeferred‹any›
Defined in index.d.ts:996
Check if workspace is marked for delete
Parameters:
Name | Type | Description |
---|---|---|
workspaceId | string | string |
Returns: JQueryDeferred‹any›
MarkWorkspaceAsDeleted
▸ MarkWorkspaceAsDeleted(workspaceId
: string): JQueryDeferred‹any›
Defined in index.d.ts:990
Marks workspace as deleted
Parameters:
Name | Type | Description |
---|---|---|
workspaceId | string | workspace id |
Returns: JQueryDeferred‹any›
PerformChangeSite
▸ PerformChangeSite(selectedSiteId
: string): JQueryDeferred‹any›
Defined in index.d.ts:1025
Resolves with siteID
Parameters:
Name | Type | Description |
---|---|---|
selectedSiteId | string |
Returns: JQueryDeferred‹any›
ProvisionPageWidgets
▸ ProvisionPageWidgets(pageWidgetsRequest
: ISavePageWidgetRequest): JQueryDeferred‹any›
Defined in index.d.ts:1076
Save page widgets
Parameters:
Name | Type |
---|---|
pageWidgetsRequest | ISavePageWidgetRequest |
Returns: JQueryDeferred‹any›
RefreshAkToken
▸ RefreshAkToken(): JQueryDeferred‹any›
Defined in index.d.ts:1035
Returns: JQueryDeferred‹any›
Resolves in success with boolean value
UpdatePageObjectsCache
▸ UpdatePageObjectsCache(pageObjects
: any): JQueryDeferred‹any›
Defined in index.d.ts:923
Update Page object Cache
Parameters:
Name | Type | Description |
---|---|---|
pageObjects | any |
Returns: JQueryDeferred‹any›
UpdatePageProperties
▸ UpdatePageProperties(referenceList
: string, itemId
: string, data
: any): JQueryDeferred‹any›
Defined in index.d.ts:911
Update Page properties
Parameters:
Name | Type | Description |
---|---|---|
referenceList | string | - |
itemId | string | - |
data | any |
Returns: JQueryDeferred‹any›
UpdateWidgetInstanceCache
▸ UpdateWidgetInstanceCache(widgetInstanceId?
: undefined | string): JQueryDeferred‹any›
Defined in index.d.ts:1014
Updates widget instance cache
Parameters:
Name | Type | Description |
---|---|---|
widgetInstanceId? | undefined | string | Optional |
Returns: JQueryDeferred‹any›
ValidateAkToken
▸ ValidateAkToken(): JQueryDeferred‹any›
Defined in index.d.ts:1030
Returns: JQueryDeferred‹any›
Resolves in success with boolean value