ObjectConfigService

injectable

Service managing the configuarions for object types. Configuration means that you can pick certain fields of an object type and assign them to a config object.

Methods

getDefaultConfig

getDefaultConfig(objectTypeID: string): ObjectConfig

Arguments

Name	Type	Description
objectTypeID	`string`

getObjectConfig

Get object config for an object type. define separated areas to store/receive those configs. This way components/apps can store different object configs than the ones used accross the whole client application.

getObjectConfig(type: VirtualObjectType, bucket: string): ObjectConfig

Arguments

Name	Type	Description
type	`VirtualObjectType`
bucket	`string`

getObjectConfigs$

getObjectConfigs$(bucket: string, includeDefaults: boolean): Observable<ObjectConfigRecord>

Arguments

Name	Type	Description
bucket	`string`
includeDefaults	`boolean`

getRegisteredDefault

getRegisteredDefault(objectTypeId: string, bucket: string): ObjectConfig | undefined

Arguments

Name	Type	Description
objectTypeId	`string`
bucket	`string`

getResolvedObjectConfig

getResolvedObjectConfig(data: Record<string | any>, type: VirtualObjectType, bucket: string, includeDefaults: boolean): ResolvedObjectConfig

Arguments

Name	Type	Description
data	`Record<string \| any>`
type	`VirtualObjectType`
bucket	`string`
includeDefaults	`boolean`

init

init(): Observable<any>

registerDefaults

Register default object configs. Apps can pre-define how their objects should be rendered. separate the configs from other apps. If not provided configs will be saved for the global scope

registerDefaults(configs: ObjectConfigRecord, bucket: string): void

Arguments

Name	Type	Description
configs	`ObjectConfigRecord`
bucket	`string`

saveObjectConfig

saveObjectConfig(type: VirtualObjectType, config: ObjectConfig, bucket: string): Observable<any>

Arguments

Name	Type	Description
type	`VirtualObjectType`
config	`ObjectConfig`
bucket	`string`

saveObjectConfigs

saveObjectConfigs(configs: Record<string | ObjectConfig | undefined>, bucket: string): Observable<any>

Arguments

Name	Type	Description
configs	`Record<string \| ObjectConfig \| undefined>`
bucket	`string`

unregisterDefaults

unregisterDefaults(configs: ObjectConfigRecord, bucket: string): void

Arguments

Name	Type	Description
configs	`ObjectConfigRecord`
bucket	`string`