Docs for m2-core, m2-components
  1. Injectables
  2. ApplicationsService

File

projects/m2-core/src/lib/core/service/application/applications.service.ts

Index

Methods

Constructor

constructor(router: Router, propertyValueService: PropertyValueService, applicationTemplateReadService: ApplicationTemplateReadService, applicationReadService: ApplicationReadService, applicationEditService: ApplicationEditService, dataReadService: DataReadService, constraintTableService: ConstraintTableService, tabService: TabService, notificationService: NotificationService)
Parameters :
Name Type Optional
router Router No
propertyValueService PropertyValueService No
applicationTemplateReadService ApplicationTemplateReadService No
applicationReadService ApplicationReadService No
applicationEditService ApplicationEditService No
dataReadService DataReadService No
constraintTableService ConstraintTableService No
tabService TabService No
notificationService NotificationService No

Methods

Public broadcastApplicationItemAttributesChanges
broadcastApplicationItemAttributesChanges(itemRows: ApplicationAttributeRow[], newAttributesSet: ApplicationAttribute[])

Broadcast

Parameters :
Name Type Optional
itemRows ApplicationAttributeRow[] No
newAttributesSet ApplicationAttribute[] No
Returns : void
Public castApplicationAttributeValue
castApplicationAttributeValue(attribute: ApplicationAttributePrototype)

Application attribute

Parameters :
Name Type Optional
attribute ApplicationAttributePrototype No
Returns : string | PropertyLight | any
Public copyAttribute
copyAttribute(attributesPair: [number, number], broadcast?: boolean)
Parameters :
Name Type Optional
attributesPair [number, number] No
broadcast boolean Yes
Returns : Promise<ApplicationAttribute>
Public copyAttributes
copyAttributes(attributesPairs: [], broadcast?: boolean)
Parameters :
Name Type Optional
attributesPairs [] No
broadcast boolean Yes
Returns : Promise<ApplicationAttribute[]>
Public createApplication
createApplication(templateOrApplicationId: number, nodeId?: number, itemId?: number, groupUid?: string, initialValues?: UpdateApplicationAttributeRequest[])

Application CRUD

Parameters :
Name Type Optional
templateOrApplicationId number No
nodeId number Yes
itemId number Yes
groupUid string Yes
initialValues UpdateApplicationAttributeRequest[] Yes
Returns : Promise<Application>
Public createNewAttribute
createNewAttribute(protoAttributeId: number | UpdateApplicationAttributeRequest, broadcast?: boolean)
Parameters :
Name Type Optional
protoAttributeId number | UpdateApplicationAttributeRequest No
broadcast boolean Yes
Returns : Promise<ApplicationAttribute>
Public createNewAttributes
createNewAttributes(protoAttributeIdsOrRequests: Array, broadcast?: boolean)

If proto attribute id is passed, an empty attribute is created. If request is passed, initialized attributed should be created.

Parameters :
Name Type Optional
protoAttributeIdsOrRequests Array<number | UpdateApplicationAttributeRequest> No
broadcast boolean Yes
Returns : Promise<ApplicationAttribute[]>
Public deleteAttributes
deleteAttributes(attributes: ApplicationAttribute[], broadcast?: boolean)
Parameters :
Name Type Optional
attributes ApplicationAttribute[] No
broadcast boolean Yes
Returns : Promise<void>
Public formApplicationItemAttributeRequest
formApplicationItemAttributeRequest(attribute: ApplicationAttributePrototype, newValue: any, unit?: MeasurementUnit, forceEdit)

Application item attribute

Parameters :
Name Type Optional Default value
attribute ApplicationAttributePrototype No
newValue any No
unit MeasurementUnit Yes
forceEdit No false
Returns : UpdateApplicationAttributeRequest | number
Public formChangeNameRequest
formChangeNameRequest(srcValue: ApplicationAttributePrototype, newName: string)

Application item attribute - Name value

Parameters :
Name Type Optional
srcValue ApplicationAttributePrototype No
newName string No
Returns : UpdateApplicationAttributeRequest | number
Public getApplicationAttributesOfApplication
getApplicationAttributesOfApplication(applicationAttributes: Pair>)
Parameters :
Name Type Optional
applicationAttributes Pair<number | Map<number, ApplicationAttribute[]>> No
Returns : Promise<ApplicationAttribute[]>
Public getApplicationItemValues
getApplicationItemValues(applicationAttributes: Pair>, propertyId: number)

Item card value propositions

Parameters :
Name Type Optional
applicationAttributes Pair<number | Map<number, ApplicationAttribute[]>> No
propertyId number No
Returns : Promise<ApplicationAttribute[]>
Public getAttributesMap
getAttributesMap(applicationAttributes: Pair>)
Parameters :
Name Type Optional
applicationAttributes Pair<number | Map<number, ApplicationAttribute[]>> No
Returns : Promise<Map<number, ApplicationAttribute[]>>
Public getTemplatesForGroupApplications
getTemplatesForGroupApplications()

Templates

Returns : Promise<ApplicationTemplate[]>
Public getWorkHandleNavigationParams
getWorkHandleNavigationParams(applicationId: number)
Parameters :
Name Type Optional
applicationId number No
Returns : Promise<Navigable>
Public getWorkHandleNodeId
getWorkHandleNodeId(applicationId: number)
Parameters :
Name Type Optional
applicationId number No
Returns : Promise<number>
Public groupApplicationAttributes
groupApplicationAttributes(attributes: ApplicationAttribute[], initialValues: ApplicationAttribute[])
Parameters :
Name Type Optional
attributes ApplicationAttribute[] No
initialValues ApplicationAttribute[] No
Returns : ApplicationAttributesInfo
Public loadAttributesInfo
loadAttributesInfo(application: Application, getCustomAttributesFn?: (applicationId?: number) => void)

Attributes

Parameters :
Name Type Optional
application Application No
getCustomAttributesFn function Yes
Returns : Promise<ApplicationAttributesInfo>
Public navigateToApplication
navigateToApplication(applicationId: number, applicationFilter: ApplicationFilter)
Parameters :
Name Type Optional
applicationId number No
applicationFilter ApplicationFilter No
Returns : void
Public navigateToApplicationFilter
navigateToApplicationFilter(applicationFilter: ApplicationFilter, queryParamsHandling?: QueryParamsHandling)
Parameters :
Name Type Optional
applicationFilter ApplicationFilter No
queryParamsHandling QueryParamsHandling Yes
Returns : void
Public openApplicationInContent
openApplicationInContent(applicationId: number, inNewTab)
Parameters :
Name Type Optional Default value
applicationId number No
inNewTab No true
Returns : Promise<void>
Public openApplicationInNewTab
openApplicationInNewTab(applicationId: number)

Navigation

Parameters :
Name Type Optional
applicationId number No
Returns : void
Static setApplicationAttributesConstraintInfo
setApplicationAttributesConstraintInfo(attributes: ApplicationAttribute[], propertyIdToIsGeneratingMap: NumberMap<boolean>)
Parameters :
Name Type Optional
attributes ApplicationAttribute[] No
propertyIdToIsGeneratingMap NumberMap<boolean> No
Returns : void
Static sortApplicationAttributes
sortApplicationAttributes(attributes: ApplicationAttribute[])

#17603

Parameters :
Name Type Optional
attributes ApplicationAttribute[] No
Returns : void
Public storeItemPropertiesToItem
storeItemPropertiesToItem(applicationId: number, itemId: number, propertyIds?: number[])

Content related stuff

Parameters :
Name Type Optional
applicationId number No
itemId number No
propertyIds number[] Yes
Returns : void
Public updateAttribute
updateAttribute(request: UpdateApplicationAttributeRequest, broadcast?: boolean)
Parameters :
Name Type Optional
request UpdateApplicationAttributeRequest No
broadcast boolean Yes
Returns : Promise<ApplicationAttribute>
Public updateAttributeMultipart
updateAttributeMultipart(request: UpdateApplicationAttributeRequest, file: File, clientWorkId?: string, updateProgressFn?: (progress?: number) => void, broadcast?: boolean)
Parameters :
Name Type Optional
request UpdateApplicationAttributeRequest No
file File No
clientWorkId string Yes
updateProgressFn function Yes
broadcast boolean Yes
Returns : Promise<ApplicationAttribute>
Public updateAttributes
updateAttributes(requests: UpdateApplicationAttributeRequest[], broadcast?: boolean)
Parameters :
Name Type Optional
requests UpdateApplicationAttributeRequest[] No
broadcast boolean Yes
Returns : Promise<ApplicationAttribute[]>
Public updateAttributesMultipart
updateAttributesMultipart(requests: UpdateApplicationAttributeRequest[], file: File, clientWorkId?: string, updateProgressFn?: (progress?: number) => void, broadcast?: boolean)
Parameters :
Name Type Optional
requests UpdateApplicationAttributeRequest[] No
file File No
clientWorkId string Yes
updateProgressFn function Yes
broadcast boolean Yes
Returns : Promise<ApplicationAttribute[]>

results matching ""

    No results matching ""