Properties

Since: 25.6

Static Methods

getProperties

Return Property Owner Object

Since: 25.6

Returns: Promise<Properties>

Parameters

Name
Type
Description
propertyOwnerObject
Project or Sequence
This can also be object instance of Project, Sequence etc..

Instance Methods

createClearValueAction

Create an action to clear the value with the given name. This method can fail if e.g. the underlying properties object does not support action based setting of properties.

Since: 25.6

Returns: Action

Parameters

Name
Type
Description
name
string
-

createSetValueAction

Create an action to set a named value through scripting. This method can fail if e.g. the underlying properties object does not support action based setting of properties.

Since: 25.6

Returns: Action

Parameters

Name
Type
Description
name
string
property name
value
boolean or string or number
Value to set for the property key
persistenceFlag
Constants.PropertyType
Indicates whether the property should be persisted or not

getValue

Get named value in native string form

Since: 25.6

Returns: string

Parameters

Name
Type
Description
name
string
-

getValueAsBool

Get named value as boolean

Since: 25.6

Returns: boolean

Parameters

Name
Type
Description
name
string
-

getValueAsFloat

Get named value as float number

Since: 25.6

Returns: number

Parameters

Name
Type
Description
name
string
-

getValueAsInt

Get named value as integer number

Since: 25.6

Returns: number

Parameters

Name
Type
Description
name
string
-

hasValue

Check if a named value exists under this name.

Since: 25.6

Returns: boolean

Parameters

Name
Type
Description
name
string
-