Interface LoadBatchesOptions

interface LoadBatchesOptions {
    assayId: number;
    assayName: string;
    batchIds: number[];
    containerPath?: string;
    failure?: RequestFailure<any>;
    protocolName?: string;
    providerName: string;
    scope?: any;
    success?: RequestSuccess<RunGroup[]>;
}

Hierarchy (view full)

Properties

assayId assayName batchIds containerPath? failure? protocolName? providerName scope? success?

Properties

assayId

assayId: number

The assay protocol id.

assayName

assayName: string

The name of the assay.

batchIds

batchIds: number[]

An Array of batch ids.

OptionalcontainerPath

containerPath?: string

Load batches from a specific container. If not specified, the batches will be loaded from the current container.

Optionalfailure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

OptionalprotocolName

protocolName?: string

Optional protocol name to be used for non-assay backed runs. Currently only SAMPLE_DERIVATION_PROTOCOL is supported.

providerName

providerName: string

The assay provider name.

Optionalscope

scope?: any

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

Optionalsuccess

success?: RequestSuccess<RunGroup[]>

This will be called upon successfully completing a request.

Settings

Member Visibility

On This Page

Properties