Interface IGetFileStatusOptions

Hierarchy

  • IGetFileStatusOptions

Properties

containerPath?: string

The container in which to make the request (defaults to current container)

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

files: string[]

names of the file within the subdirectory described by the path property

path: string

relative path from the folder's pipeline root

protocolName: string

name of the analysis protocol

scope?: any

A scoping object for the success and failure callback functions (default to this).

success?: ((files: any[], submitType: any, request: ExtendedXMLHttpRequest, config: RequestOptions) => any)

Type declaration

    • (files: any[], submitType: any, request: ExtendedXMLHttpRequest, config: RequestOptions): any
    • The function to call with the resulting information. This function will be passed two arguments, a list of file status objects (described below) and the name of the action that would be performed on the files if the user initiated processing ('Retry' or 'Analyze', for example).

      • name: name of the file, a String.
      • status: status of the file, a String

      Parameters

      Returns any

taskId: string

Identifier for the pipeline.

Generated using TypeDoc