DSUserObjectResponse: DSUserObjectResponse

In DatastreamR: Datastream API

DSUserObjectResponse

Description

This is the object returned from the client class' GetItem, CreateItem, UpdateItem and DeleteItem requests.

Value

DSUserObjectResponse object

Public fields

UserObjectId

The ID of the object requested. If the item is deleted, the UserObject property will be NULL but the UserObjectId field will be populated

UserObjectType

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

UserObject

For all queries bar DeletItem, if the query is successful, this property will contain the user created item requested.

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

• DSUserObjectResponse$new()

• DSUserObjectResponse$clone()

---

Method new()

Initialize

Usage

DSUserObjectResponse$new(jsonResp = NULL)

Arguments

jsonResp

JSON Response

Returns

DSUserObjectResponse object

---

Method clone()

The objects of this class are cloneable with this method.

Usage

DSUserObjectResponse$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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