Class: Polling

Polling(optionsopt)

new Polling(optionsopt)

Represents polling information for a Catalog Item.

Parameters:
Name Type Attributes Description
options Object <optional>

The values of the properties of the new instance.

Properties
Name Type Attributes Description
seconds String | Number <optional>

The number of seconds to wait before polling for new data.
url String <optional>

The URL from which to poll for new data.
replace Boolean <optional>

Should the newly polled data replace the existing data (true), or be appended to it (false)?
Source:

Members

replace :Boolean

Gets or sets a flag which says whether polled data should replace the existing data, or appended to it. If defined, the data received is added to the existing TableStructure. Otherwise, it replaces the TableStructure.

Type:
  • Boolean
Default Value:
  • false
Source:

seconds :Number

Gets or sets the number of seconds to wait before polling for new data. If this.pollUrl is defined, it polls this.pollUrl and adds the data received to the existing TableStructure. If this.pollUrl is undefined, it polls this.url and replaces its TableStructure with the new one. If undefined (the default) or 0, no polling occurs.

Type:
  • Number
Default Value:
  • undefined
Source:

url :String

Gets or sets the URL from which to poll for new data. If defined, the data received is added to the existing TableStructure. Otherwise, it replaces the TableStructure.

Type:
  • String
Default Value:
  • undefined
Source: