import TimeseriesFunction from 'opengate-js/src/timeseriesFunctionsCatalog/TimeseriesFunction.js'

public class | source

TimeseriesFunction

Extends:

BaseProvision → TimeseriesFunction

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

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Method Summary

Public Methods
public	create(): *
public	delete(): Promise Deletes the selected RuleConfiguration
public	update(): Promise Udpate a Rule
public	withDescription(description: string): TimeseriesFunction Set the description attribute
public	withIdentifier(name: string): TimeseriesFunction Set the name for update attribute
public	withMetadataFile(file: *)
public	withName(name: string): TimeseriesFunction Set the name attribute
public	withOrganization(organization: string): TimeseriesFunction Set the organization attribute
public	withReturnType(returnType: String): TimeseriesFunction Set the returnType attribute
public	withScript(script: string): TimeseriesFunction Set the script attribute
public	withValueTypes(valueTypes: Array): TimeseriesFunction Set the valueTypes attribute

Inherited Summary

From class BaseProvision
public	create(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision
public	delete(body: *): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

BaseProvision#constructor

Params:

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Public Methods

public create(): * source

This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision

Override:

BaseProvision#create

Return:

public delete(): Promise source

Deletes the selected RuleConfiguration

public update(): Promise source

Udpate a Rule

Override:

BaseProvision#update

Return:

Promise

Throw:

Error

public withDescription(description: string): TimeseriesFunction source

Set the description attribute

Params:

Name	Type	Attribute	Description
description	string

Return:

TimeseriesFunction

public withIdentifier(name: string): TimeseriesFunction source

Set the name for update attribute

Params:

Name	Type	Attribute	Description
name	string		required field

Return:

TimeseriesFunction

public withMetadataFile(file: *) source

Params:

Name	Type	Attribute	Description
file	*

public withName(name: string): TimeseriesFunction source

Set the name attribute

Params:

Name	Type	Attribute	Description
name	string		required field

Return:

TimeseriesFunction

public withOrganization(organization: string): TimeseriesFunction source

Set the organization attribute

Params:

Name	Type	Attribute	Description
organization	string		required field

Return:

TimeseriesFunction

public withReturnType(returnType: String): TimeseriesFunction source

Set the returnType attribute

Params:

Name	Type	Attribute	Description
returnType	String

Return:

TimeseriesFunction

public withScript(script: string): TimeseriesFunction source

Set the script attribute

Params:

Name	Type	Attribute	Description
script	string

Return:

TimeseriesFunction

public withValueTypes(valueTypes: Array): TimeseriesFunction source

Set the valueTypes attribute

Params:

Name	Type	Attribute	Description
valueTypes	Array

Return:

TimeseriesFunction