DSUserObjectGetAllResponse: DSUserObjectGetAllResponse

In DatastreamR: Datastream API

DSUserObjectGetAllResponse

Description

This is the object returned for the client class' GetAllItems query only.

For GetAllItems queries only, the returned objects will not have all their property fields set.
Specifically for below:
Expression: All property fields are fully populated.
Index: The ConstituentsCount property will correctly specify the number of constituents but the Constituents property will be NULL.
List: The ConstituentsCount property will correctly specify the number of constituents but the Constituents property will be NULL.
Regression: All property fields are fully populated.
Timeseries: The ValuesCount field of the DateRange property will specify the number of date value pairs, but the Dates and Values fields will be NULL.
You need to query for the individual object using the GetItem request to retrieve the full content for the object.

Value

DSUserObjectGetAllResponse object

Public fields

UserObjectType

specifies the returned object types. e.g. DSUserObjectTypes.List, DSUserObjectTypes.TimeSeries, etc.

UserObjects

An array of the specified object types such as DSListUserObject, DSRegressionUserObject, etc.

UserObjectsCount

The number of objects returned in the UserObjects property.

ResponseStatus

This property will contain a DSUserObjectResponseStatus value. DSUserObjectResponseStatus.UserObjectSuccess represents a successful response.

ErrorMessage

If ResponseStatus is not DSUserObjectResponseStatus.UserObjectSuccess this status string will provide a description of the error condition.

Properties

Not currently used and will currently always return NULL.

Methods

Public methods

• DSUserObjectGetAllResponse$new()

• DSUserObjectGetAllResponse$clone()

---

Method new()

Initialize

Usage

DSUserObjectGetAllResponse$new(jsonResp = NULL)

Arguments

jsonResp

JSON Response

Returns

DSUserObjectGetAllResponse object

---

Method clone()

The objects of this class are cloneable with this method.

Usage

DSUserObjectGetAllResponse$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DatastreamR documentation built on May 29, 2024, 12:05 p.m.