import Workgroups from 'opengate-js/src/workgroups/Workgroups.js'

public class | source

Workgroups

BaseProvision → Workgroups

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

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Public Methods
public	update(): *
public	withAdministrative(administrative: boolean): Workgroups Set the administrative attribute
public	withDescription(description: string): Workgroups Set the description attribute
public	withDomainName(domainName: string): Workgroups Set the domain attribute
public	withName(name: string): Workgroups Set the name attribute

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

Constructor

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

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

Set the administrative attribute

Name	Type	Attribute	Description
administrative	boolean

Set the description attribute

Name	Type	Attribute	Description
description	string		required field

Set the domain attribute

Name	Type	Attribute	Description
domainName	string		required field

Set the name attribute

Name	Type	Attribute	Description
name	string		required field