DmsService

injectable

Service for working with dms objects: create them, delete, etc.

Methods

batchDelete

batchDelete(ids: string[]): any

Arguments

Name	Type	Description
ids	string[]

batchDeleteTag

batchDeleteTag(ids: string[], tag: string): any

Arguments

Name	Type	Description
ids	string[]
tag	string

batchGet

batchGet(ids: string[]): any

Arguments

Name	Type	Description
ids	string[]

batchUpdateTag

batchUpdateTag(ids: string[], tag: string, value: any): any

Arguments

Name	Type	Description
ids	string[]
tag	string
value	any

copyDmsObjects

Copy given objects to a different folder. The objects will be copied with their indexdata referencing the existing content of the source object.

copyDmsObjects(targetFolderId: string | null, objects: DmsObject[], options: ObjectCopyOptions): Observable<CoreApiResponse>

Arguments

Name	Type	Description
targetFolderId	string | null
objects	DmsObject[]
options	ObjectCopyOptions

coreApiResponseToDmsObject

coreApiResponseToDmsObject(res: CoreApiResponse): DmsObject

Arguments

Name	Type	Description
res	CoreApiResponse

createDmsObject

Create new dms object(s). Providing an array of files here instead of one will create a new dms object for every file. In this case indexdata will shared across all files.

createDmsObject(objectTypeId: string, indexdata: any, files: File[], label: string, silent: ): Observable<string[]>

Arguments

Name	Type	Description
objectTypeId	string
indexdata	any
files	File[]
label	string
silent	“

deleteDmsObject

Delete a dms object.

deleteDmsObject(id: string, silent: ): Observable<any>

Arguments

Name	Type	Description
id	string
silent	“

deleteDmsObjects

Delete a bunch of dms objects.

deleteDmsObjects(objects: string[] | literal type[], options: ObjectDeleteOptions): Observable<ObjectDeleteResult[]>

Arguments

Name	Type	Description
objects	string[] | literal type[]
options	ObjectDeleteOptions

deleteDmsObjectTag

Deletes a tag from a dms object.

deleteDmsObjectTag(id: string, tag: string, silent: ): Observable<any>

Arguments

Name	Type	Description
id	string
tag	string
silent	“

downloadContent

Downloads the content of dms objects.

downloadContent(objects: DmsObject[], withVersion: boolean): void

Arguments

Name	Type	Description
objects	DmsObject[]
withVersion	boolean

getContentPath

Path of dms object content file.

getContentPath(objectId: string, version: number): string

Arguments

Name	Type	Description
objectId	string
version	number

getDmsObject

Fetch a dms object.

getDmsObject(id: string, version: number, silent: , requestOptions: HttpOptions | undefined): Observable<DmsObject>

Arguments

Name	Type	Description
id	string
version	number
silent	“
requestOptions	HttpOptions | undefined

getDmsObjects

Get a bunch of dms objects.

getDmsObjects(ids: string[], silent: ): Observable<DmsObject[]>

Arguments

Name	Type	Description
ids	string[]
silent	“

getDmsObjectVersion

getDmsObjectVersion(id: string, version: number): Observable<DmsObject>

Arguments

Name	Type	Description
id	string
version	number

getDmsObjectVersions

Fetch a dms object versions.

getDmsObjectVersions(id: string): Observable<DmsObject[]>

Arguments

Name	Type	Description
id	string

getFullContentPath

Original API Path of dms object content file.

getFullContentPath(objectId: string, version: number, rendition: ): string

Arguments

Name	Type	Description
objectId	string
version	number
rendition	“

getSlideURI

getSlideURI(objectId: string, mimeType: string): string | undefined

Arguments

Name	Type	Description
objectId	string
mimeType	string

moveDmsObjects

Moves given objects to a different folder.

moveDmsObjects(targetFolderId: string | null, objects: DmsObject[], options: ObjectMoveOptions): Observable<any>

Arguments

Name	Type	Description
targetFolderId	string | null
objects	DmsObject[]
options	ObjectMoveOptions

restoreDmsObject

Restore older version of a dms object.

restoreDmsObject(id: string, version: number, silent: ): Observable<any>

Arguments

Name	Type	Description
id	string
version	number
silent	“

setDmsObjectTag

Updates a tag on a dms object.

setDmsObjectTag(id: string, tag: string, value: any, silent: ): Observable<any>

Arguments

Name	Type	Description
id	string
tag	string
value	any
silent	“

toSearchResult

Map search result from the backend to applications SearchResult object

toSearchResult(searchResponse: SearchResponse): SearchResult

Arguments

Name	Type	Description
searchResponse	SearchResponse

updateDmsObject

Update indexdata of a dms object.

updateDmsObject(id: string, data: any, silent: ): Observable<DmsObject>

Arguments

Name	Type	Description
id	string
data	any
silent	“

updateDmsObjects

Updates given objects.

updateDmsObjects(objects: literal type[], silent: ): Observable<DmsObject[]>

Arguments

Name	Type	Description
objects	literal type[]
silent	“

updateDmsObjectsTag

Updates a tag on a dms object.

updateDmsObjectsTag(ids: string[], tag: string, value: any, silent: ): Observable<any>

Arguments

Name	Type	Description
ids	string[]
tag	string
value	any
silent	“

uploadContent

Upload (add/replace) content to a dms object.

uploadContent(objectId: string, file: File, label: string, silent: boolean): Observable<any>

Arguments

Name	Type	Description
objectId	string
file	File
label	string
silent	boolean