Class ElementStore

constructor

• new ElementStore(main): ElementStore

• Parameters

  • main: MainStore

  Returns ElementStore

elementSchemas

elementTemplates

elementTemplatesV1

elements

elementsTypeDataV1

main

privileges

socketEventIds

syncProgress

workRecordActions

Static listeners

addPrivilegesData

• addPrivilegesData(type, organization, privileges): void

• Parameters

  • type: string

  • organization: string

  • privileges: ElementPrivileges

  Returns void

addTemplateV1Data

• addTemplateV1Data(type, organization, template): void

• Parameters

  • type: string

  • organization: string

  • template: ElementTemplateV1

  Returns void

addTypeData

• addTypeData(type, typeData): void

• Parameters

  • type: string

  • typeData: AttributeDefinitions

  Returns void

addWorkRecordActions

• addWorkRecordActions(type, actions): void

• Parameters

  • type: string

  • actions: string[]

  Returns void

applyPatchToElement

• applyPatchToElement(element, operations): void

• Parameters

  • element: Element

  • operations: Operation[]

  Returns void

batchMetadata

• batchMetadata(elements, attributes): Promise<undefined | BatchMetadata<string>>

• Parameters

  • elements: Element[]

  • attributes: string[]

  Returns Promise<undefined | BatchMetadata<string>>

batchUpdateElements

• batchUpdateElements(elements): Promise<ApiOkResponse<void>>

• Parameters

  • elements: Element[]

  Returns Promise<ApiOkResponse<void>>

computeElementDataHash

• computeElementDataHash(data): string

• Parameters

  • data: ElementData

  Returns string

create

• create(type, data, organization, options?): Promise<undefined | Element>

• Parameters

  • type: string

  • data: ElementAttributeData

  • organization: string

  • Optional options: {
        parent?: Element;
        shouldLoad?: boolean;
    }

    • Optional parent?: Element

    • Optional shouldLoad?: boolean

  Returns Promise<undefined | Element>

createBatchElements

• createBatchElements(elements): Promise<BatchCreateResponse>

• Parameters

  • elements: (__type<GConstructor<Element>> & Element)[]

  Returns Promise<BatchCreateResponse>

createTicket

• createTicket(data, organization): Promise<undefined | Element>

• Parameters

  • data: ElementAttributeData

  • organization: string

  Returns Promise<undefined | Element>

dehydrateElement

• dehydrateElement(element): undefined | DehydratedElement

• Parameters

  • element: Element

  Returns undefined | DehydratedElement

get

• get<T>(hash, type, queryParams?): Promise<null | T>

• Type Parameters

  • T extends Element

  Parameters

  • hash: string

  • type: string

  • Optional queryParams: ElementGetQueryParams

  Returns Promise<null | T>

getAttributeType

• getAttributeType(type, attributeKey): undefined | AttributeType

• Parameters

  • type: string

  • attributeKey: string

  Returns undefined | AttributeType

getElementFromHash

• getElementFromHash(hash): Promise<Element>

• Parameters

  • hash: string

  Returns Promise<Element>

getElementFromQR

• getElementFromQR(url): Promise<Element>

• Parameters

  • url: string

  Returns Promise<Element>

getElementPrivileges

• getElementPrivileges(type, organization): Promise<undefined | ElementPrivileges>

• Parameters

  • type: string

  • organization: string

  Returns Promise<undefined | ElementPrivileges>

getElementSchema

• getElementSchema(type): Promise<undefined | ElementSchema>

• Parameters

  • type: string

  Returns Promise<undefined | ElementSchema>

getElementTemplateV1

• getElementTemplateV1(type, organization): Promise<undefined | ElementTemplateV1>

• Parameters

  • type: string

  • organization: string

  Returns Promise<undefined | ElementTemplateV1>

getElementTypeData

• getElementTypeData(type): Promise<undefined | AttributeDefinitions>

• Parameters

  • type: string

  Returns Promise<undefined | AttributeDefinitions>

getFilesWithUniqNames

• getFilesWithUniqNames(attributeValue): {
      conflictHashes: string[];
      localFiles: LocalFile<PlatformFile>[];
  }

• Parameters

  • attributeValue: AttributeFileData

  Returns {
      conflictHashes: string[];
      localFiles: LocalFile<PlatformFile>[];
  }

  • conflictHashes: string[]

  • localFiles: LocalFile<PlatformFile>[]

getLocalFiles

• getLocalFiles(data): PreparedFiles<PlatformFile>[]

• Parameters

  • data: ElementAttributeData

  Returns PreparedFiles<PlatformFile>[]

getModelForElementType

• getModelForElementType(type): typeof Element

• Parameters

  • type: undefined | string

  Returns typeof Element

getTemplate

• getTemplate(type, templateId?): Promise<undefined | Template>

• Parameters

  • type: string

  • templateId: string = DEFAULT_TEMPLATE_ID

  Returns Promise<undefined | Template>

instantiateElement

• instantiateElement(hash, data?, shouldLoad?, paramOptions?): undefined | Element

• Parameters

  • hash: string

  • Optional data: ElementData

  • shouldLoad: boolean = false

  • paramOptions: Partial<InstantiateElementOptions> = {}

  Returns undefined | Element

instantiateElementValue

• instantiateElementValue(value): Element[]

• Parameters

  • value: AttributeValue

  Returns Element[]

instantiateLocalElement

• instantiateLocalElement(type, organization, data?, parent?): __type<GConstructor<Element>> & Element

• Parameters

  • type: string

  • organization: string

  • Optional data: Omit<ElementData, "organization" | "hash" | "_type">

  • Optional parent: Element

  Returns __type<GConstructor<Element>> & Element

loadAndPersistBatchElements

• loadAndPersistBatchElements(hashes, projection?, paramOptions?): Promise<Element[]>

• Parameters

  • hashes: string[]

  • projection: string[] = []

  • Optional paramOptions: {
        setToMemory?: boolean;
    }

    • Optional setToMemory?: boolean

  Returns Promise<Element[]>

loadElementTypes

• loadElementTypes(right?): Promise<string[]>

• Parameters

  • Optional right: "update" | "read" | "create"

  Returns Promise<string[]>

onConnectionChange

• onConnectionChange(): Promise<void>

• Returns Promise<void>

onElementsChange

• onElementsChange(change): Promise<void>

• Parameters

  • change: IObjectDidChange

  Returns Promise<void>

prepareOperations

• prepareOperations(type, data, oldData?): Operation[]

• Parameters

  • type: string

  • data: ElementAttributeData

  • oldData: ElementAttributeData = {}

  Returns Operation[]

rehydrateElement

• rehydrateElement(hash): Promise<undefined | Element>

• Parameters

  • hash: string

  Returns Promise<undefined | Element>

rehydrateElements

• rehydrateElements(): Promise<void>

• Returns Promise<void>

removeElement

• removeElement(hash): undefined | Promise<void>

• Parameters

  • hash: string

  Returns undefined | Promise<void>

saveElementToStorage

• saveElementToStorage(originalElement): undefined | Promise<void>

• Parameters

  • originalElement: Element

  Returns undefined | Promise<void>

search

• search(query, options?): Promise<undefined | GetElementSearch>

• Parameters

  • query: string

  • Optional options: ElementSearchOptions

  Returns Promise<undefined | GetElementSearch>

setTemplate

• setTemplate(type, template, templateId?): void

• Parameters

  • type: string

  • template: Template

  • templateId: string = DEFAULT_TEMPLATE_ID

  Returns void

subscribeToElementUpdates

• subscribeToElementUpdates(element): undefined | (() => void)

• Parameters

  • element: Element

  Returns undefined | (() => void)

syncLocalElements

• syncLocalElements(): Promise<void>

• Returns Promise<void>

uploadFiles

• uploadFiles(type, hash, files, workRecordHash?): Promise<undefined | ApiOkResponse<FileBatchResponse>>

• Parameters

  • type: string

  • hash: string

  • files: PreparedFiles<PlatformFile>[]

  • Optional workRecordHash: string

  Returns Promise<undefined | ApiOkResponse<FileBatchResponse>>

Static areAllConditionsMet

• areAllConditionsMet(conditions, element): boolean

• Parameters

  • conditions: undefined | {
        items: ViewConfigCondition[];
        logicalOperator: "every" | "some";
    }

  • element: Element

  Returns boolean

Static getSolvedAttrVisibility

• getSolvedAttrVisibility(attributeDefinition, element): boolean

• Parameters

  • attributeDefinition: AttributeDefinition | {
        visibility: ConditionalViewConfig;
    }

  • element: Element

  Returns boolean

Static getSolvedGroupCollapse

• getSolvedGroupCollapse(group, element): boolean

• Parameters

  • group: AttributeGroup

  • element: Element

  Returns boolean

Static getSolvedGroupVisibility

• getSolvedGroupVisibility(group, element): boolean

• Parameters

  • group: AttributeGroup

  • element: Element

  Returns boolean