Zum Hauptinhalt springen

ReadoutService

Implements​

Constructors​

Constructor​

new ReadoutService(): ReadoutService

Returns​

ReadoutService

Methods​

authorize()​

authorize(token): this

Authorize Client by given token provided by One Unity.

Parameters​

token​

string

Given token provided by One Unity

Returns​

this

Returns the client instance for chaining.

Implementation of​

IDataRaiService.authorize

withFilesFromFilesystem()​

withFilesFromFilesystem(files): this

Parameters​

files​

string[]

Returns​

this

withFileResultset()​

withFileResultset<TFileTypeName>(files): this

Type Parameters​

TFileTypeName​

TFileTypeName extends string | number | symbol

Parameters​

files​

FileResultset<TFileTypeName>

Returns​

this

filterByRegisterName()​

filterByRegisterName(registerName): this

Filter the files by register

Parameters​

registerName​

string

Returns​

this

filterByName()​

filterByName(pattern): this

Filter the files by name pattern

.filterByName(/\.pdf/)

Parameters​

pattern​

RegExp

Returns​

this

Memberof​

ReadoutService

withProperties()​

withProperties(properties): this

Parameters​

properties​

ReadoutProperties

Returns​

this

withAttributes()​

withAttributes(attributes): this

Parameters​

attributes​

ReadoutAttributes

Returns​

this

withFlags()​

withFlags(flags): this

Parameters​

flags​

ReadoutFlags

Returns​

this

setFieldNameForTaskId()​

setFieldNameForTaskId(fieldName): this

Parameters​

fieldName​

string

Returns​

this

execute()​

execute(options?): string

Executes the readout request and returns a task ID that represents the analysis process at Insiders.

Parameters​

options?​

TExecuteOptions

Returns​

string

a task ID that represents the analysis process at Insiders

Implementation of​

IDataRaiService.execute