Home Manual Reference Source Test Repository
import WorkgroupRelations from 'opengate-js/src/workgroups/WorkgroupRelations.js'
public class | source

WorkgroupRelations

Extends:

BaseProvision → WorkgroupRelations

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

Constructor Summary

Public Constructor
public

Constructor

Method Summary

Public Methods
public

create(): *

public

delete(): *

public

update()

Update not allowed

public

Set the channel attribute

public

Set the workgroup attribute

Inherited Summary

From class BaseProvision
public

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

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:

NameTypeAttributeDescription
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(): * source

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

Override:

BaseProvision#delete

Return:

*

public update() source

Update not allowed

Override:

BaseProvision#update

Throw:

Error

public withChannel(channel: string): WorkgroupRelations source

Set the channel attribute

Params:

NameTypeAttributeDescription
channel string

required field for creation or update

public withWorkgroup(workgroup: string): WorkgroupRelations source

Set the workgroup attribute

Params:

NameTypeAttributeDescription
workgroup string

required field