File

projects/m2-core/src/lib/core/service/config/client-config.service.ts

Extends

ApiService

Index

Properties
Methods
Accessors

Constructor

constructor(http: HttpClient, logger: Logger, endpointService: EndpointConfigService)
Parameters :
Name Type Optional
http HttpClient No
logger Logger No
endpointService EndpointConfigService No

Methods

Public addEmailGuestDefaultSecurityGroup
addEmailGuestDefaultSecurityGroup(groupId: number)
Parameters :
Name Type Optional
groupId number No
Returns : Promise<void>
Static applyWorkTimeMode
applyWorkTimeMode(workTime: WorkTime)
Parameters :
Name Type Optional
workTime WorkTime No
Returns : void
Public clearGlobalSearchParamsCustomization
clearGlobalSearchParamsCustomization(tablePresentationId: number)
Parameters :
Name Type Optional
tablePresentationId number No
Returns : Promise<void>
Public clearTableCustomization
clearTableCustomization(tablePresentationId: number, skipChildren?: boolean)
Parameters :
Name Type Optional
tablePresentationId number No
skipChildren boolean Yes
Returns : Promise<void>
Public clearUserSearchParamsCustomization
clearUserSearchParamsCustomization(tablePresentationId: number)
Parameters :
Name Type Optional
tablePresentationId number No
Returns : Promise<void>
Public createExtendedSearchCriteriaContextMenu
createExtendedSearchCriteriaContextMenu(tablePresentationId: number, uiFilters: SearchUIFilter[], validateExtendedSearchFiltersFn: Function, roles: SecurityRoleType[])

Search

Parameters :
Name Type Optional
tablePresentationId number No
uiFilters SearchUIFilter[] No
validateExtendedSearchFiltersFn Function No
roles SecurityRoleType[] No
Returns : MenuItem[]
Public createPersonalReferenceBook
createPersonalReferenceBook()
Public deleteClientFile
deleteClientFile(filePath: string)
Parameters :
Name Type Optional
filePath string No
Returns : Promise<void>
Public deleteEmailGuestDefaultSecurityGroup
deleteEmailGuestDefaultSecurityGroup(groupId: number)
Parameters :
Name Type Optional
groupId number No
Returns : Promise<void>
Public deletePersonalReferenceBooks
deletePersonalReferenceBooks(bookIds: number[])
Parameters :
Name Type Optional
bookIds number[] No
Returns : Promise<void>
Public editClientParams
editClientParams(requests: EditClientParamRequest[])

Редактирование параметра (доступно только пользователю с ролью "sysAdministration").

Parameters :
Name Type Optional
requests EditClientParamRequest[] No
Returns : Promise<void>
Public editPersonalReferenceBook
editPersonalReferenceBook(request: EditReferenceBookRequest)
Parameters :
Name Type Optional
request EditReferenceBookRequest No
Public editPersonalReferenceBooks
editPersonalReferenceBooks(requests: EditReferenceBookRequest[])

Personal reference books

Parameters :
Name Type Optional
requests EditReferenceBookRequest[] No
Public editWebappParam
editWebappParam(paramName, paramValue: ParamValue | ParamValue[], valueType?: AttributeType)
Parameters :
Name Type Optional
paramName No
paramValue ParamValue | ParamValue[] No
valueType AttributeType Yes
Returns : Promise<void>
Public editWorkTime
editWorkTime(request: EditWorkTimeRequest)
Parameters :
Name Type Optional
request EditWorkTimeRequest No
Returns : Promise<WorkTime>
Public getApplicationItemAttributeValueSuggestions
getApplicationItemAttributeValueSuggestions(propertyId: number, applicationId: number, filterOnValues, phrase: string)
Parameters :
Name Type Optional Default value
propertyId number No
applicationId number No
filterOnValues No true
phrase string No ''
Public getAppliedUpdates
getAppliedUpdates()

DB updates

Public getAuthInfo
getAuthInfo(reload?: boolean)
Parameters :
Name Type Optional
reload boolean Yes
Returns : Promise<AuthInfo>
Public getCliSpnegoDisable
getCliSpnegoDisable()
Returns : Promise<Blob>
Public getCliSpnegoEnable
getCliSpnegoEnable(request: LdapCliRequest)

LDAP

Parameters :
Name Type Optional
request LdapCliRequest No
Returns : Promise<Blob>
Public getConstraintTableSuggestions
getConstraintTableSuggestions(constraintTableId: number, meaningId: number, phrase: string)
Parameters :
Name Type Optional Default value
constraintTableId number No
meaningId number No
phrase string No ''
Public getDownloadClientFileUrl
getDownloadClientFileUrl(fileName: string, preventCache?: boolean)
Parameters :
Name Type Optional
fileName string No
preventCache boolean Yes
Returns : string
Public getEmailGuestDefaultSecurityGroups
getEmailGuestDefaultSecurityGroups()

Registration

Returns : Promise<number[]>
Public getFullTextPropositions
getFullTextPropositions(searchQuery: string, entityType: string)

Propositions

Parameters :
Name Type Optional Default value
searchQuery string No ''
entityType string No 'ITEM'
Public getFullTextSuggestions
getFullTextSuggestions(phrase: string, entityType: string)

Suggestions

Parameters :
Name Type Optional Default value
phrase string No ''
entityType string No 'ITEM'
Public getIsLoggedIn
getIsLoggedIn(reload?: boolean)
Parameters :
Name Type Optional
reload boolean Yes
Returns : Promise<boolean>
Public getLastUsedExtendedSearchCriterionValues
getLastUsedExtendedSearchCriterionValues(propertyId: number)
Parameters :
Name Type Optional
propertyId number No
Returns : Promise<string[]>
Public getModuleParams
getModuleParams(moduleId: string)
Parameters :
Name Type Optional
moduleId string No
Returns : Promise<SystemParameter[]>
Public getModules
getModules()

Module and its params

Returns : Promise<Module[]>
Public getNamedPropertyValueSuggestions
getNamedPropertyValueSuggestions(propertyId: number, phrase: string)

#16350 получить имеющиеся наименвания контекстов

Parameters :
Name Type Optional Default value
propertyId number No
phrase string No ''
Returns : Promise<string[]>
Public getOldWebAppSettings
getOldWebAppSettings()
Returns : Observable<WebAppSettings>
Public getPinnedElementsHolder
getPinnedElementsHolder(startPageEntryId?: number)
Parameters :
Name Type Optional
startPageEntryId number Yes
Public getPropertyValueSuggestions
getPropertyValueSuggestions(propertyId: number, elementId?: number, filterOnValues, phrase: string)
Parameters :
Name Type Optional Default value Description
propertyId number No
elementId number Yes
  • itemId (when we it's known), otherwise nodeId. In case neither itemId, nor nodeId is known, pass nothing
filterOnValues No true
phrase string No ''
Public getUserSettings
getUserSettings()

It's better to use userSettings$ instead

Returns : Promise<UserSettings>
Public getVersion
getVersion()

General

Returns : Promise<string>
Public getWorkTime
getWorkTime()

Work time

Returns : Promise<WorkTime>
Public getWorkTime$
getWorkTime$()
Public init
init()

App Settings

Returns : Promise<void>
Public loadSystemParams
loadSystemParams()
Returns : Promise<void>
Public reExecuteUpdate
reExecuteUpdate(updateId: number)
Parameters :
Name Type Optional
updateId number No
Public registerPlugin
registerPlugin(request: RegisterPluginRequest)

Если в запросе передается параметр, который уже заведен, его нужно пропустить. Порядок сортировки параметров взять из порядка запросов.

Parameters :
Name Type Optional
request RegisterPluginRequest No
Public resetAuthInfo
resetAuthInfo()
Returns : void
Public resetUserSettings
resetUserSettings()
Returns : Promise<void>
Public saveFullTextSearchCriteria
saveFullTextSearchCriteria(criteria: string)
Parameters :
Name Type Optional
criteria string No
Returns : Promise<void>
Public setInstalledPluginState
setInstalledPluginState(pluginName: string, isEnabled: boolean)

Plugins

Parameters :
Name Type Optional
pluginName string No
isEnabled boolean No
Returns : Promise<void>
Public setIsLoggedIn
setIsLoggedIn(isLoggedIn: boolean)
Parameters :
Name Type Optional
isLoggedIn boolean No
Returns : Promise<any>
Public setUserSearchParamsAsGlobal
setUserSearchParamsAsGlobal(tableId: number)
Parameters :
Name Type Optional
tableId number No
Returns : Promise<void>
Public unregisterPlugin
unregisterPlugin(pluginName: string, deleteSettings?: boolean)
Parameters :
Name Type Optional
pluginName string No
deleteSettings boolean Yes
Returns : Promise<void>
Public updateColumnAppearance
updateColumnAppearance(request: ColumnAppearanceRequest)
Parameters :
Name Type Optional
request ColumnAppearanceRequest No
Returns : Promise<void>
Public updateColumnsAppearance
updateColumnsAppearance(requests: ColumnAppearanceRequest[])

Table customization

Parameters :
Name Type Optional
requests ColumnAppearanceRequest[] No
Returns : Promise<void>
Public updateCustomStylesFile
updateCustomStylesFile(path: string)
Parameters :
Name Type Optional
path string No
Returns : Promise<void>
Public updateSearchParams
updateSearchParams(requests: SearchParameterRequest[])
Parameters :
Name Type Optional
requests SearchParameterRequest[] No
Returns : Observable<StringMap<SearchParameter>>
Public updateSearchParamsIfNeeded
updateSearchParamsIfNeeded(tableId: number, prevUIFilters: SearchUIFilter[], newFiltersInfo: SearchFilterInfo[])

Stored extended search filters

Parameters :
Name Type Optional
tableId number No
prevUIFilters SearchUIFilter[] No
newFiltersInfo SearchFilterInfo[] No
Returns : void
Public updateStartPageEntries
updateStartPageEntries(requests: StartPageEntryRequest[])

Start page

Parameters :
Name Type Optional
requests StartPageEntryRequest[] No
Returns : Promise<void>
Public updateStartPageEntry
updateStartPageEntry(request: StartPageEntryRequest)
Parameters :
Name Type Optional
request StartPageEntryRequest No
Returns : Promise<void>
Public updateUseCustomStyles
updateUseCustomStyles(use: boolean)

Custom stylesheet

Parameters :
Name Type Optional
use boolean No
Returns : Promise<void>
Public Async updateUserSettings
updateUserSettings(modify: (s: UserSettings) => void, predicate?: (s?: UserSettings) => void)

Отредактировать пользовательские настройки

Parameters :
Name Type Optional Description
modify function No

функция, модифицирующая пользовательские настройки

predicate function Yes

опциональная функция, определяющая необходимость изменения

Returns : Promise<void>
Public updateVisibleColumns
updateVisibleColumns(requests: ColumnAppearanceRequest[], tableType: TableType | string, getVisibleColumnIdsFn: (settings: UserSettings) => void)

User defined columns set update

Parameters :
Name Type Optional
requests ColumnAppearanceRequest[] No
tableType TableType | string No
getVisibleColumnIdsFn function No
Returns : Promise<void>
Public uploadClientFile
uploadClientFile(request: UploadFileRequest)

Client files

Parameters :
Name Type Optional
request UploadFileRequest No
Returns : Promise<string>

Properties

Public webAppSettings$
Default value : this.webAppSettingsSubj$.asObservable()

Accessors

webAppSettings
getwebAppSettings()
userSettings$
getuserSettings$()

results matching ""

    No results matching ""