Interface IExecuteOptions

interface IExecuteOptions {
    containerPath?: string;
    failure?: RequestFailure<any>;
    functionName?: string;
    inputParams?: any;
    queryName?: string;
    reportId?: string;
    reportName?: string;
    reportSessionId?: string;
    schemaName?: string;
    scope?: any;
    success?: RequestSuccess<RequestExecuteResponse>;
}

Hierarchy (view full)

Properties

containerPath? failure? functionName? inputParams? queryName? reportId? reportName? reportSessionId? schemaName? scope? success?

Properties

OptionalcontainerPath

containerPath?: string

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

Optionalfailure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

OptionalfunctionName

functionName?: string

The name of the function to execute

OptionalinputParams

inputParams?: any

An object with properties for input parameters.

OptionalqueryName

queryName?: string

OptionalreportId

reportId?: string

reportId Identifier for the report to execute

OptionalreportName

reportName?: string

name of the report to execute if the id is unknown

OptionalreportSessionId

reportSessionId?: string

Execute within the existing report session.

OptionalschemaName

schemaName?: string

schema to which this report belongs (only used if reportName is used)

Optionalscope

scope?: any

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

Optionalsuccess

success?: RequestSuccess<RequestExecuteResponse>

This will be called upon successfully completing a request.

Settings

Member Visibility

On This Page

Properties