Interface CreateHiddenRunGroupOptions

interface CreateHiddenRunGroupOptions {
    containerPath?: string;
    failure?: RequestFailure<any>;
    runIds?: number[];
    scope?: any;
    selectionKey?: string;
    success?: RequestSuccess<RunGroup>;
}

Hierarchy (view full)

Properties

containerPath? failure? runIds? scope? selectionKey? success?

Properties

Optional containerPath

containerPath?: string

An alternate container path to get permissions from. If not specified, the current container path will be used.

Optional failure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

Optional runIds

runIds?: number[]

An array of integer ids for the runs to be members of the group. Either runIds or selectionKey must be specified.

Optional scope

scope?: any

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

Optional selectionKey

selectionKey?: string

The DataRegion's selectionKey to be used to resolve the runs to be members of the group. Either runIds or selectionKey must be specified.

Optional success

success?: RequestSuccess<RunGroup>

This will be called upon successfully completing a request.

Settings

Member Visibility

Theme

On This Page

containerPathfailurerunIdsscopeselectionKeysuccess

Generated using TypeDoc