injectable
Providing system definitions.
fetchResources (id: string): Observable < literal type >
Name Type Description id string
filterVisibleTags (objectTypeId: string , tagsValue: Array < Array < any >> ): Array < Array < any >>
Name Type Description objectTypeId stringtagsValue Array<Array<any>>
Get the base document type all documents belong to
getBaseDocumentType (withLabel: boolean): ObjectType
Name Type Description withLabel boolean
Get the base folder type all folders belong to
getBaseFolderType (withLabel: boolean): ObjectType
Name Type Description withLabel boolean
Get the base object type all dms objects belong to
getBaseType (): ObjectType
Extract classifications from object type fields classification string. This string may contain more than one classification entry.
Classification is a comma separated string that may contain additional properties related to on classification entry. Example:
id:reference[system:folder], email
getClassifications (classifications: string[]): Map < string , ClassificationEntry >
Name Type Description classifications string[]
Generates an internal type for a given object type field. Adding this to a form element or object type field enables us to render forms based on object type fields in a more performant way. Otherwise we would have to evaluate the conditions for every form element on every digest cycle.
getInternalFormElementType (type: string , classifications: string[]): ObjectTypeFieldInternalType
Name Type Description type stringclassifications string[]
getLocalizedDescription (id: string): string
Name Type Description id string
getLocalizedLabel (id: string): string
Name Type Description id string
getLocalizedResource (key: string): string
Name Type Description key string
Get a particular object type
getObjectType (objectTypeId: string , withLabel: boolean): GenericObjectType | undefined
Name Type Description objectTypeId stringwithLabel boolean
getObjectTypeField (id: string): ObjectTypeField | undefined
Name Type Description id string
Get the form model of an object type.
getObjectTypeForm (objectTypeId: string , situation: string): Observable < any >
Name Type Description objectTypeId stringsituation string
Fetch a collection of form models.
getObjectTypeForms (objectTypeIDs: string[] , situation: string): Observable < Record < string , any >>
Name Type Description objectTypeIDs string[]situation string
Get the icon for an object type. This will return an SVG as a string.
getObjectTypeIcon (objectTypeId: string , fallback: string): Observable < string >
Name Type Description objectTypeId stringfallback string
Get the URI of an object type icon.
getObjectTypeIconUri (objectTypeId: string , fallback: string): string
Name Type Description objectTypeId stringfallback string
Get all object types
getObjectTypes (withLabels: boolean , situation: " search " | " create " ): GenericObjectType[]
Name Type Description withLabels booleansituation "search" | "create"
getRelationship (id: string , withLabel: boolean): Relationship | undefined
Name Type Description id stringwithLabel boolean
Get a list of classifications for a given object type including the classifications of its static secondary object types
getResolvedClassifications (objectTypeId: string): string[]
Name Type Description objectTypeId string
Get the resolved object tags
getResolvedTags (objectTypeId: string): literal type[]
Name Type Description objectTypeId string
Get the resolved object type with all fields ( including fields from related secondary types )
getResolvedType (objectTypeId: string): literal type
Name Type Description objectTypeId string
Get a particular secondary object type
getSecondaryObjectType (objectTypeId: string , withLabel: boolean): SecondaryObjectType | undefined
Name Type Description objectTypeId stringwithLabel boolean
Get all secondary object types
getSecondaryObjectTypes (withLabels: boolean , situation: " search " | " create " ): SecondaryObjectType[]
Name Type Description withLabels booleansituation "search" | "create"
Fetches the backends system definition and updates system$ Observable. Subscribe to the system$ observable instead of calling this function, otherwise you’ll trigger fetching the system definition every time.
getSystemDefinition (authData: AuthData): Observable < boolean >
Name Type Description authData AuthData
Visible tags are defined by a classification on the object type (e.g. ‘tag[tenkolibri:process,1,2,3]’).
The example will only return tags with the name ‘tenkolibri:process’ and values of either 1, 2 or 3. All other tags will be ignored.
for that tag (if values is emoty all values are allowed)
getVisibleTags (objectTypeId: string): literal type
Name Type Description objectTypeId string
Determine whether or not the given object type field is a system field
isSystemProperty (field: ObjectTypeField): boolean
Name Type Description field ObjectTypeField
setPermissions (p: ObjectTypePermissions): void
Name Type Description p ObjectTypePermissions
Create the schema from the servers schema response
setSchema (schemaResponse: SchemaResponse , localizedResource: Localization): void
Name Type Description schemaResponse SchemaResponselocalizedResource Localization
toFormElement (field: ObjectTypeField): any
Name Type Description field ObjectTypeField
updateAuthData (data: Partial < AuthData > ): any
Name Type Description data Partial<AuthData>
updateLocalizations (iso: string): Observable < any >
Name Type Description iso string
