internals | @dvelop-sdk

Index

Functions Repository

Functions Http

DmsObject Functions

_createDmsObjectDefaultStoreFileFunction

_createDmsObjectDefaultStoreFileFunction(context: DvelopContext, params: CreateDmsObjectParams): Promise<{ setAs: "contentUri" | "contentLocationUri"; uri: string }>

- Defined in packages/dms/src/dms-objects/create-dms-object/create-dms-object.ts:67
Default store-file-function provided to the createDmsObject-function. See Advanced Topics for more information.

internal
Parameters
- context: DvelopContext
- params: CreateDmsObjectParams
Returns Promise<{ setAs: "contentUri" | "contentLocationUri"; uri: string }>

_createDmsObjectDefaultTransformFunction

_createDmsObjectDefaultTransformFunction(response: DvelopHttpResponse<any>, _: DvelopContext, params: CreateDmsObjectParams): GetDmsObjectParams

- Defined in packages/dms/src/dms-objects/create-dms-object/create-dms-object.ts:46
Default transform-function provided to the createDmsObject-function. See Advanced Topics for more information.

internal
Parameters
- response: DvelopHttpResponse<any>
- _: DvelopContext
- params: CreateDmsObjectParams
Returns GetDmsObjectParams

_createDmsObjectNoteDefaultTransformFunction

_createDmsObjectNoteDefaultTransformFunction(_: DvelopHttpResponse<any>, __: DvelopContext, ___: CreateDmsObjectNoteParams): void

- Defined in packages/dms/src/dms-objects/create-dms-object-note/create-dms-object-note.ts:24
Default transform-function provided to the {@link createDmsObjectNote}-function. See Advanced Topics for more information.

internal
Parameters
- _: DvelopHttpResponse<any>
- __: DvelopContext
- ___: CreateDmsObjectNoteParams
Returns void

_createDmsObjectNoteFactory

_createDmsObjectNoteFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: CreateDmsObjectNoteParams) => T): (context: DvelopContext, params: CreateDmsObjectNoteParams) => Promise<T>

- Defined in packages/dms/src/dms-objects/create-dms-object-note/create-dms-object-note.ts:31
Factory for the {@link createDmsObjectNote}-function. See Advanced Topics for more information.

Type parameters
- T
  
  Return type of the {@link createDmsObjectNote}-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: CreateDmsObjectNoteParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: CreateDmsObjectNoteParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: CreateDmsObjectNoteParams
      Returns T
Returns (context: DvelopContext, params: CreateDmsObjectNoteParams) => Promise<T>
- - (context: DvelopContext, params: CreateDmsObjectNoteParams): Promise<T>
  - Factory for the {@link createDmsObjectNote}-function. See Advanced Topics for more information.
    
    category
    DmsObject
    
    Parameters
    - context: DvelopContext
    - params: CreateDmsObjectNoteParams
    Returns Promise<T>

_deleteCurrentDmsObjectVersionDefaultTransformFunction

_deleteCurrentDmsObjectVersionDefaultTransformFunction(response: DvelopHttpResponse<any>, _: DvelopContext, __: DeleteCurrentDmsObjectVersionParams): boolean

- Defined in packages/dms/src/dms-objects/delete-current-dms-object-version/delete-current-dms-object-version.ts:25
Default transform-function provided to the deleteCurrentDmsObjectVersion-function. See Advanced Topics for more information.

internal
Parameters
- response: DvelopHttpResponse<any>
- _: DvelopContext
- __: DeleteCurrentDmsObjectVersionParams
Returns boolean

_deleteCurrentDmsObjectVersionFactory

_deleteCurrentDmsObjectVersionFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: DeleteCurrentDmsObjectVersionParams) => T): (context: DvelopContext, params: DeleteCurrentDmsObjectVersionParams) => Promise<T>

- Defined in packages/dms/src/dms-objects/delete-current-dms-object-version/delete-current-dms-object-version.ts:39
Factory for the deleteCurrentDmsObjectVersion-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the deleteCurrentDmsObjectVersion-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: DeleteCurrentDmsObjectVersionParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: DeleteCurrentDmsObjectVersionParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: DeleteCurrentDmsObjectVersionParams
      Returns T
Returns (context: DvelopContext, params: DeleteCurrentDmsObjectVersionParams) => Promise<T>
- - (context: DvelopContext, params: DeleteCurrentDmsObjectVersionParams): Promise<T>
  - Factory for the deleteCurrentDmsObjectVersion-function. See Advanced Topics for more information.
    
    internal
    category
    DmsObject
    
    Parameters
    - context: DvelopContext
    - params: DeleteCurrentDmsObjectVersionParams
    Returns Promise<T>

_getDmsObjectDefaultTransformFunction

_getDmsObjectDefaultTransformFunction(response: DvelopHttpResponse<any>, context: DvelopContext, params: GetDmsObjectParams): Promise<DmsObject>

- Defined in packages/dms/src/dms-objects/get-dms-object/get-dms-object.ts:129
Factory for the default-transform-function for the getDmsObject-function. See Advanced Topics for more information.

internal
Parameters
- response: DvelopHttpResponse<any>
- context: DvelopContext
- params: GetDmsObjectParams
Returns Promise<DmsObject>

_getDmsObjectDefaultTransformFunctionFactory

_getDmsObjectDefaultTransformFunctionFactory(getDmsObjectMainFileFunction: (context: DvelopContext, params: GetDmsObjectParams) => Promise<ArrayBuffer>, getDmsObjectPdfFileFunction: (context: DvelopContext, params: GetDmsObjectParams) => Promise<ArrayBuffer>, searchDmsObjects: (context: DvelopContext, params: SearchDmsObjectsParams) => Promise<SearchDmsObjectsResultPage>): (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetDmsObjectParams) => DmsObject

- Defined in packages/dms/src/dms-objects/get-dms-object/get-dms-object.ts:58
Factory for the default-transform-function for the getDmsObject-function. See Advanced Topics for more information.

internal
Parameters
- getDmsObjectMainFileFunction: (context: DvelopContext, params: GetDmsObjectParams) => Promise<ArrayBuffer>
  - - (context: DvelopContext, params: GetDmsObjectParams): Promise<ArrayBuffer>
    - Parameters
      - context: DvelopContext
      - params: GetDmsObjectParams
      Returns Promise<ArrayBuffer>
- getDmsObjectPdfFileFunction: (context: DvelopContext, params: GetDmsObjectParams) => Promise<ArrayBuffer>
  - - (context: DvelopContext, params: GetDmsObjectParams): Promise<ArrayBuffer>
    - Parameters
      - context: DvelopContext
      - params: GetDmsObjectParams
      Returns Promise<ArrayBuffer>
- searchDmsObjects: (context: DvelopContext, params: SearchDmsObjectsParams) => Promise<SearchDmsObjectsResultPage>
  - - (context: DvelopContext, params: SearchDmsObjectsParams): Promise<SearchDmsObjectsResultPage>
    - Parameters
      - context: DvelopContext
      - params: SearchDmsObjectsParams
      Returns Promise<SearchDmsObjectsResultPage>
Returns (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetDmsObjectParams) => DmsObject
- - (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetDmsObjectParams): DmsObject
  - Parameters
    - response: DvelopHttpResponse<any>
    - context: DvelopContext
    - params: GetDmsObjectParams
    Returns DmsObject

_getDmsObjectFactory

_getDmsObjectFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetDmsObjectParams) => T): (context: DvelopContext, params: GetDmsObjectParams) => Promise<T>

- Defined in packages/dms/src/dms-objects/get-dms-object/get-dms-object.ts:103
Factory for getDmsObject-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the getDmsObject-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetDmsObjectParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetDmsObjectParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: GetDmsObjectParams
      Returns T
Returns (context: DvelopContext, params: GetDmsObjectParams) => Promise<T>
- - (context: DvelopContext, params: GetDmsObjectParams): Promise<T>
  - Factory for getDmsObject-function. See Advanced Topics for more information.
    
    internal
    category
    DmsObject
    
    Parameters
    - context: DvelopContext
    - params: GetDmsObjectParams
    Returns Promise<T>

_getDmsObjectMainFileFactory

_getDmsObjectMainFileFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<ArrayBuffer>, context: DvelopContext, params: GetDmsObjectParams) => T): (context: DvelopContext, params: GetDmsObjectParams) => Promise<T>

- Defined in packages/dms/src/dms-objects/get-dms-object-file/get-dms-object-file.ts:50
Factory for getDmsObjectMainFile-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the getRepositories-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<ArrayBuffer>, context: DvelopContext, params: GetDmsObjectParams) => T
  - - (response: DvelopHttpResponse<ArrayBuffer>, context: DvelopContext, params: GetDmsObjectParams): T
    - Parameters
      - response: DvelopHttpResponse<ArrayBuffer>
      - context: DvelopContext
      - params: GetDmsObjectParams
      Returns T
Returns (context: DvelopContext, params: GetDmsObjectParams) => Promise<T>
- - (context: DvelopContext, params: GetDmsObjectParams): Promise<T>
  - Factory for getDmsObjectMainFile-function. See Advanced Topics for more information.
    
    internal
    category
    DmsObject
    
    Parameters
    - context: DvelopContext
    - params: GetDmsObjectParams
    Returns Promise<T>

_getDmsObjectNotesDefaultTransformFunction

_getDmsObjectNotesDefaultTransformFunction(response: DvelopHttpResponse<any>, _: DvelopContext, __: GetDmsObjectNotesParams): DmsObjectNote[]

- Defined in packages/dms/src/dms-objects/get-dms-object-notes/get-dms-object-notes.ts:38
Default transform-function provided to the getDmsObjectNotes-function. See Advanced Topics for more information.

internal
Parameters
- response: DvelopHttpResponse<any>
- _: DvelopContext
- __: GetDmsObjectNotesParams
Returns DmsObjectNote[]

_getDmsObjectNotesFactory

_getDmsObjectNotesFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetDmsObjectNotesParams) => T): (context: DvelopContext, params: GetDmsObjectNotesParams) => Promise<T>

- Defined in packages/dms/src/dms-objects/get-dms-object-notes/get-dms-object-notes.ts:58
Factory for the getDmsObjectNotes-function. See Advanced Topics for more information.

Type parameters
- T
  
  Return type of the getDmsObjectNotes-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetDmsObjectNotesParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetDmsObjectNotesParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: GetDmsObjectNotesParams
      Returns T
Returns (context: DvelopContext, params: GetDmsObjectNotesParams) => Promise<T>
- - (context: DvelopContext, params: GetDmsObjectNotesParams): Promise<T>
  - Factory for the getDmsObjectNotes-function. See Advanced Topics for more information.
    
    category
    DmsObject
    
    Parameters
    - context: DvelopContext
    - params: GetDmsObjectNotesParams
    Returns Promise<T>

_getDmsObjectPdfFileFactory

_getDmsObjectPdfFileFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<ArrayBuffer>, context: DvelopContext, params: GetDmsObjectParams) => T): (context: DvelopContext, params: GetDmsObjectParams) => Promise<T>

- Defined in packages/dms/src/dms-objects/get-dms-object-file/get-dms-object-file.ts:66
Factory for getDmsObjectPdfFile-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the getRepositories-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<ArrayBuffer>, context: DvelopContext, params: GetDmsObjectParams) => T
  - - (response: DvelopHttpResponse<ArrayBuffer>, context: DvelopContext, params: GetDmsObjectParams): T
    - Parameters
      - response: DvelopHttpResponse<ArrayBuffer>
      - context: DvelopContext
      - params: GetDmsObjectParams
      Returns T
Returns (context: DvelopContext, params: GetDmsObjectParams) => Promise<T>
- - (context: DvelopContext, params: GetDmsObjectParams): Promise<T>
  - Factory for getDmsObjectPdfFile-function. See Advanced Topics for more information.
    
    internal
    category
    DmsObject
    
    Parameters
    - context: DvelopContext
    - params: GetDmsObjectParams
    Returns Promise<T>

_linkDmsObjectsFactory

_linkDmsObjectsFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: LinkDmsObjectsParams) => T): (context: DvelopContext, params: LinkDmsObjectsParams) => Promise<T>

- Defined in packages/dms/src/dms-objects/link-dms-objects/link-dms-objects.ts:25
Factory for linkDmsObjects-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the linkDmsObjects-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: LinkDmsObjectsParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: LinkDmsObjectsParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: LinkDmsObjectsParams
      Returns T
Returns (context: DvelopContext, params: LinkDmsObjectsParams) => Promise<T>
- - (context: DvelopContext, params: LinkDmsObjectsParams): Promise<T>
  - Factory for linkDmsObjects-function. See Advanced Topics for more information.
    
    internal
    category
    DmsObject
    
    Parameters
    - context: DvelopContext
    - params: LinkDmsObjectsParams
    Returns Promise<T>

_releaseAndUpdateDmsObjectFactory

_releaseAndUpdateDmsObjectFactory(getDmsObjectsFunction: (context: DvelopContext, params: GetDmsObjectParams) => Promise<DmsObject>, updateDmsObjectStatusFunction: (context: DvelopContext, params: UpdateDmsObjectStatusParams) => Promise<void>, updateDmsObjectFunction: (context: DvelopContext, params: UpdateDmsObjectParams) => Promise<void>): (context: DvelopContext, params: UpdateDmsObjectParams) => Promise<void>

- Defined in packages/dms/src/dms-objects/release-and-update-dms-objects/release-and-update-dms-objects.ts:22
Factory for the releaseAndUpdateDmsObject-function. This is a wrapper around getDmsObject, updateDmsObjectStatus and updateDmsObject combined.

internal
Parameters
- getDmsObjectsFunction: (context: DvelopContext, params: GetDmsObjectParams) => Promise<DmsObject>
  - - (context: DvelopContext, params: GetDmsObjectParams): Promise<DmsObject>
    - Parameters
      - context: DvelopContext
      - params: GetDmsObjectParams
      Returns Promise<DmsObject>
- updateDmsObjectStatusFunction: (context: DvelopContext, params: UpdateDmsObjectStatusParams) => Promise<void>
  - - (context: DvelopContext, params: UpdateDmsObjectStatusParams): Promise<void>
    - Parameters
      - context: DvelopContext
      - params: UpdateDmsObjectStatusParams
      Returns Promise<void>
- updateDmsObjectFunction: (context: DvelopContext, params: UpdateDmsObjectParams) => Promise<void>
  - - (context: DvelopContext, params: UpdateDmsObjectParams): Promise<void>
    - Parameters
      - context: DvelopContext
      - params: UpdateDmsObjectParams
      Returns Promise<void>
Returns (context: DvelopContext, params: UpdateDmsObjectParams) => Promise<void>
- - (context: DvelopContext, params: UpdateDmsObjectParams): Promise<void>
  - Factory for the releaseAndUpdateDmsObject-function. This is a wrapper around getDmsObject, updateDmsObjectStatus and updateDmsObject combined.
    
    internal
    category
    DmsObject
    
    Parameters
    - context: DvelopContext
    - params: UpdateDmsObjectParams
    Returns Promise<void>

_searchDmsObjectsDefaultTransformFunctionFactory

_searchDmsObjectsDefaultTransformFunctionFactory(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>): (response: HttpResponse, context: DvelopContext, params: SearchDmsObjectsParams) => SearchDmsObjectsResultPage

- Defined in packages/dms/src/dms-objects/search-dms-objects/search-dms-objects.ts:108
Factory for the default-transform-function for the searchDmsObjects-function. See Advanced Topics for more information.

internal
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
Returns (response: HttpResponse, context: DvelopContext, params: SearchDmsObjectsParams) => SearchDmsObjectsResultPage
- - (response: HttpResponse, context: DvelopContext, params: SearchDmsObjectsParams): SearchDmsObjectsResultPage
  - Factory for the default-transform-function for the searchDmsObjects-function. See Advanced Topics for more information.
    
    internal
    category
    DmsObject
    
    Parameters
    - response: HttpResponse
    - context: DvelopContext
    - params: SearchDmsObjectsParams
    Returns SearchDmsObjectsResultPage

_storeFileTemporarilyDefaultTransformFunction

_storeFileTemporarilyDefaultTransformFunction(response: DvelopHttpResponse<any>, _: DvelopContext, __: StoreFileTemporarilyParams): string

- Defined in packages/dms/src/dms-objects/store-file-temporarily/store-file-temporarily.ts:20
Default transform-function provided to the storeFileTemporarily-function. See Advanced Topics for more information.

internal
Parameters
- response: DvelopHttpResponse<any>
- _: DvelopContext
- __: StoreFileTemporarilyParams
Returns string

_storeFileTemporarilyFactory

_storeFileTemporarilyFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: StoreFileTemporarilyParams) => T): (context: DvelopContext, params: StoreFileTemporarilyParams) => Promise<T>

- Defined in packages/dms/src/dms-objects/store-file-temporarily/store-file-temporarily.ts:30
Factory for the {@link storeFileFunction}-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the {@link storeFileFunction}-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: StoreFileTemporarilyParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: StoreFileTemporarilyParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: StoreFileTemporarilyParams
      Returns T
Returns (context: DvelopContext, params: StoreFileTemporarilyParams) => Promise<T>
- - (context: DvelopContext, params: StoreFileTemporarilyParams): Promise<T>
  - Factory for the {@link storeFileFunction}-function. See Advanced Topics for more information.
    
    internal
    category
    DmsObject
    
    Parameters
    - context: DvelopContext
    - params: StoreFileTemporarilyParams
    Returns Promise<T>

_unlinkDmsObjectsFactory

_unlinkDmsObjectsFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: UnlinkDmsObjectsParams) => T): (context: DvelopContext, params: UnlinkDmsObjectsParams) => Promise<T>

- Defined in packages/dms/src/dms-objects/unlink-dms-objects/unlink-dms-objects.ts:25
Factory for unlinkDmsObjects-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the unlinkDmsObjects-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: UnlinkDmsObjectsParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: UnlinkDmsObjectsParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: UnlinkDmsObjectsParams
      Returns T
Returns (context: DvelopContext, params: UnlinkDmsObjectsParams) => Promise<T>
- - (context: DvelopContext, params: UnlinkDmsObjectsParams): Promise<T>
  - Factory for unlinkDmsObjects-function. See Advanced Topics for more information.
    
    internal
    category
    DmsObject
    
    Parameters
    - context: DvelopContext
    - params: UnlinkDmsObjectsParams
    Returns Promise<T>

_updateDmsObjectDefaultTransformFunction

_updateDmsObjectDefaultTransformFunction(_: DvelopHttpResponse<any>, __: DvelopContext, ___: UpdateDmsObjectParams): void

- Defined in packages/dms/src/dms-objects/update-dms-object/update-dms-object.ts:46
Default transform-function provided to the updateDmsObject-function. See Advanced Topics for more information.

internal
Parameters
- _: DvelopHttpResponse<any>
- __: DvelopContext
- ___: UpdateDmsObjectParams
Returns void

_updateDmsObjectFactory

_updateDmsObjectFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: UpdateDmsObjectParams) => T, storeFileFunction: (context: DvelopContext, params: UpdateDmsObjectParams) => Promise<{ setAs: "contentUri" | "contentLocationUri"; uri: string }>): (context: DvelopContext, params: UpdateDmsObjectParams) => Promise<T>

- Defined in packages/dms/src/dms-objects/update-dms-object/update-dms-object.ts:67
Factory for the updateDmsObject-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the updateDmsObject-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: UpdateDmsObjectParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: UpdateDmsObjectParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: UpdateDmsObjectParams
      Returns T
- storeFileFunction: (context: DvelopContext, params: UpdateDmsObjectParams) => Promise<{ setAs: "contentUri" | "contentLocationUri"; uri: string }>
  - - (context: DvelopContext, params: UpdateDmsObjectParams): Promise<{ setAs: "contentUri" | "contentLocationUri"; uri: string }>
    - Parameters
      - context: DvelopContext
      - params: UpdateDmsObjectParams
      Returns Promise<{ setAs: "contentUri" | "contentLocationUri"; uri: string }>
Returns (context: DvelopContext, params: UpdateDmsObjectParams) => Promise<T>
- - (context: DvelopContext, params: UpdateDmsObjectParams): Promise<T>
  - Factory for the updateDmsObject-function. See Advanced Topics for more information.
    
    internal
    category
    DmsObject
    
    Parameters
    - context: DvelopContext
    - params: UpdateDmsObjectParams
    Returns Promise<T>

_updateDmsObjectStatusDefaultTransformFunction

_updateDmsObjectStatusDefaultTransformFunction(_: DvelopHttpResponse<any>, __: DvelopContext, ___: UpdateDmsObjectStatusParams): void

- Defined in packages/dms/src/dms-objects/update-dms-object-status/update-dms-object-status.ts:28
Default transform-function provided to the updateDmsObjectStatus-function. See Advanced Topics for more information.

internal
Parameters
- _: DvelopHttpResponse<any>
- __: DvelopContext
- ___: UpdateDmsObjectStatusParams
Returns void

_updateDmsObjectStatusFactory

_updateDmsObjectStatusFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: UpdateDmsObjectStatusParams) => T): (context: DvelopContext, params: UpdateDmsObjectStatusParams) => Promise<T>

- Defined in packages/dms/src/dms-objects/update-dms-object-status/update-dms-object-status.ts:36
Factory for the updateDmsObject-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the updateDmsObjectStatus-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: UpdateDmsObjectStatusParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: UpdateDmsObjectStatusParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: UpdateDmsObjectStatusParams
      Returns T
Returns (context: DvelopContext, params: UpdateDmsObjectStatusParams) => Promise<T>
- - (context: DvelopContext, params: UpdateDmsObjectStatusParams): Promise<T>
  - Factory for the updateDmsObject-function. See Advanced Topics for more information.
    
    internal
    category
    DmsObject
    
    Parameters
    - context: DvelopContext
    - params: UpdateDmsObjectStatusParams
    Returns Promise<T>

Repository Functions

_getRepositoriesDefaultTransformFunction

_getRepositoriesDefaultTransformFunction(response: DvelopHttpResponse<any>, _: DvelopContext): Repository[]

- Defined in packages/dms/src/repositories/get-repositories/get-repositories.ts:10
Default transform-function provided to the getRepositories-function. See Advanced Topics for more information.

internal
Parameters
- response: DvelopHttpResponse<any>
- _: DvelopContext
Returns Repository[]

_getRepositoriesFactory

_getRepositoriesFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext) => T): (context: DvelopContext) => Promise<T>

- Defined in packages/dms/src/repositories/get-repositories/get-repositories.ts:26
Factory for getRepositories-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the getRepositories-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      Returns T
Returns (context: DvelopContext) => Promise<T>
- - (context: DvelopContext): Promise<T>
  - Factory for getRepositories-function. See Advanced Topics for more information.
    
    internal
    category
    Repository
    
    Parameters
    - context: DvelopContext
    Returns Promise<T>

_getRepositoryDefaultTransformFunction

_getRepositoryDefaultTransformFunction(response: DvelopHttpResponse<any>, _: DvelopContext, __: GetRepositoryParams): Repository

- Defined in packages/dms/src/repositories/get-repository/get-repository.ts:31
Default transform-function provided to the getRepository-function. See Advanced Topics for more information.

internal
Parameters
- response: DvelopHttpResponse<any>
- _: DvelopContext
- __: GetRepositoryParams
Returns Repository

_getRepositoryFactory

_getRepositoryFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetRepositoryParams) => T): (context: DvelopContext, params: GetRepositoryParams) => Promise<T>

- Defined in packages/dms/src/repositories/get-repository/get-repository.ts:46
Factory for the getRepository-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the getRepository-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetRepositoryParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetRepositoryParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: GetRepositoryParams
      Returns T
Returns (context: DvelopContext, params: GetRepositoryParams) => Promise<T>
- - (context: DvelopContext, params: GetRepositoryParams): Promise<T>
  - Factory for the getRepository-function. See Advanced Topics for more information.
    
    internal
    category
    Repository
    
    Parameters
    - context: DvelopContext
    - params: GetRepositoryParams
    Returns Promise<T>

Http Functions

_defaultHttpRequestFunction

_defaultHttpRequestFunction(context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse>

- Defined in packages/dms/src/utils/http.ts:61
Default httpRequestFunction used in dms-package. See Advanced Topics for more information.

internal
Parameters
- context: DvelopContext
- config: DvelopHttpRequestConfig<any>
Returns Promise<DvelopHttpResponse>

_defaultHttpRequestFunctionFactory

_defaultHttpRequestFunctionFactory(httpClient: DvelopHttpClient): (context: DvelopContext, config: DvelopHttpRequestConfig) => Promise<DvelopHttpResponse>

- Defined in packages/dms/src/utils/http.ts:23
Factory used to create the default httpRequestFunction. See Advanced Topics for more information.

internal
Parameters
- httpClient: DvelopHttpClient
Returns (context: DvelopContext, config: DvelopHttpRequestConfig) => Promise<DvelopHttpResponse>
- - (context: DvelopContext, config: DvelopHttpRequestConfig): Promise<DvelopHttpResponse>
  - Factory used to create the default httpRequestFunction. See Advanced Topics for more information.
    
    internal
    category
    Http
    
    Parameters
    - context: DvelopContext
    - config: DvelopHttpRequestConfig
    Returns Promise<DvelopHttpResponse>

Index

Functions DmsObject

Functions Repository

Functions Http

DmsObject Functions

_createDmsObjectDefaultStoreFileFunction

Parameters

context: DvelopContext

params: CreateDmsObjectParams

Returns Promise<{ setAs: "contentUri" | "contentLocationUri"; uri: string }>

_createDmsObjectDefaultTransformFunction

Parameters

response: DvelopHttpResponse<any>

_: DvelopContext

params: CreateDmsObjectParams

Returns GetDmsObjectParams

_createDmsObjectNoteDefaultTransformFunction

Parameters

_: DvelopHttpResponse<any>

__: DvelopContext

___: CreateDmsObjectNoteParams

Returns void

_createDmsObjectNoteFactory

Type parameters

T

Parameters

httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>

Parameters

context: DvelopContext

config: DvelopHttpRequestConfig<any>

Returns Promise<DvelopHttpResponse<any>>

transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: CreateDmsObjectNoteParams) => T

Parameters

response: DvelopHttpResponse<any>

context: DvelopContext

params: CreateDmsObjectNoteParams

Returns T

Returns (context: DvelopContext, params: CreateDmsObjectNoteParams) => Promise<T>

Parameters

context: DvelopContext

params: CreateDmsObjectNoteParams

Returns Promise<T>

_deleteCurrentDmsObjectVersionDefaultTransformFunction

Parameters

response: DvelopHttpResponse<any>

_: DvelopContext

__: DeleteCurrentDmsObjectVersionParams

Returns boolean

_deleteCurrentDmsObjectVersionFactory

Type parameters

T

Parameters

httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>

Parameters

context: DvelopContext

config: DvelopHttpRequestConfig<any>

Returns Promise<DvelopHttpResponse<any>>

transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: DeleteCurrentDmsObjectVersionParams) => T

Parameters

response: DvelopHttpResponse<any>

context: DvelopContext

params: DeleteCurrentDmsObjectVersionParams

Returns T

Returns (context: DvelopContext, params: DeleteCurrentDmsObjectVersionParams) => Promise<T>

Parameters

context: DvelopContext

params: DeleteCurrentDmsObjectVersionParams

Returns Promise<T>

_getDmsObjectDefaultTransformFunction

Parameters

response: DvelopHttpResponse<any>

context: DvelopContext

params: GetDmsObjectParams

Returns Promise<DmsObject>

_getDmsObjectDefaultTransformFunctionFactory

Parameters

getDmsObjectMainFileFunction: (context: DvelopContext, params: GetDmsObjectParams) => Promise<ArrayBuffer>

Parameters

context: DvelopContext

params: GetDmsObjectParams