Interface IGetContentOptions

Available options for Data.getContent

interface IGetContentOptions {
    failure?: ((errorInfo?: any, response?: ExtendedXMLHttpRequest, options?: RequestOptions) => any);
    format?: string;
    scope?: any;
    success: ((content?: any, format?: string, response?: ExtendedXMLHttpRequest) => any);
}

Properties

failure? format? scope? success

Properties

Optionalfailure

failure?: ((errorInfo?: any, response?: ExtendedXMLHttpRequest, options?: RequestOptions) => any)

A reference to a function to call when an error occurs.

Optionalformat

format?: string

How to format the content. Defaults to plaintext, supported for text/* MIME types, including .html, .xml, .tsv, .txt, and .csv. Use 'jsonTSV' to get a JSON version of the .xls, .tsv, .or .csv files, the structure of which matches the argument to convertToExcel

Optionalscope

scope?: any

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

success

success: ((content?: any, format?: string, response?: ExtendedXMLHttpRequest) => any)

The function to call when the function finishes successfully.

Settings

Member Visibility

On This Page

Properties