Timeseries Function

TimeseriesFunction

TimeseriesFunction Objects

class TimeseriesFunction()

This is a base object that contains all you can do about TimeseriesFunction.

constructor
function constructor()

Constructor

Arguments:

  • Reference InternalOpenGateAPI - to the API object.
create
function create() -> '*'

Returns:

  • *
delete
function delete() -> 'Promise'

Deletes the selected RuleConfiguration

Returns:

  • Promise
update
function update() -> 'Promise'

Udpate a Rule

Returns:

  • Promise
withDescription
function withDescription(description: string) -> 'TimeseriesFunction'

Set the description attribute

Arguments:

  • description string

Returns:

  • TimeseriesFunction
withIdentifier
function withIdentifier(name: string) -> 'TimeseriesFunction'

Set the name for update attribute

Arguments:

  • name string - required field

Returns:

  • TimeseriesFunction
withMetadataFile
function withMetadataFile()

Arguments:

  • file *
withName
function withName(name: string) -> 'TimeseriesFunction'

Set the name attribute

Arguments:

  • name string - required field

Returns:

  • TimeseriesFunction
withOrganization
function withOrganization(organization: string) -> 'TimeseriesFunction'

Set the organization attribute

Arguments:

  • organization string - required field

Returns:

  • TimeseriesFunction
withReturnType
function withReturnType(returnType: String) -> 'TimeseriesFunction'

Set the returnType attribute

Arguments:

  • returnType String

Returns:

  • TimeseriesFunction
withScript
function withScript(script: string) -> 'TimeseriesFunction'

Set the script attribute

Arguments:

  • script string

Returns:

  • TimeseriesFunction
withValueTypes
function withValueTypes(valueTypes: Array) -> 'TimeseriesFunction'

Set the valueTypes attribute

Arguments:

  • valueTypes Array

Returns:

  • TimeseriesFunction