Class RVWebResourceDataSource

Web resource data source, used to download files from HTTP URL using GET method. See RVRESTDataSource to use other HTTP methods or to customize parameters, headers and body to sent.

Hierarchy

Index

Accessors

  • get defaultRefreshRate(): number | null

    Returns number | null

  • set defaultRefreshRate(v: number | null): void

    Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g. 1440 = 1 day). A value of N means that whenever the visualization requests data, the engine will return data found in the cache if it's not older than N minutes -this means, if the engine fetched it from the datasource no more than N minutes before-. Set it to override the widget editor default behavior.

    Parameters

    • v: number | null

    Returns void

  • get id(): nullableString

    The ID of the data source

    Returns nullableString

  • set id(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get subtitle(): nullableString

    The subtitle of the data source, if not null will be displayed to users instead of connection information like host and database name.

    Returns nullableString

  • set subtitle(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get title(): nullableString

    The title of the data source as displayed to users.

    Returns nullableString

  • set title(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get url(): nullableString

    URL to the web resource, is expected to be a URL with HTTP or HTTPS scheme.

    Returns nullableString

  • set url(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get useAnonymousAuthentication(): boolean

    Boolean flag indicating if anonymous authentication should be used for this data source or credentials must be requested to the containing application.

    Returns boolean

  • set useAnonymousAuthentication(value: boolean): void

    Parameters

    • value: boolean

    Returns void