DSUserObjectBase {DatastreamR} | R Documentation |
DSUserObjectBase
Description
DSUserObjectBase is the base object for all five user object types. It defines the properties common to all the types
Value
DSUserObjectBase object
Public fields
Id
The object identifier. The format is specific to each object type. See the individual object file for the particular specification
Mnemonic
For all object types bar indices, this is the same as the Id property. For indices, the ID (of the form X#:Xnnnnn where n is a digit) is returned when you create an index and is used to manage the index via the API interface. The Mnemonic property is specified when creating an index and is used to reference the index when using Datastream tools such as Charting, Datastream For Office, etc. A mnemonic has format X#aaaaa where aaaaa is 1 to 6 alphanumeric characters.
DisplayName
A string describing the object. The maximum length varies from object type to object type.
Expression: Max 30 alphanumeric characters.
Index: Max 60 alphanumeric characters.
List: Max 60 alphanumeric characters.
Regression: Max 50 alphanumeric characters.
Timeseries: Max 64 alphanumeric characters.Description
Currently this isn't supported. When the API returns an object, the Description property will be the same as the DisplayName property.
Created
a datetime value representing the date when the object was first created.
LastModified
a datetime value representing the date when the object was last updated.
Owner
The parent Datastream ID that owns the object. This will be the parent of your Datastream ID. For global expressions this will always be 'Admin'
ShareType
For all objects except global expressions, this will be DSUserObjectShareTypes. PrivateUserGroup. For global expressions it will be DSUserObjectShareTypes.Global.
AccessRight
For all objects except global expressions, this will be DSUserObjectAccessRights. ReadWrite. For global expressions it will be DSUserObjectAccessRights.Read.
Methods
Public methods
Method new()
Initialize
Usage
DSUserObjectBase$new(jsonResp = NULL)
Arguments
jsonResp
: json Response
Returns
DSUserObjectBase object
Method SetSafeUpdateParams()
The following parameters are set only in response when we query for user created items. This method is called before Create or Update to ensure safe values set prior to JSON encoding
Usage
DSUserObjectBase$SetSafeUpdateParams()
Returns
No return value
Method clone()
The objects of this class are cloneable with this method.
Usage
DSUserObjectBase$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.