import WorkgroupRelations from 'opengate-js/src/workgroups/WorkgroupRelations.js'WorkgroupRelations
Extends:
This is a base object that contains all you can do about workgroups.
Constructor Summary
| Public Constructor | ||
| public |
constructor(Reference: InternalOpenGateAPI) Constructor |
|
Method Summary
| Public Methods | ||
| public |
create(): * |
|
| public |
delete(): * |
|
| public |
update() Update not allowed |
|
| public |
withChannel(channel: string): WorkgroupRelations Set the channel attribute |
|
| public |
withWorkgroup(workgroup: string): WorkgroupRelations 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 |
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#constructorParams:
| 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#createReturn:
| * |
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#deleteReturn:
| * |
public withChannel(channel: string): WorkgroupRelations source
Set the channel attribute
Params:
| Name | Type | Attribute | Description |
| channel | string | required field for creation or update |
public withWorkgroup(workgroup: string): WorkgroupRelations source
Set the workgroup attribute
Params:
| Name | Type | Attribute | Description |
| workgroup | string | required field |