new CampaignCollection(campaigns, error, is_being_refreshed, refreshed)
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
campaigns |
Array.<spv.vds.Campaign>
|
|
error |
string
|
|
is_being_refreshed |
boolean
|
|
refreshed |
string
|
Members
campaigns :Array.<spv.vds.Campaign>
This array can contain campaigns if there are any validated campaigns available for the requested campaign feed.
- Source:
Type:
-
Array.<spv.vds.Campaign>
error :string
This property can contain information from internal server errors for debugging and logging.
- Source:
Type:
-
string
is_being_refreshed :boolean
The server is currently working on validating refreshed campaign data.
Updating the campaign collections can take a significant amount of time due to the need to test load campaigns to assure compatibility with the currently available content data. To avoid timing out the connection this property will be set instead to indicate to the client that a refresh is recommended within a minute or two.
The typical usage for this propery is for the GUI to display a loading indicator until refreshed campaign data can be retrieved.
- Source:
Type:
-
boolean
refreshed :string
Timestamp for last refresh, TODO: change to Date
- Source:
Type:
-
string