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

  • RVDashboardDataSource
    • RVWebResourceDataSource

Index

Constructors

constructor

Accessors

defaultRefreshRate

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

  • 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: null | number

    Returns void

id

  • get id(): nullableString
  • set id(value: nullableString): void
  • The ID of the data source

    Returns nullableString

  • The ID of the data source

    Parameters

    • value: nullableString

    Returns void

subtitle

  • get subtitle(): nullableString
  • set subtitle(value: nullableString): void
  • 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

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

    Parameters

    • value: nullableString

    Returns void

title

  • get title(): nullableString
  • set title(value: nullableString): void
  • The title of the data source as displayed to users.

    Returns nullableString

  • The title of the data source as displayed to users.

    Parameters

    • value: nullableString

    Returns void

url

  • get url(): nullableString
  • set url(value: nullableString): void
  • URL to the web resource, is expected to be a URL with HTTP or HTTPS scheme.

    Returns nullableString

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

    Parameters

    • value: nullableString

    Returns void

useAnonymousAuthentication

  • get useAnonymousAuthentication(): boolean
  • set useAnonymousAuthentication(value: boolean): void
  • Boolean flag indicating if anonymous authentication should be used for this data source or credentials must be requested to the containing application.

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void