Interface IGetContentOptions

Available options for Data.getContent

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

Properties

failure? format? scope? success

Properties

Optional failure

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

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

Type declaration

Optional format

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

Optional scope

scope?: any

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

success

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

The function to call when the function finishes successfully.

Type declaration

    • (content?, format?, response?): any

    • Parameters

      Returns any

Settings

Member Visibility

Theme

On This Page

failureformatscopesuccess

Generated using TypeDoc